chrome.gcm

refresh date: 2026-09-25 robots: noindex

Описание

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

Разрешения

gcm

Свойства

MAX_MESSAGE_SIZE

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

Значение

4096

Методы

register()

Promise

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

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

Параметры

• senderIds

  string[]

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

• обратный вызов

  function необязательно

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

  (registrationId: string) => void

  • registrationId

    string

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

Возвраты

• Promise<string>

  Chrome 116 и более поздних версий

  Разрешается, когда регистрация завершена.

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

send()

Promise

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

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

Параметры

• Сообщение

  Объект

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

  • делал.

    Объект

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

  • destinationId

    string

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

  • messageId

    string

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

  • timeToLive

    number (необязательно)

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

• обратный вызов

  function необязательно

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

  (messageId: string) => void

  • messageId

    string

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

Возвраты

• Promise<string>

  Chrome 116 и более поздних версий

  Выполняется после того, как сообщение успешно поставлено в очередь на отправку. Если произойдет ошибка, объект Promise будет отклонен.

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

unregister()

Promise

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

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

Параметры

• обратный вызов

  function необязательно

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

  () => void

Возвраты

• Promise<void>

  Chrome 116 и более поздних версий

  Разрешается после завершения отмены регистрации. Если объект Promise не отклонен, отмена регистрации выполнена успешно.

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

События

onMessage

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

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

Параметры

• обратный вызов

  function

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

  (message: object) => void

  • Сообщение

    Объект

    • collapseKey

      Строка (необязательно)

      Ключ сворачивания сообщения. Подробную информацию вы найдете в разделе Сворачиваемые и несворачиваемые сообщения.

    • делал.

      Объект

      Данные сообщения.

    • от

      Строка (необязательно)

      Отправитель, который отправил сообщение.

onMessagesDeleted

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

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

Параметры

• обратный вызов

  function

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

  () => void

onSendError

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

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

Параметры

• обратный вызов

  function

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

  (error: object) => void

  • ошибка

    Объект

    • подробные сведения

      Объект

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

    • errorMessage

      string

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

    • messageId

      Строка (необязательно)

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