@firebase/messaging

기능

기능 설명
기능(앱, ...)
getMessaging(앱) Firebase 클라우드 메시징 인스턴스를 검색합니다.
기능(메시징, ...)
deleteToken(메시징)Messaging 인스턴스와 연결된 등록 토큰을 삭제하고 푸시 구독에서 Messaging 인스턴스 구독을 취소합니다.
getToken(메시징, 옵션) 푸시 알림을 위해 Messaging 인스턴스를 구독합니다. 해당 메시징 인스턴스에 푸시 메시지를 보내는 데 사용할 수 있는 Firebase 클라우드 메시징 등록 토큰을 반환합니다. 알림 권한이 아직 부여되지 않은 경우 이 메서드는 사용자에게 권한을 요청합니다. 사용자가 앱의 알림 표시를 허용하지 않으면 반환된 Promise가 거부됩니다.
onMessage(메시징, nextOrObserver) 푸시 메시지가 수신되고 사용자가 현재 원본 페이지에 있으면 메시지가 페이지로 전달되고 onMessage() 이벤트가 푸시 메시지의 페이로드와 함께 전달됩니다.
기능()
지원됨() 브라우저에 필요한 모든 API가 있는지 확인합니다.

인터페이스

상호 작용 설명
Fcm옵션 웹용 FCM SDK에서 제공하는 기능에 대한 옵션입니다. WebpushFcm옵션을 참조하세요. .
GetToken옵션 getToken() 옵션 .
메시지페이로드 NotificationPayload 로 표시되는 알림 페이로드가 포함된 메시지 페이로드와 개발자가 Send API를 통해 전송한 임의 개수의 키-값 쌍이 포함된 데이터 페이로드 .
메시징 Firebase 클라우드 메시징 SDK의 공개 인터페이스입니다.
알림 페이로드 알림 세부정보를 표시합니다. 세부정보는 Send API를 통해 전송됩니다. .

기능(앱, ...)

getMessaging(앱)

Firebase 클라우드 메시징 인스턴스를 검색합니다.

서명:

export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;

매개변수

매개변수 유형 설명
Firebase앱

보고:

메시징

제공된 Firebase 앱과 연결된 Firebase 클라우드 메시징 인스턴스입니다.

기능(메시징, ...)

deleteToken(메시징)

Messaging 인스턴스와 연결된 등록 토큰을 삭제하고 푸시 구독에서 Messaging 인스턴스 구독을 취소합니다.

서명:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

매개변수

매개변수 유형 설명
메시징 메시징 메시징 인스턴스.

보고:

약속<부울>

토큰이 성공적으로 삭제되면 Promise가 해결됩니다.

getToken(메시징, 옵션)

푸시 알림을 위해 Messaging 인스턴스를 구독합니다. 해당 메시징 인스턴스에 푸시 메시지를 보내는 데 사용할 수 있는 Firebase 클라우드 메시징 등록 토큰을 반환합니다.

알림 권한이 아직 부여되지 않은 경우 이 메서드는 사용자에게 권한을 요청합니다. 사용자가 앱의 알림 표시를 허용하지 않으면 반환된 Promise가 거부됩니다.

서명:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

매개변수

매개변수 유형 설명
메시징 메시징 메시징 인스턴스.
옵션 GetToken옵션 선택적 Vapid 키와 선택적 서비스 워커 등록을 제공합니다.

보고:

약속<문자열>

Promise는 FCM 등록 토큰으로 해결됩니다.

onMessage(메시징, nextOrObserver)

푸시 메시지가 수신되고 사용자가 현재 원본 페이지에 있으면 메시지가 페이지로 전달되고 onMessage() 이벤트가 푸시 메시지의 페이로드와 함께 전달됩니다.

서명:

export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

매개변수

매개변수 유형 설명
메시징 메시징 메시징 인스턴스.
다음또는관찰자 다음Fn < 메시지페이로드 > | 관찰자 < 메시지페이로드 > 이 함수 또는 next 정의된 관찰자 개체는 메시지가 수신되고 사용자가 현재 페이지를 보고 있을 때 호출됩니다.

보고:

구독 취소

메시지 수신을 중지하려면 반환된 이 함수를 실행하세요.

기능()

지원됨()

브라우저에 필요한 모든 API가 있는지 확인합니다.

서명:

export declare function isWindowSupported(): Promise<boolean>;

보고:

약속<부울>

부울로 해결되는 Promise.