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

4096

Métodos

register()

Promise 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

Registra o aplicativo no FCM. O ID de registro será retornado pelo 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 servidores que podem enviar mensagens ao aplicativo. Ele precisa ter entre 1 e 100 IDs de remetente.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (registrationId: string) => void

    • registrationId

      string

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

Retorna

  • Promise<string>

    Chrome 116 ou mais recente

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

send()

Promise 
chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

Envia uma mensagem de acordo com o conteúdo dela.

Parâmetros

  • mensagem

    objeto

    Uma mensagem a ser enviada para a outra parte via FCM.

    • dados

      objeto

      Dados da mensagem a serem enviados ao servidor. goog. e google que não diferenciam maiúsculas de minúsculas, bem como collapse_key que diferencia maiúsculas de minúsculas, não são permitidos como prefixos de chave. 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

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

    • timeToLive

      number optional

      Tempo de vida da mensagem em segundos. Se não for possível enviar a mensagem nesse período, um evento onSendError será gerado. Uma vida útil de 0 indica que a mensagem precisa ser enviada imediatamente ou falhar se isso não for possível. O valor padrão do tempo de vida é de 86.400 segundos (1 dia), e o valor máximo é de 2.419.200 segundos (28 dias).

  • callback

    função opcional

    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

  • Promise<string>

    Chrome 116 ou mais recente

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

unregister()

Promise 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

Cancela o registro do aplicativo no FCM.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 116 ou mais recente

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onMessage

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

Acionado 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. Consulte Mensagens recolhíveis e não recolhíveis para mais detalhes.

      • dados

        objeto

        Os dados da mensagem.

      • de

        string opcional

        O remetente que enviou a mensagem.

onMessagesDeleted

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

Acionado quando um servidor do FCM precisa excluir mensagens enviadas por um servidor de app para o aplicativo. Consulte Ciclo de vida de uma mensagem para saber 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 para o servidor do FCM.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (error: object) => void

    • erro

      objeto

      • detalhes

        objeto

        Outros detalhes relacionados ao erro, quando disponíveis.

      • errorMessage

        string

        A 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.