Skip to content

messaging_instance.md

Latest commit

 

History

History
251 lines (145 loc) · 6.92 KB

messaging_instance.md

File metadata and controls

251 lines (145 loc) · 6.92 KB

MessagingInstance

Description

Google Cloud Messaging App Instance class

class MessagingInstance

Functions

  1. 🔹 void resetApp()

Unbind or remove FirebaseApp.

void resetApp()

  1. 🔹 void loop()

Perform the async task repeatedly (DEPRECATED).

void loop()

  1. 🔹 String batchAdd(AsyncClientClass &aClient, const String &topic, const object_t &IID)

Create relationship maps for app instances (subscribe the apps to the topic).

String batchAdd(AsyncClientClass &aClient, const String &topic, const object_t &IID)

Params:

  • aClient - The async client.
  • topic - The topic to subscribe.
  • IID - The object_t object represents the instance ID tokens or registration tokens array.

Returns:

  • String - The response payload.

  1. 🔹 void batchAdd(AsyncClientClass &aClient, const String &topic, const object_t &IID, AsyncResult &aResult)

Create relationship maps for app instances (subscribe the apps to the topic).

void batchAdd(AsyncClientClass &aClient, const String &topic, const object_t &IID, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • topic - The topic to subscribe.
  • IID - The object_t object represents the instance ID tokens or registration tokens array.
  • aResult - The async result (AsyncResult).

  1. 🔹 void batchAdd(AsyncClientClass &aClient, const String &topic, const object_t &IID, AsyncResultCallback cb, const String &uid = "")

Create relationship maps for app instances (subscribe the apps to the topic).

void batchAdd(AsyncClientClass &aClient, const String &topic, const object_t &IID, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • topic - The topic to subscribe.
  • IID - The object_t object represents the instance ID tokens or registration tokens array.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).

  1. 🔹 String batchRemove(AsyncClientClass &aClient, const String &topic, const object_t &IID)

Remove relationship maps for app instances (unsubscribe the apps to the topic).

String batchRemove(AsyncClientClass &aClient, const String &topic, const object_t &IID)

Params:

  • aClient - The async client.
  • topic - The topic to unsubscribe.
  • IID - The object_t object represents the instance ID tokens or registration tokens array.

Returns:

  • String - The response payload.

  1. 🔹 void batchRemove(AsyncClientClass &aClient, const String &topic, const object_t &IID, AsyncResult &aResult)

Remove relationship maps for app instances (unsubscribe the apps to the topic).

void batchRemove(AsyncClientClass &aClient, const String &topic, const object_t &IID, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • topic - The topic to unsubscribe.
  • IID - The object_t object represents the instance ID tokens or registration tokens array.
  • aResult - The async result (AsyncResult).

  1. 🔹 void batchRemove(AsyncClientClass &aClient, const String &topic, const object_t &IID, AsyncResultCallback cb, const String &uid = "")

Remove relationship maps for app instances (unsubscribe the apps to the topic).

void batchRemove(AsyncClientClass &aClient, const String &topic, const object_t &IID, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • topic - The topic to unsubscribe.
  • IID - The object_t object represents the instance ID tokens or registration tokens array.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).

  1. 🔹 String batchImport(AsyncClientClass &aClient, const String &application, bool sandbox, const object_t &APNs)

Create registration tokens for APNs tokens.

String batchImport(AsyncClientClass &aClient, const String &application, bool sandbox, const object_t &APNs)

Params:

  • aClient - The async client.
  • application - The Bundle id of the app.
  • sandbox - The Boolean to indicate sandbox environment (TRUE) or production (FALSE).
  • APNs - The object_t object represents the iOS APNs tokens array.

Returns:

  • String - The response payload.

  1. 🔹 void batchImport(AsyncClientClass &aClient, const String &application, bool sandbox, const object_t &APNs, AsyncResult &aResult)

Create registration tokens for APNs tokens.

void batchImport(AsyncClientClass &aClient, const String &application, bool sandbox, const object_t &APNs, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • application - The Bundle id of the app.
  • sandbox - The Boolean to indicate sandbox environment (TRUE) or production (FALSE).
  • APNs - The object_t object represents the iOS APNs tokens array.
  • aResult - The async result (AsyncResult).

  1. 🔹 void batchImport(AsyncClientClass &aClient, const String &application, bool sandbox, const object_t &APNs, AsyncResultCallback cb, const String &uid = "")

Create registration tokens for APNs tokens.

void batchImport(AsyncClientClass &aClient, const String &application, bool sandbox, const object_t &APNs, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • application - The Bundle id of the app.
  • sandbox - The Boolean to indicate sandbox environment (TRUE) or production (FALSE).
  • APNs - The object_t object represents the iOS APNs tokens array.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).

  1. 🔹 String get(AsyncClientClass &aClient, const String &IID)

Get information about app instances.

String get(AsyncClientClass &aClient, const String &IID)

Params:

  • aClient - The async client.
  • IID - The instance ID token.

Returns:

  • String - The response payload.

  1. 🔹 void get(AsyncClientClass &aClient, const String &IID, AsyncResult &aResult)

Get information about app instances.

void get(AsyncClientClass &aClient, const String &IID, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • IID - The instance ID token.
  • aResult - The async result (AsyncResult).

  1. 🔹 void get(AsyncClientClass &aClient, const String &IID, AsyncResultCallback cb, const String &uid = "")

Get information about app instances.

void get(AsyncClientClass &aClient, const String &IID, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • IID - The instance ID token.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).