chrome.gcm

Описание

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

Разрешения

gcm

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

MAX_MESSAGE_SIZE

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

Ценить

4096

Методы

register()

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

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

Параметры

  • идентификаторы отправителя

    нить[]

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

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

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

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

    (registrationId: string) => void

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

      нить

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

Возврат

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

    Хром 116+

    Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

send()

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

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

Параметры

  • сообщение

    объект

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

    • данные

      объект

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

    • Идентификатор пункта назначения

      нить

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

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

      нить

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

    • ВремяЖить

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

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

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

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

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

    (messageId: string) => void

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

      нить

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

Возврат

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

    Хром 116+

    Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

unregister()

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

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

Параметры

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

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

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

    () => void

Возврат

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

    Хром 116+

    Промисы поддерживаются в Манифесте 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

    • ошибка

      объект

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

        объект

        Дополнительные сведения об ошибке, если они доступны.

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

        нить

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

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

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

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