chrome.gcm

Descrição

Use chrome.gcm para permitir que apps e extensões enviem e recebam mensagens pelo Firebase Cloud Messaging (FCM).

Permissões

gcm

Propriedades

MAX_MESSAGE_SIZE

O tamanho máximo (em bytes) de todos os pares de chave-valor em uma mensagem.

Valor

4.096

Métodos

register()

Promessa 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

Registra o aplicativo com o FCM. O ID de registro será retornado pela callback. Se register for chamado novamente com a mesma lista de senderIds, o mesmo ID de registro será retornado.

Parâmetros

  • senderIds

    string[]

    Uma lista de IDs de servidor que têm permissão para enviar mensagens ao aplicativo. Ele precisa conter pelo menos um e no máximo 100 IDs de remetente.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (registrationId: string)=>void

    • registrationId

      string

      Um ID de registro atribuído ao aplicativo pelo FCM.

Retorna

  • Promessa<string>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

send()

Promessa 
chrome.gcm.send(
  message: object,
  callback?: function,
)

Envia uma mensagem de acordo com seu conteúdo.

Parâmetros

  • mensagem

    objeto

    Uma mensagem para enviar à outra parte via FCM.

    • dados

      objeto

      Dados da mensagem a serem enviados ao servidor. Não é permitido usar goog. e google como prefixos de chave, assim como collapse_key que diferenciam maiúsculas de minúsculas. A soma de todos os pares de chave-valor não pode exceder gcm.MAX_MESSAGE_SIZE.

    • destinationId

      string

      O ID do servidor para enviar a mensagem, conforme atribuído pelo Console de APIs do Google.

    • messageId

      string

      ID da mensagem. Ele precisa ser exclusivo para cada mensagem no escopo dos aplicativos. Consulte a documentação do Cloud Messaging para saber como escolher e processar um ID.

    • timeToLive

      número opcional

      Time to live da mensagem em segundos. Se não for possível enviar a mensagem nesse período, um evento onSendError será gerado. Um time to live de 0 indica que a mensagem deve ser enviada imediatamente ou vai falhar se não for possível. O valor padrão de time to live é de 86.400 segundos (1 dia), e o máximo é 2.419.200 segundos (28 dias).

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (messageId: string)=>void

    • messageId

      string

      O ID da mensagem para a qual o callback foi emitido.

Retorna

  • Promessa<string>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

unregister()

Promessa 
chrome.gcm.unregister(
  callback?: function,
)

Cancela o registro do aplicativo no FCM.

Parâmetros

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 116 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

Eventos

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

Disparado quando uma mensagem é recebida pelo FCM.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (message: object)=>void

    • mensagem

      objeto

      • collapseKey

        string opcional

        A chave de recolhimento de uma mensagem. Veja mais detalhes em Mensagens não recolhíveis e recolhíveis.

      • dados

        objeto

        Os dados da mensagem.

      • de

        string opcional

        O remetente que emitiu a mensagem.

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

Disparado quando um servidor do FCM teve que excluir mensagens enviadas por um servidor de app para o aplicativo. Consulte Ciclo de vida de uma mensagem para detalhes sobre como lidar com esse evento.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    ()=>void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

Disparado quando não foi possível enviar uma mensagem ao servidor do FCM.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (error: object)=>void

    • error

      objeto

      • detalhes

        objeto

        Detalhes adicionais relacionados ao erro, quando disponíveis.

      • errorMessage

        string

        Mensagem de erro que descreve o problema.

      • messageId

        string opcional

        O ID da mensagem com esse erro, se o erro estiver relacionado a uma mensagem específica.