Firebase 클라우드 메시징 (FCM)
함수
| 함수 | 설명 |
|---|---|
| getMessaging(앱) | 기본 앱 또는 지정된 앱의 메시지 서비스를 가져옵니다.admin.messaging()를 인수 없이 호출하여 기본 앱의 Messaging 서비스에 액세스하거나 admin.messaging(app)로 호출하여 특정 앱과 연결된 Messaging 서비스에 액세스할 수 있습니다. |
클래스
| 클래스 | 설명 |
|---|---|
| FirebaseMessagingError | Firebase 메시징 오류 코드 구조 PrefixedFirebaseError를 확장합니다. |
| 메시지 | 제공된 앱에 바인딩된 메시지 서비스입니다. |
| MessagingClientErrorCode | 메시지 클라이언트 오류 코드 및 기본 메시지입니다. |
인터페이스
| 인터페이스 | 설명 |
|---|---|
| Android 구성 | Message에 포함할 수 있는 Android 관련 옵션을 나타냅니다. |
| AndroidFcmOptions | Android용 FCM SDK에서 제공하는 기능의 옵션을 나타냅니다. |
| Android 알림 | AndroidConfig에 포함할 수 있는 Android 관련 알림 옵션을 나타냅니다. |
| ApnsConfig | Message에 포함할 수 있는 APN 관련 옵션을 나타냅니다. APN에서 지원하는 다양한 헤더 및 페이로드 필드는 Apple 문서를 참고하세요. |
| ApnsFcmOptions | iOS용 FCM SDK에서 제공하는 기능의 옵션을 나타냅니다. |
| ApnsPayload | APN 메시지의 페이로드를 나타냅니다. 주로 aps 사전으로 구성됩니다. 하지만 다른 임의의 커스텀 키를 포함할 수도 있습니다. |
| 앱 | APN 메시지의 일부인 aps 사전을 나타냅니다. |
| ApsAlert | |
| BaseMessage | |
| BatchResponse | Messaging.sendAll() 및 Messaging.sendMulticast() 메서드의 서버 응답을 나타내는 인터페이스입니다. |
| ConditionMessage | |
| 크리티컬 사운드 | APN 페이로드의 aps 사전에 포함될 수 있는 중요한 사운드 구성을 나타냅니다. |
| DataMessagePayload | FCM 기존 API 데이터 메시지 페이로드를 나타내는 인터페이스입니다. 데이터 메시지를 사용하면 개발자가 최대 4KB의 맞춤 키-값 쌍을 보낼 수 있습니다. 키와 값은 모두 문자열이어야 합니다. 키는 다음과 같이 예약된 문자열을 제외한 모든 맞춤 문자열이 될 수 있습니다.
|
| FcmOptions | FCM SDK에서 제공하는 기능의 플랫폼 독립적 옵션을 나타냅니다. |
| LightSettings | AndroidNotification에 포함할 수 있는 알림 LED를 제어하는 설정을 나타냅니다. |
| MessagingConditionResponse | 기존 Messaging.sendToCondition() 메서드의 서버 응답을 나타내는 인터페이스입니다.코드 샘플 및 자세한 내용은 조건으로 보내기를 참고하세요. |
| MessagingDeviceGroupResponse | Messaging.sendToDeviceGroup() 메서드의 서버 응답을 나타내는 인터페이스입니다.코드 샘플 및 자세한 문서는 기기 그룹에 메시지 보내기를 참고하세요. |
| MessagingDeviceResult | 단일 기기의 개별 상태 응답 페이로드 |
| MessagingDevicesResponse를 사용해야 합니다. | FCM 기존 API를 통해 개별 기기로 전송된 메시지의 상태를 나타내는 인터페이스입니다.코드 샘플 및 자세한 문서는 개별 기기로 전송을 참고하세요. |
| MessagingOptions | FCM 기존 API를 통해 메시지를 보낼 때 제공될 수 있는 옵션을 나타내는 인터페이스입니다.코드 샘플 및 자세한 문서는 전송 요청 빌드를 참고하세요. |
| 메시지 페이로드 | Firebase 클라우드 메시징 메시지 페이로드를 나타내는 인터페이스입니다. data 및 notification 키 중 하나 또는 모두가 필요합니다.코드 샘플 및 자세한 내용은 전송 요청 작성을 참고하세요. |
| MessagingTopicManagementResponse | Messaging.subscribeToTopic() 및 Messaging.unsubscribeFromTopic() 메서드의 서버 응답을 나타내는 인터페이스입니다.코드 샘플 및 자세한 문서는 서버에서 주제 관리를 참고하세요. |
| MessagingTopicResponse | 기존 Messaging.sendToTopic() 메서드의 서버 응답을 나타내는 인터페이스입니다.코드 샘플 및 자세한 문서는 주제로 보내기를 참고하세요. |
| MulticastMessage | Messaging.sendMulticast() 메서드의 페이로드입니다. 페이로드에는 BaseMessage 유형의 모든 필드와 토큰 목록이 포함되어 있습니다. |
| 알림 | Message에 포함할 수 있는 알림입니다. |
| NotificationMessagePayload | FCM 기존 API 알림 메시지 페이로드를 나타내는 인터페이스입니다. 개발자는 알림 메시지를 통해 최대 4KB의 사전 정의된 키-값 쌍을 보낼 수 있습니다. 허용되는 키는 아래에 설명되어 있습니다.코드 샘플 및 자세한 문서는 전송 요청 작성을 참고하세요. |
| 응답 | 일괄 요청의 일부로 전송된 개별 메시지의 상태를 나타내는 인터페이스입니다. |
| TokenMessage | |
| TopicMessage | |
| 웹 푸시 구성 | Message에 포함할 수 있는 웹 푸시 프로토콜 옵션을 나타냅니다. |
| WebpushFcmOptions | 웹용 FCM SDK에서 제공하는 기능 옵션을 나타냅니다 (웹 푸시 표준의 일부가 아님). |
| WebpushNotification | WebpushConfig에 포함할 수 있는 웹 푸시 관련 알림 옵션을 나타냅니다. 이는 웹 알림 사양에 정의된 대로 대부분의 표준 옵션을 지원합니다. |
유형 별칭
| 별칭 입력 | 설명 |
|---|---|
| 메시지 | 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;