chrome.gcm

설명

chrome.gcm를 사용하여 앱과 확장 프로그램이 Firebase 클라우드 메시징 (FCM)을 통해 메시지를 보내고 받을 수 있도록 합니다.

권한

gcm

속성

MAX_MESSAGE_SIZE

메시지에 있는 모든 키-값 쌍의 최대 크기 (바이트)입니다.

값

4096

메서드

register()

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

FCM에 애플리케이션을 등록합니다. 등록 ID는 callback에 의해 반환됩니다. 동일한 senderIds 목록으로 register를 다시 호출하면 동일한 등록 ID가 반환됩니다.

매개변수

  • senderIds

    문자열[]

    애플리케이션에 메시지를 보낼 수 있는 서버 ID 목록입니다. 발신자 ID를 1개 이상 100개 이하로 포함해야 합니다.

반환 값

  • Promise<string>

    Chrome 116 이상

send()

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

내용에 따라 메시지를 전송합니다.

매개변수

  • 메시지

    객체

    FCM을 통해 상대방에게 전송할 메시지입니다.

    • 데이터

      객체

      서버로 전송할 메시지 데이터입니다. 대소문자를 구분하지 않는 goog. 및 google와 대소문자를 구분하는 collapse_key는 키 접두사로 허용되지 않습니다. 모든 키/값 쌍의 합계는 gcm.MAX_MESSAGE_SIZE을 초과해서는 안 됩니다.

    • destinationId

      문자열

      Google API 콘솔에서 할당한 메시지를 전송할 서버의 ID입니다.

    • messageId

      문자열

      메시지의 ID입니다. 애플리케이션 범위 내의 각 메시지에 대해 고유해야 합니다. ID 선택 및 처리에 관한 조언은 Cloud Messaging 문서를 참고하세요.

    • timeToLive

      번호 선택사항

      메시지의 수명(초)입니다. 해당 시간 내에 메시지를 전송할 수 없는 경우 onSendError 이벤트가 발생합니다. TTL이 0이면 메시지를 즉시 전송해야 하며, 불가능한 경우 전송에 실패해야 함을 나타냅니다. TTL의 기본값은 86,400초 (1일)이고 최댓값은 2,419,200초 (28일)입니다.

반환 값

  • Promise<string>

    Chrome 116 이상

unregister()

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

FCM에서 애플리케이션을 등록 취소합니다.

반환 값

  • Promise<void>

    Chrome 116 이상

이벤트

onMessage

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

FCM을 통해 메시지가 수신될 때 발생합니다.

매개변수

  • callback

    함수

    callback 매개변수는 다음과 같습니다. 

    (message: object) => void

    • 메시지

      객체

      • collapseKey

        문자열 선택사항

        메일의 축소 키입니다. 자세한 내용은 비축소형 메시지 및 축소형 메시지를 참고하세요.

      • 데이터

        객체

        메시지 데이터입니다.

      • 소스:

        문자열 선택사항

        메일을 보낸 발신자입니다.

onMessagesDeleted

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

FCM 서버가 앱 서버에서 애플리케이션으로 보낸 메시지를 삭제해야 할 때 발생합니다. 이 이벤트 처리에 관한 자세한 내용은 메시지의 수명을 참고하세요.

매개변수

  • callback

    함수

    callback 매개변수는 다음과 같습니다. 

    () => void

onSendError

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

FCM 서버에 메시지를 보낼 수 없을 때 발생합니다.

매개변수

  • callback

    함수

    callback 매개변수는 다음과 같습니다. 

    (error: object) => void

    • 오류

      객체

      • 세부정보

        객체

        사용 가능한 경우 오류와 관련된 추가 세부정보입니다.

      • errorMessage

        문자열

        문제를 설명하는 오류 메시지입니다.

      • messageId

        문자열 선택사항

        오류가 특정 메시지와 관련된 경우 이 오류가 있는 메시지의 ID입니다.