browser.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()

browser.gcm.register(
  senderIds: string[],
): Promise<string>

Registra o aplicativo no FCM. O ID do 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 servidor que podem enviar mensagens ao aplicativo. Ele precisa conter entre 1 e 100 IDs de remetente.

Retorna

• Promise<string>

  Chrome 116+ browser.* desde o Chrome 148

  É resolvida quando o registro é concluído.

send()

browser.gcm.send(
  message: object,
): 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 usando o FCM.

  • dados

    objeto

    Dados da mensagem a serem enviados ao servidor. goog. e google que não diferenciam maiúsculas de minúsculas, assim 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 o qual a mensagem será enviada, 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 conselhos sobre como escolher e processar um ID.

  • timeToLive

    número 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. Um valor 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).

Retorna

• Promise<string>

  Chrome 116+ browser.* desde o Chrome 148

  É resolvido depois que a mensagem é colocada na fila para envio. Se ocorrer um erro, a promessa será rejeitada.

unregister()

browser.gcm.unregister(): Promise<void>

Cancela o registro do aplicativo no FCM.

Retorna

• Promessa<void>

  Chrome 116+ browser.* desde o Chrome 148

  É resolvido após a conclusão do cancelamento do registro. O cancelamento do registro será bem-sucedido se a promessa não for rejeitada.

Eventos

onMessage

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

Acionado quando uma mensagem é recebida pelo FCM.

Parâmetros

• callback

  função

  O parâmetro callback é semelhante a:

  (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

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

Acionado quando um servidor do FCM precisa excluir mensagens enviadas por um servidor de apps ao aplicativo. Consulte Ciclo de vida de uma mensagem para saber como lidar com esse evento.

Parâmetros

• callback

  função

  O parâmetro callback é semelhante a:

  () => void

onSendError

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

Acionado quando não é possível enviar uma mensagem ao servidor do FCM.

Parâmetros

• callback

  função

  O parâmetro callback é semelhante a:

  (error: object) => void

  • erro

    objeto

    • detalhes

      objeto

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