chrome.gcm

설명

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

권한

gcm

속성

MAX_MESSAGE_SIZE

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

값

4096

방법

register()

프로미스 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

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

매개변수

  • senderIds

    문자열[]

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

  • 콜백

    함수 선택사항

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

    (registrationId: string)=>void

    • registrationId

      string

      FCM에서 애플리케이션에 할당한 등록 ID입니다.

반환 값

  • 프로미스<string>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

send()

프로미스 
chrome.gcm.send(
  message: object,
  callback?: function,
)

내용에 따라 메시지를 보냅니다.

매개변수

  • 메시지

    객체

    FCM을 통해 상대방에게 보낼 메시지입니다.

    • 데이터

      객체

      서버로 전송할 메시지 데이터입니다. 대소문자를 구분하지 않는 goog., google, 대소문자를 구분하는 collapse_key는 키 접두사로 사용할 수 없습니다. 모든 키-값 쌍의 합이 gcm.MAX_MESSAGE_SIZE 이하여야 합니다.

    • destinationId

      string

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

    • messageId

      string

      메시지의 ID입니다. 애플리케이션 범위에서 각 메시지마다 고유해야 합니다. ID를 선택하고 처리하는 방법은 클라우드 메시징 문서를 참조하세요.

    • timeToLive

      number 선택사항

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

  • 콜백

    함수 선택사항

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

    (messageId: string)=>void

    • messageId

      string

      콜백이 실행된 메시지의 ID입니다.

반환 값

  • 프로미스<string>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

unregister()

프로미스 
chrome.gcm.unregister(
  callback?: function,
)

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

매개변수

  • 콜백

    함수 선택사항

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

    ()=>void

반환 값

  • Promise<void>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

이벤트

onMessage

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

FCM을 통해 메시지가 수신되면 시작됩니다.

매개변수

  • 콜백

    기능

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

    (message: object)=>void

    • 메시지

      객체

      • collapseKey

        문자열 선택사항

        메시지의 축소 키입니다. 자세한 내용은 축소 불가능 메시지 및 축소 가능 메시지를 참고하세요.

      • 데이터

        객체

        메시지 데이터입니다.

      • from

        문자열 선택사항

        메시지를 발행한 발신자

onMessagesDeleted

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

FCM 서버가 앱 서버에서 애플리케이션으로 보낸 메시지를 삭제해야 할 때 실행됩니다. 이 이벤트를 처리하는 방법에 대한 자세한 내용은 메시지의 전체 기간을 참조하세요.

매개변수

  • 콜백

    기능

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

    ()=>void

onSendError

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

FCM 서버에 메시지를 보낼 수 없을 때 실행됩니다.

매개변수

  • 콜백

    기능

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

    (error: object)=>void

    • error

      객체

      • 세부정보

        객체

        오류와 관련된 추가 세부정보입니다(있는 경우).

      • errorMessage

        string

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

      • messageId

        문자열 선택사항

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