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

    • registrationId

      нить

      Регистрационный идентификатор, присвоенный заявке FCM.

Возврат

  • Обещание<строка>

    Хром 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 Console .

    • идентификатор сообщения

      нить

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

    • времяЖизни

      номер необязательно

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

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

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

    Параметр callback выглядит так: 

    (messageId: string) => void

    • идентификатор сообщения

      нить

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

Возврат

  • Обещание<строка>

    Хром 116+

    Обещания поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

unregister()

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

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

Параметры

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

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

    Параметр callback выглядит так: 

    () => void

Возврат

  • Обещание<void>

    Хром 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

    • ошибка

      объект

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

        объект

        Дополнительные сведения об ошибке (если таковые имеются).

      • errorMessage

        нить

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

      • идентификатор сообщения

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

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