제공된 앱에 바인딩된 메시징 서비스입니다.
서명:
export declare class Messaging
속성
| 재산 | 수정자 | 유형 | 설명 |
|---|---|---|---|
| 앱 | 앱 | 현재 Messaging 서비스 인스턴스와 연결된 앱입니다 . |
행동 양식
| 방법 | 수정자 | 설명 |
|---|---|---|
| 보내기(메시지, dryRun) | FCM을 통해 지정된 메시지를 보냅니다. | |
| sendAll(메시지, dryRun) | Firebase 클라우드 메시징을 통해 지정된 배열의 모든 메시지를 보냅니다. 일괄 처리를 사용하여 전체 목록을 단일 RPC 호출로 보냅니다. send() 메서드와 비교할 때 이 메서드는 여러 메시지를 보내는 훨씬 더 효율적인 방법입니다. 반환 값에서 얻은 응답 목록은 MulticastMessage 의 토큰 순서에 해당합니다. 이 방법의 오류는 전체 실패를 나타냅니다. 즉, 목록에 있는 메시지 중 어느 것도 보낼 수 없음을 의미합니다. 부분적인 실패는 BatchResponse 반환 값으로 표시됩니다. | |
| sendEach(메시지, dryRun) | Firebase 클라우드 메시징을 통해 지정된 배열의 각 메시지를 보냅니다. Messaging.sendAll() 과 달리 , 이 메서드는 지정된 배열의 각 메시지에 대해 단일 RPC 호출을 수행합니다. 반환 값에서 얻은 응답 목록은 messages 순서에 해당합니다. 이 메서드의 오류 또는 모든 실패가 포함된 BatchResponse 전체 실패를 나타냅니다. 즉, 목록에 있는 메시지 중 어느 것도 전송할 수 없음을 의미합니다. 부분 실패 또는 실패 없음은 BatchResponse 반환 값으로만 표시됩니다. | |
| sendEachForMulticast(메시지, dryRun) | 지정된 멀티캐스트 메시지를 지정된 모든 FCM 등록 토큰에 보냅니다. 이 메서드는 내부적으로 Messaging.sendEach() API를 사용하여 지정된 메시지를 모든 대상 수신자에게 보냅니다. 반환 값에서 얻은 응답 목록은 MulticastMessage 의 토큰 순서에 해당합니다. 이 메서드의 오류 또는 모든 실패가 포함된 BatchResponse 전체 실패를 나타내며, 이는 목록의 메시지가 전송될 수 있음을 의미합니다. 부분 실패 또는 실패는 BatchResponse 반환 값으로만 표시됩니다. | |
| sendMulticast(메시지, dryRun) | 지정된 멀티캐스트 메시지를 지정된 모든 FCM 등록 토큰에 보냅니다. 이 메소드는 내부적으로 sendAll() API를 사용하여 지정된 메시지를 모든 대상 수신자에게 보냅니다. 반환 값에서 얻은 응답 목록은 MulticastMessage 의 토큰 순서에 해당합니다. 이 메서드의 오류는 전체 실패를 나타냅니다. 즉, 메시지가 목록에 있는 어떤 토큰에도 전송되지 않았음을 의미합니다. 부분적인 실패는 BatchResponse 반환 값으로 표시됩니다. | |
| sendToCondition(조건, 페이로드, 옵션) | 조건에 FCM 메시지를 보냅니다. 코드 샘플 및 자세한 설명서는 조건으로 보내기를 참조하세요. | |
| sendToDevice(registrationTokenOrTokens, 페이로드, 옵션) | 제공된 등록 토큰에 해당하는 단일 장치에 FCM 메시지를 보냅니다. 코드 샘플 및 자세한 문서는 개별 장치로 보내기를 참조하세요. 단일 장치에 보내기 위한 registrationToken 또는 여러 장치에 보내기 위한 토큰 배열이 포함된 registrationTokens 매개변수를 사용합니다. | |
| sendToDeviceGroup(notificationKey, 페이로드, 옵션) | 제공된 알림 키에 해당하는 장치 그룹에 FCM 메시지를 보냅니다. 코드 샘플 및 자세한 설명서는 장치 그룹으로 보내기를 참조하세요. | |
| sendToTopic(주제, 페이로드, 옵션) | 주제에 FCM 메시지를 보냅니다. 코드 샘플 및 자세한 문서는 주제로 보내기를 참조하세요. | |
| subscribeToTopic(registrationTokenOrTokens, 주제) | FCM 주제에 기기를 구독합니다. 코드 샘플 및 자세한 설명서는 주제 구독을 참조하세요. 선택적으로 여러 장치를 구독하기 위해 토큰 배열을 제공할 수 있습니다. | |
| unsubscribeFromTopic(registrationTokenOrTokens, 주제) | FCM 주제에서 기기 구독을 취소합니다. 코드 샘플 및 자세한 문서는 주제 구독 취소를 참조하세요. 선택적으로 여러 장치의 구독을 취소하기 위해 토큰 배열을 제공할 수 있습니다. |
Messaging.app
현재 Messaging 서비스 인스턴스와 연결된 앱입니다 .
서명:
get app(): App;
예
var app = messaging.app;
메시징.send()
FCM을 통해 지정된 메시지를 보냅니다.
서명:
send(message: Message, dryRun?: boolean): Promise<string>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 메시지 | 메시지 | 메시지 페이로드입니다. |
| 드라이런 | 부울 | 테스트 실행(검증 전용) 모드로 메시지를 보낼지 여부입니다. |
보고:
약속<문자열>
메시지가 전달을 위해 FCM 서비스로 성공적으로 전달된 후 고유한 메시지 ID 문자열로 이행되는 약속입니다.
메시징.sendAll()
대신 Messaging.sendEach()를 사용하세요.
Firebase 클라우드 메시징을 통해 지정된 배열의 모든 메시지를 보냅니다. 일괄 처리를 사용하여 전체 목록을 단일 RPC 호출로 보냅니다. send() 메서드와 비교할 때 이 메서드는 여러 메시지를 보내는 훨씬 더 효율적인 방법입니다.
반환 값에서 얻은 응답 목록은 MulticastMessage 의 토큰 순서에 해당합니다. . 이 방법의 오류는 전체 실패를 나타냅니다. 즉, 목록에 있는 메시지 중 어느 것도 보낼 수 없음을 의미합니다. 부분적인 실패는 BatchResponse 반환 값으로 표시됩니다.
서명:
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 메시지 | 메시지 [] | 최대 500개의 메시지를 포함하는 비어 있지 않은 배열입니다. |
| 드라이런 | 부울 | 테스트 실행(검증 전용) 모드로 메시지를 보낼지 여부입니다. |
보고:
약속< BatchResponse >
전송 작업의 결과를 나타내는 객체로 이행되는 Promise입니다.
메시징.sendEach()
Firebase 클라우드 메시징을 통해 지정된 배열의 각 메시지를 보냅니다.
Messaging.sendAll() 과 달리 , 이 메서드는 지정된 배열의 각 메시지에 대해 단일 RPC 호출을 수행합니다.
반환 값에서 얻은 응답 목록은 messages 순서에 해당합니다. . 이 메서드의 오류 또는 모든 실패가 포함된 BatchResponse 전체 실패를 나타냅니다. 즉, 목록에 있는 메시지 중 어느 것도 전송할 수 없음을 의미합니다. 부분 실패 또는 실패 없음은 BatchResponse 반환 값으로만 표시됩니다.
서명:
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 메시지 | 메시지 [] | 최대 500개의 메시지를 포함하는 비어 있지 않은 배열입니다. |
| 드라이런 | 부울 | 테스트 실행(검증 전용) 모드로 메시지를 보낼지 여부입니다. |
보고:
약속< BatchResponse >
전송 작업의 결과를 나타내는 객체로 이행되는 Promise입니다.
Messaging.sendEachForMulticast()
지정된 멀티캐스트 메시지를 지정된 모든 FCM 등록 토큰에 보냅니다.
이 메서드는 내부적으로 Messaging.sendEach() API를 사용하여 지정된 메시지를 모든 대상 수신자에게 보냅니다. 반환 값에서 얻은 응답 목록은 MulticastMessage 의 토큰 순서에 해당합니다. . 이 메서드의 오류 또는 모든 실패가 포함된 BatchResponse 전체 실패를 나타내며, 이는 목록의 메시지가 전송될 수 있음을 의미합니다. 부분 실패 또는 실패는 BatchResponse 반환 값으로만 표시됩니다.
서명:
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 메시지 | 멀티캐스트메시지 | 최대 500개의 토큰을 포함하는 멀티캐스트 메시지입니다. |
| 드라이런 | 부울 | 테스트 실행(검증 전용) 모드로 메시지를 보낼지 여부입니다. |
보고:
약속< BatchResponse >
전송 작업의 결과를 나타내는 객체로 이행되는 Promise입니다.
메시징.sendMulticast()
대신 Messaging.sendEachForMulticast()를 사용하세요.
지정된 멀티캐스트 메시지를 지정된 모든 FCM 등록 토큰에 보냅니다.
이 메소드는 내부적으로 sendAll() API를 사용하여 지정된 메시지를 모든 대상 수신자에게 보냅니다. 반환 값에서 얻은 응답 목록은 MulticastMessage 의 토큰 순서에 해당합니다. . 이 메서드의 오류는 전체 실패를 나타냅니다. 즉, 메시지가 목록에 있는 어떤 토큰에도 전송되지 않았음을 의미합니다. 부분적인 실패는 BatchResponse 반환 값으로 표시됩니다.
서명:
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 메시지 | 멀티캐스트메시지 | 최대 500개의 토큰을 포함하는 멀티캐스트 메시지입니다. |
| 드라이런 | 부울 | 테스트 실행(검증 전용) 모드로 메시지를 보낼지 여부입니다. |
보고:
약속< BatchResponse >
전송 작업의 결과를 나타내는 객체로 이행되는 Promise입니다.
Messaging.sendToCondition()
조건에 FCM 메시지를 보냅니다.
코드 샘플 및 자세한 설명서는 조건으로 보내기를 참조하세요.
서명:
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 상태 | 끈 | 메시지를 보낼 주제를 결정하는 조건입니다. |
| 유효 탑재량 | 메시징페이로드 | 메시지 페이로드입니다. |
| 옵션 | 메시징옵션 | 메시지를 변경하는 선택적 옵션입니다. |
보고:
약속< MessagingConditionResponse >
메시지가 전송된 후 서버의 응답으로 이행되는 약속입니다.
메시징.sendToDevice()
대신 Messaging.send()를 사용하세요.
제공된 등록 토큰에 해당하는 단일 장치에 FCM 메시지를 보냅니다.
코드 샘플 및 자세한 문서는 개별 장치로 보내기를 참조하세요. 단일 장치에 보내기 위한 registrationToken 또는 여러 장치에 보내기 위한 토큰 배열이 포함된 registrationTokens 매개변수를 사용합니다.
서명:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 등록토큰또는토큰 | 문자열 | 끈[] | |
| 유효 탑재량 | 메시징페이로드 | 메시지 페이로드입니다. |
| 옵션 | 메시징옵션 | 메시지를 변경하는 선택적 옵션입니다. |
보고:
약속< MessagingDevicesResponse >
메시지가 전송된 후 서버의 응답으로 이행되는 약속입니다.
메시징.sendToDeviceGroup()
대신 Messaging.send()를 사용하세요.
제공된 알림 키에 해당하는 장치 그룹에 FCM 메시지를 보냅니다.
코드 샘플 및 자세한 설명서는 장치 그룹으로 보내기를 참조하세요.
서명:
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 알림키 | 끈 | 메시지를 보낼 장치 그룹의 알림 키입니다. |
| 유효 탑재량 | 메시징페이로드 | 메시지 페이로드입니다. |
| 옵션 | 메시징옵션 | 메시지를 변경하는 선택적 옵션입니다. |
보고:
약속< MessagingDeviceGroupResponse >
메시지가 전송된 후 서버의 응답으로 이행되는 약속입니다.
메시징.sendToTopic()
주제에 FCM 메시지를 보냅니다.
코드 샘플 및 자세한 문서는 주제로 보내기를 참조하세요.
서명:
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 주제 | 끈 | 메시지를 보낼 주제입니다. |
| 유효 탑재량 | 메시징페이로드 | 메시지 페이로드입니다. |
| 옵션 | 메시징옵션 | 메시지를 변경하는 선택적 옵션입니다. |
보고:
약속< MessagingTopicResponse >
메시지가 전송된 후 서버의 응답으로 이행되는 약속입니다.
메시징.subscribeToTopic()
FCM 주제에 기기를 구독합니다.
코드 샘플 및 자세한 설명서는 주제 구독을 참조하세요. 선택적으로 여러 장치를 구독하기 위해 토큰 배열을 제공할 수 있습니다.
서명:
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 등록토큰또는토큰 | 문자열 | 끈[] | |
| 주제 | 끈 | 구독할 주제입니다. |
보고:
약속< MessagingTopicManagementResponse >
장치가 주제를 구독한 후 서버의 응답으로 이행되는 약속입니다.
메시징.unsubscribeFromTopic()
FCM 주제에서 기기 구독을 취소합니다.
코드 샘플 및 자세한 문서는 주제 구독 취소를 참조하세요. 선택적으로 여러 장치의 구독을 취소하기 위해 토큰 배열을 제공할 수 있습니다.
서명:
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 등록토큰또는토큰 | 문자열 | 끈[] | |
| 주제 | 끈 | 구독을 취소할 주제입니다. |
보고:
약속< MessagingTopicManagementResponse >
장치가 주제에서 구독을 취소한 후 서버의 응답으로 이행되는 약속입니다.