chrome.gcm

Описание

Используйте chrome.gcm , чтобы разрешить приложениям и расширениям отправлять и получать сообщения через Firebase Cloud Messaging (FCM).

Разрешения

gcm

Характеристики

MAX_MESSAGE_SIZE

Максимальный размер (в байтах) всех пар ключ/значение в сообщении.

Ценить

4096

Методы

register()

Обещать
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

Регистрирует приложение в FCM. Идентификатор регистрации будет возвращен функцией callback . Если register будет вызвана снова с тем же списком senderIds , будет возвращен тот же идентификатор регистрации.

Параметры

  • senderIds

    нить[]

    Список идентификаторов серверов, которым разрешено отправлять сообщения в приложение. Он должен содержать не менее одного и не более 100 идентификаторов отправителей.

  • перезвонить

    функция необязательна

    Параметр callback выглядит следующим образом: 

    (registrationId: string) => void

    • регистрационный идентификатор

      нить

      Идентификатор регистрации, присвоенный приложению организацией FCM.

Возвраты

  • Promise<string>

    Chrome 116+

    Проблема решается после завершения регистрации.

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

send()

Обещать
chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

Отправляет сообщение в соответствии с его содержимым.

Параметры

  • сообщение

    объект

    Сообщение для отправки другой стороне через FCM.

    • данные

      объект

      Данные сообщения для отправки на сервер. Регистронезависимые префиксы ключей goog. и google , а также регистронезависимые collapse_key запрещены. Сумма всех пар ключ/значение не должна превышать gcm.MAX_MESSAGE_SIZE .

    • destinationId

      нить

      Идентификатор сервера, на который следует отправить сообщение, присваиваемый консолью Google API .

    • messageId

      нить

      Идентификатор сообщения. Он должен быть уникальным для каждого сообщения в рамках приложения. Рекомендации по выбору и обработке идентификатора см. в документации по облачным сообщениям.

    • времяЖить

      число необязательно

      Время жизни сообщения в секундах. Если отправить сообщение в течение этого времени невозможно, будет сгенерировано событие onSendError. Значение времени жизни, равное 0, указывает на то, что сообщение должно быть отправлено немедленно, или на то, что отправка невозможна, если это невозможно. Значение по умолчанию для времени жизни составляет 86 400 секунд (1 день), а максимальное значение — 2 419 200 секунд (28 дней).

  • перезвонить

    функция необязательна

    Параметр callback выглядит следующим образом: 

    (messageId: string) => void

    • messageId

      нить

      Идентификатор сообщения, для которого был вызван обратный вызов.

Возвраты

  • Promise<string>

    Chrome 116+

    Решается после успешного добавления сообщения в очередь на отправку. В случае ошибки промис будет отклонен.

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

unregister()

Обещать
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

Отменяет регистрацию приложения в FCM.

Параметры

  • перезвонить

    функция необязательна

    Параметр callback выглядит следующим образом: 

    () => void

Возвраты

  • Обещание<пустота>

    Chrome 116+

    Завершается после окончания процесса отмены регистрации. Отмена регистрации считается успешной, если обещание не отклоняется.

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

События

onMessage

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

Срабатывает при получении сообщения через FCM.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит следующим образом: 

    (message: object) => void

onMessagesDeleted

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

Событие срабатывает, когда серверу FCM необходимо удалить сообщения, отправленные сервером приложений приложению. Подробную информацию об обработке этого события см. в разделе «Время жизни сообщения» .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит следующим образом: 

    () => void

onSendError

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

Срабатывает, когда не удаётся отправить сообщение на сервер FCM.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит следующим образом: 

    (error: object) => void

    • ошибка

      объект

      • подробности

        объект

        Дополнительная информация об ошибке будет предоставлена ​​по мере её поступления.

      • сообщение об ошибке

        нить

        Сообщение об ошибке, описывающее проблему.

      • messageId

        строка необязательный

        Идентификатор сообщения с этой ошибкой, если ошибка связана с конкретным сообщением.