FCM(Firebase 클라우드 메시징).
기능
기능 | 설명 |
---|---|
getMessaging(앱) | 기본 앱 또는 특정 앱에 대한 메시징 서비스를 가져옵니다. admin.messaging() 인수 없이 호출하여 기본 앱의 Messaging 서비스에 액세스하거나 admin.messaging(app) 으로 호출하여 특정 앱과 연결된 Messaging 서비스에 액세스할 수 있습니다. |
클래스
수업 | 설명 |
---|---|
메시징 | 제공된 앱에 바인딩된 메시징 서비스입니다. |
인터페이스
상호 작용 | 설명 |
---|---|
Android구성 | 메시지 에 포함될 수 있는 Android 관련 옵션을 나타냅니다. . |
AndroidFcm옵션 | Android용 FCM SDK에서 제공하는 기능에 대한 옵션을 나타냅니다. |
Android알림 | AndroidConfig 에 포함될 수 있는 Android 관련 알림 옵션을 나타냅니다. . |
Apns구성 | 메시지 에 포함될 수 있는 APN 관련 옵션을 나타냅니다. . APN에서 지원하는 다양한 헤더 및 페이로드 필드에 대해서는 Apple 설명서를 참조하세요. |
ApnsFcm옵션 | iOS용 FCM SDK에서 제공하는 기능에 대한 옵션을 나타냅니다. |
Apns페이로드 | APN 메시지의 페이로드를 나타냅니다. 주로 aps 사전으로 구성되어 있습니다. 그러나 다른 임의의 사용자 정의 키가 포함될 수도 있습니다. |
Aps | APN 메시지의 일부인 aps 사전을 나타냅니다. |
ApsAlert | |
기본 메시지 | |
일괄 응답 | Messaging.sendAll() 및 Messaging.sendMulticast() 메서드의 서버 응답을 나타내는 인터페이스입니다. |
조건메시지 | |
중요사운드 | APN 페이로드의 aps 사전에 포함될 수 있는 중요한 사운드 구성을 나타냅니다. |
데이터메시지페이로드 | FCM 레거시 API 데이터 메시지 페이로드를 나타내는 인터페이스입니다. 데이터 메시지를 통해 개발자는 최대 4KB의 사용자 지정 키-값 쌍을 보낼 수 있습니다. 키와 값은 모두 문자열이어야 합니다. 키는 다음 예약 문자열을 제외한 모든 사용자 지정 문자열일 수 있습니다.
|
Fcm옵션 | FCM SDK에서 제공하는 기능에 대한 플랫폼 독립적 옵션을 나타냅니다. |
조명 설정 | AndroidNotification 에 포함될 수 있는 알림 LED를 제어하기 위한 설정을 나타냅니다. . |
메시징조건응답 | 레거시 Messaging.sendToCondition() 메서드의 서버 응답을 나타내는 인터페이스입니다. 코드 샘플 및 자세한 설명서는 조건으로 보내기를 참조하세요. |
메시징장치그룹응답 | Messaging.sendToDeviceGroup() 메서드의 서버 응답을 나타내는 인터페이스입니다. 코드 샘플 및 자세한 설명서는 장치 그룹에 메시지 보내기를 참조하세요. |
메시징장치결과 | 단일 장치의 개별 상태 응답 페이로드 |
메시징장치응답 | FCM 레거시 API를 통해 개별 장치로 전송된 메시지의 상태를 나타내는 인터페이스입니다. 코드 샘플 및 자세한 문서는 개별 장치로 보내기를 참조하세요. |
메시징옵션 | FCM 레거시 API를 통해 메시지를 보낼 때 제공할 수 있는 옵션을 나타내는 인터페이스입니다. 코드 샘플 및 자세한 문서는 보내기 요청 빌드를 참조하세요. |
메시징페이로드 | Firebase 클라우드 메시징 메시지 페이로드를 나타내는 인터페이스입니다. data 키와 notification 키 중 하나 또는 둘 다 필요합니다. 코드 샘플 및 자세한 문서는 보내기 요청 빌드를 참조하세요. |
메시징주제관리응답 | Messaging.subscribeToTopic() 및 Messaging.unsubscribeFromTopic() 메서드의 서버 응답을 나타내는 인터페이스입니다. 코드 샘플과 자세한 문서는 서버에서 주제 관리를 참조하세요. |
메시징주제응답 | 레거시 Messaging.sendToTopic() 메서드의 서버 응답을 나타내는 인터페이스입니다. 코드 샘플 및 자세한 문서는 주제로 보내기를 참조하세요. |
멀티캐스트메시지 | Messaging.sendMulticast() 메서드에 대한 페이로드입니다. 페이로드에는 BaseMessage 유형의 모든 필드와 토큰 목록이 포함되어 있습니다. |
공고 | 메시지 에 포함될 수 있는 알림 . |
알림메시지페이로드 | FCM 레거시 API 알림 메시지 페이로드를 나타내는 인터페이스입니다. 알림 메시지를 통해 개발자는 사전 정의된 키-값 쌍을 최대 4KB까지 보낼 수 있습니다. 허용되는 키는 아래에 설명되어 있습니다. 코드 샘플 및 자세한 문서는 보내기 요청 빌드를 참조하세요. |
SendResponse | 일괄 요청의 일부로 전송된 개별 메시지의 상태를 나타내는 인터페이스입니다. |
토큰메시지 | |
주제메시지 | |
웹 푸시 구성 | 메시지 에 포함될 수 있는 WebPush 프로토콜 옵션을 나타냅니다. . |
WebpushFcm옵션 | 웹용 FCM SDK(Webpush 표준의 일부가 아님)에서 제공하는 기능에 대한 옵션을 나타냅니다. |
웹푸시 알림 | WebpushConfig 에 포함될 수 있는 WebPush 관련 알림 옵션을 나타냅니다. . 이는 웹 알림 사양 에 정의된 대부분의 표준 옵션을 지원합니다. . |
유형 별칭
유형 별칭 | 설명 |
---|---|
메시지 | Messaging.send() 작업을 위한 페이로드입니다. 페이로드에는 BaseMessage 유형의 모든 필드와 정확히 하나의 토큰, 주제 또는 조건이 포함됩니다. |
getMessaging()
기본 앱 또는 특정 앱에 대한 메시징 서비스를 가져옵니다.
admin.messaging()
인수 없이 호출하여 기본 앱의 Messaging
서비스에 액세스하거나 admin.messaging(app)
으로 호출하여 특정 앱과 연결된 Messaging
서비스에 액세스할 수 있습니다.
서명:
export declare function getMessaging(app?: App): Messaging;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
앱 | 앱 | Messaging 서비스를 반환할 선택적 앱입니다. 제공되지 않으면 기본 Messaging 서비스가 반환됩니다. |
보고:
앱이 제공되지 않은 경우 기본 Messaging
서비스이거나 제공된 앱과 연결된 Messaging
서비스입니다.
실시예 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
실시예 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
메시지
Messaging.send() 작업을 위한 페이로드입니다. 페이로드에는 BaseMessage 유형의 모든 필드와 정확히 하나의 토큰, 주제 또는 조건이 포함됩니다.
서명:
export type Message = TokenMessage | TopicMessage | ConditionMessage;