Messaging class

제공된 앱에 바인딩된 메시지 서비스입니다.

서명:

export declare class Messaging 

속성

메소드

메시지 앱

현재 Messaging 서비스 인스턴스와 연결된 App입니다.

서명:

get app(): App;

예

var app = messaging.app;

Messaging.enableLegacyHttpTransport()

</ph>

이는 HTTP/2 전송 구현이 기존 HTTP/1.1 구현과 동일한 안정성에 도달하면 삭제됩니다.

sendEach() 및 sendEachForMulticast()에 기존 HTTP/1.1 전송을 사용 설정합니다.

서명:

enableLegacyHttpTransport(): void;

반환:

void

예

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Messaging.send()

FCM을 통해 지정된 메시지를 전송합니다.

서명:

send(message: Message, dryRun?: boolean): Promise<string>;

매개변수

반환:

프로미스<string>

메시지가 전송을 위해 FCM 서비스에 성공적으로 전달된 후 고유한 메시지 ID 문자열로 프라미스가 처리됩니다.

Messaging.sendAll()

</ph>

대신 Messaging.sendeach()를 사용하세요.

Firebase 클라우드 메시징을 통해 지정된 배열의 모든 메시지를 보냅니다. 일괄 처리를 사용하여 전체 목록을 단일 RPC 호출로 전송합니다. send() 메서드에 비해 이 메서드는 훨씬 더 효율적인 방법으로 여러 메시지를 전송할 수 있습니다.

반환 값에서 가져온 응답 목록은 MulticastMessage의 토큰 순서와 일치합니다. 이 메서드의 오류는 전체 실패를 나타냅니다. 즉, 목록에 있는 메시지를 하나도 전송할 수 없습니다. 부분 실패는 BatchResponse 반환 값으로 표시됩니다.

서명:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

매개변수

반환:

프라미스 <BatchResponse>

전송 작업의 결과를 나타내는 객체로 처리된 프로미스입니다.

Messaging.send개별()

Firebase 클라우드 메시징을 통해 지정된 배열의 각 메시지를 전송합니다.

Messaging.sendAll()과 달리 이 메서드는 지정된 배열의 각 메시지에 대해 단일 RPC 호출을 수행합니다.

반환 값에서 가져온 응답 목록은 messages의 순서에 해당합니다. 이 메서드의 오류 또는 모든 실패가 있는 BatchResponse는 전체 실패를 나타내며, 즉 목록에 있는 메시지를 하나도 전송할 수 없음을 나타냅니다. 부분 실패 또는 실패는 BatchResponse 반환 값으로만 표시됩니다.

서명:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

매개변수

반환:

프라미스 <BatchResponse>

전송 작업의 결과를 나타내는 객체로 처리된 프로미스입니다.

Messaging.sendeachForMulticast()

지정된 멀티캐스트 메시지를 지정된 모든 FCM 등록 토큰으로 보냅니다.

이 메서드는 내부적으로 Messaging.sendeach() API를 사용하여 모든 대상 수신자에게 지정된 메시지를 보냅니다. 반환 값에서 가져온 응답 목록은 MulticastMessage의 토큰 순서와 일치합니다. 이 메서드의 오류 또는 모든 실패가 있는 BatchResponse는 전체 실패를 나타내며 목록의 메시지가 전송될 수 있음을 나타냅니다. 부분적인 실패 또는 실패는 BatchResponse 반환 값으로만 표시됩니다.

서명:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

매개변수

반환:

프라미스 <BatchResponse>

전송 작업의 결과를 나타내는 객체로 처리된 프로미스입니다.

Messaging.sendMulticast()

</ph>

대신 Messaging.sendeachForMulticast()를 사용하세요.

지정된 멀티캐스트 메시지를 지정된 모든 FCM 등록 토큰으로 보냅니다.

이 메서드는 내부적으로 sendAll() API를 사용하여 지정된 메시지를 모든 대상 수신자에게 전송합니다. 반환 값에서 가져온 응답 목록은 MulticastMessage의 토큰 순서와 일치합니다. 이 메서드의 오류는 전체 실패를 나타냅니다. 즉, 메시지가 목록의 토큰으로 전송되지 않았습니다. 부분 실패는 BatchResponse 반환 값으로 표시됩니다.

서명:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

매개변수

반환:

프라미스 <BatchResponse>

전송 작업의 결과를 나타내는 객체로 처리된 프로미스입니다.

Messaging.sendToCondition()

</ph>

대신 Messaging.send()를 사용하세요.

조건에 FCM 메시지를 보냅니다.

코드 샘플 및 자세한 문서는 조건으로 전송을 참조하세요.

서명:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

매개변수

반환:

프라미스<MessagingConditionResponse>

메시지가 전송된 후 서버의 응답으로 프라미스가 처리됩니다.

Messaging.sendToDevice()

</ph>

대신 Messaging.send()를 사용하세요.

제공된 등록 토큰에 해당하는 단일 기기로 FCM 메시지를 보냅니다.

코드 샘플 및 자세한 문서는 개별 기기로 전송을 참고하세요. 단일 기기로 전송할 registrationToken 또는 여러 기기로 전송할 토큰 배열이 포함된 registrationTokens 매개변수를 사용합니다.

서명:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

매개변수

반환:

프로미스<MessagingDevicesResponse>

메시지가 전송된 후 서버의 응답으로 프라미스가 처리됩니다.

Messaging.sendToDeviceGroup()

</ph>

대신 Messaging.send()를 사용하세요.

제공된 알림 키에 해당하는 기기 그룹으로 FCM 메시지를 보냅니다.

코드 샘플 및 자세한 문서는 기기 그룹으로 전송을 참고하세요.

서명:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

매개변수

반환:

프로미스<MessagingDeviceGroupResponse>

메시지가 전송된 후 서버의 응답으로 프라미스가 처리됩니다.

Messaging.sendToTopic()

</ph>

대신 Messaging.send()를 사용하세요.

주제에 FCM 메시지를 보냅니다.

코드 샘플 및 자세한 문서는 주제로 전송을 참고하세요.

서명:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

매개변수

반환:

프라미스<MessagingTopicResponse>

메시지가 전송된 후 서버의 응답으로 프라미스가 처리됩니다.

Messaging.subscribeToTopic()

기기를 FCM 주제에 구독합니다.

코드 샘플과 자세한 문서는 주제 구독을 참고하세요. 원하는 경우 토큰 배열을 제공하여 여러 기기를 구독할 수 있습니다.

서명:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

매개변수

반환:

프라미스<MessagingTopicManagementResponse>

기기가 주제를 구독한 후 서버의 응답으로 프라미스가 처리됩니다.

Messaging.unsubscribeFromTopic()

기기에서 FCM 주제에서 구독을 취소합니다.

코드 샘플과 자세한 문서는 주제 구독 취소를 참고하세요. 원하는 경우 토큰 배열을 제공하여 여러 기기를 구독 취소할 수 있습니다.

서명:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

매개변수

반환:

프라미스<MessagingTopicManagementResponse>

기기가 주제에서 구독 취소된 후 서버의 응답으로 프라미스가 처리됩니다.