chrome.gcm

Value

Parameters

• senderIds

  string[]

  A list of server IDs that are allowed to send messages to the application. It should contain at least one and no more than 100 sender IDs.

• callback

  function

  Function called when registration completes. It should check runtime.lastError for error when registrationId is empty.

  The parameter should be a function that looks like this:

  (registrationId: string) => {...}
  • registrationId

    string

    A registration ID assigned to the application by the GCM.

Parameters

• message

  object

  A message to send to the other party via GCM.

  • data

    object

    Message data to send to the server. Case-insensitive goog. and google, as well as case-sensitive collapse_key are disallowed as key prefixes. Sum of all key/value pairs should not exceed gcm.MAX_MESSAGE_SIZE.

  • destinationId

    string

    The ID of the server to send the message to as assigned by Google API Console.

  • messageId

    string

    The ID of the message. It must be unique for each message in scope of the applications. See the Cloud Messaging documentation for advice for picking and handling an ID.

  • timeToLive

    number optional

    Time-to-live of the message in seconds. If it is not possible to send the message within that time, an onSendError event will be raised. A time-to-live of 0 indicates that the message should be sent immediately or fail if it's not possible. The maximum and a default value of time-to-live is 86400 seconds (1 day).

• callback

  function

  A function called after the message is successfully queued for sending. runtime.lastError should be checked, to ensure a message was sent without problems.

  The parameter should be a function that looks like this:

  (messageId: string) => {...}
  • messageId

    string

    The ID of the message that the callback was issued for.

Parameters

• callback

  function

  A function called after the unregistration completes. Unregistration was successful if runtime.lastError is not set.

  The parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (message: object) => {...}
  • message

    object

    A message received from another party via GCM.

    • collapseKey

      string optional

      The collapse key of a message. See Collapsible Messages section of Cloud Messaging documentation for details.

    • data

      object

      The message data.

    • from

      string optional

      The sender who issued the message.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (error: object) => {...}
  • error

    object

    An error that occured while trying to send the message either in Chrome or on the GCM server. Application can retry sending the message with a reasonable backoff and possibly longer time-to-live.

    • details

      object

      Additional details related to the error, when available.

    • errorMessage

      string

      The error message describing the problem.

    • messageId

      string optional

      The ID of the message with this error, if error is related to a specific message.