FCM 기존 API를 통해 메시지를 보낼 때 제공할 수 있는 옵션을 나타내는 인터페이스입니다.
코드 샘플 및 자세한 문서는 전송 요청 작성을 참고하세요.
서명:
export interface MessagingOptions
속성
| 속성 | 유형 | 설명 |
|---|---|---|
| 접기 키 | 문자열 | 축소할 수 있는 메시지 그룹 (예: '업데이트 가능')을 식별하는 문자열로, 전송을 재개할 수 있을 때 마지막 메시지만 전송될 수 있습니다. 기기가 다시 온라인 또는 활성 상태가 되었을 때 동일한 메시지가 너무 많이 전송되지 않도록 하는 데 사용됩니다.메시지가 전송되는 순서는 보장되지 않습니다.한 번에 최대 4개의 서로 다른 축소 키가 허용됩니다. 즉, FCM 서버는 클라이언트 앱당 4개의 서로 다른 동기화 전송 메시지를 동시에 저장할 수 있습니다. 이 한도를 초과하면 FCM 서버가 어떤 축소 키 4개를 유지할지 보장되지 않습니다.**기본값:** 없음 |
| contentAvailable | 부울 | iOS에서는 이 필드를 사용하여 APN 페이로드의 content-available를 나타냅니다. 알림이나 데이터 메시지가 전송될 때 이 값이 true로 설정되어 있으면 비활성 클라이언트 앱이 활성 상태로 전환됩니다. Android에서는 기본적으로 데이터 메시지가 앱을 깨웁니다. Chrome에서는 현재 이 플래그가 지원되지 않습니다.**기본값:** false |
| dryRun | 부울 | 메시지가 실제로 전송되어야 하는지 여부입니다. true로 설정하면 개발자가 실제로 메시지를 보내지 않고도 요청을 테스트할 수 있습니다. false로 설정하면 메시지가 전송됩니다.**기본값:** false |
| mutableContent | 부울 | iOS에서는 이 필드를 사용하여 APN 페이로드의 mutable-content를 나타냅니다. 알림이 전송될 때 이 매개변수가 true로 설정되어 있으면 알림이 표시되기 전에 알림 서비스 앱 확장 프로그램을 사용하여 알림의 내용을 수정할 수 있습니다.Android 및 웹에서는 이 매개변수가 무시됩니다.**기본값:** false |
| 우선순위 | 문자열 | 메시지의 우선순위입니다. 유효한 값은 "normal" 및 "high".입니다. iOS에서는 APN 우선순위 5 및 10에 해당합니다.기본적으로 알림 메시지는 높은 우선순위로 전송되고 데이터 메시지는 보통 우선순위로 전송됩니다. 보통 우선순위는 클라이언트 앱의 배터리 소모를 최적화하며, 즉시 전송해야 하는 경우가 아니라면 이 우선순위를 사용해야 합니다. 우선순위가 보통인 메시지의 경우 앱이 메시지를 수신할 때 불특정 지연이 발생할 수 있습니다.메시지가 높은 우선순위로 전송되면 즉시 전송되며 앱이 절전 모드인 기기의 절전 모드를 해제하고 서버와의 네트워크 연결을 열 수 있습니다.자세한 내용은 메시지 우선순위 설정을 참고하세요.**기본값:** 알림 메시지의 경우 "high", 데이터 메시지의 경우 "normal"를 참고하세요. |
| restrictedPackageName | 문자열 | 메시지를 수신하기 위해 등록 토큰이 일치해야 하는 애플리케이션의 패키지 이름입니다.**기본값:** 없음 |
| timeToLive | 숫자 | 기기가 오프라인 상태인 경우 FCM 저장소에 메시지를 보관해야 하는 시간 (초)입니다. 지원되는 최대 TTL(수명)은 4주이며 기본값도 4주입니다. 자세한 내용은 메시지 수명 설정을 참조하세요.**기본값:** 2419200 (초 단위로 4주를 나타냄) |
MessagingOptions.축소Key
축소할 수 있는 메시지 그룹 (예: '업데이트 가능')을 식별하는 문자열로, 전송을 재개할 수 있을 때 마지막 메시지만 전송될 수 있습니다. 기기가 다시 온라인 또는 활성 상태가 되었을 때 동일한 메시지가 너무 많이 전송되지 않도록 하는 데 사용됩니다.
메시지가 전송되는 순서는 보장되지 않는다는 점에 유의하세요.
언제든지 최대 4개의 서로 다른 축소 키가 허용됩니다. 즉, FCM 서버는 클라이언트 앱당 4개의 서로 다른 동기화 전송 메시지를 동시에 저장할 수 있습니다. 이 한도를 초과하면 FCM 서버가 어떤 축소 키 4개를 유지할지 확실히 알 수 없습니다.
**기본값:** 없음
서명:
collapseKey?: string;
MessagingOptions.contentAvailable
iOS에서는 이 필드를 사용하여 APN 페이로드의 content-available를 나타냅니다. 알림이나 데이터 메시지가 전송될 때 이 값이 true로 설정되어 있으면 비활성 클라이언트 앱이 활성 상태로 전환됩니다. Android에서는 기본적으로 데이터 메시지가 앱을 깨웁니다. Chrome에서는 현재 이 플래그가 지원되지 않습니다.
**기본값:** false
서명:
contentAvailable?: boolean;
MessagingOptions.dryRun
메시지가 실제로 전송되어야 하는지 여부입니다. true로 설정하면 개발자가 실제로 메시지를 보내지 않고도 요청을 테스트할 수 있습니다. false로 설정하면 메시지가 전송됩니다.
**기본값:** false
서명:
dryRun?: boolean;
MessagingOptions.mutableContent
iOS에서는 이 필드를 사용하여 APN 페이로드의 mutable-content를 나타냅니다. 알림이 전송될 때 이 매개변수가 true로 설정되어 있으면 알림을 표시하기 전에 알림 서비스 앱 확장 프로그램을 사용하여 알림의 내용을 수정할 수 있습니다.
Android 및 웹에서는 이 매개변수가 무시됩니다.
**기본값:** false
서명:
mutableContent?: boolean;
MessagingOptions.우선순위
메시지의 우선순위입니다. 유효한 값은 "normal" 및 "high".입니다. iOS에서는 APN 우선순위 5 및 10에 해당합니다.
기본적으로 알림 메시지는 높은 우선순위로, 데이터 메시지는 보통 우선순위로 전송됩니다. 보통 우선순위는 클라이언트 앱의 배터리 소모를 최적화하며, 즉시 전송해야 하는 경우가 아니라면 이 우선순위를 사용해야 합니다. 우선순위가 보통인 메시지의 경우 앱이 메시지를 수신할 때 지정되지 않은 지연이 발생할 수 있습니다.
높은 우선순위로 메시지를 보내면 즉시 전송되며 앱이 절전 모드인 기기의 절전 모드를 해제하고 서버에 대한 네트워크 연결을 열 수 있습니다.
자세한 내용은 메시지 우선순위 설정하기를 참고하세요.
**기본값:** 알림 메시지의 경우 "high", 데이터 메시지의 경우 "normal"
서명:
priority?: string;
MessagingOptions.restrictedPackageName
메시지를 수신하기 위해 등록 토큰이 일치해야 하는 애플리케이션의 패키지 이름입니다.
**기본값:** 없음
서명:
restrictedPackageName?: string;
MessagingOptions.timeToLive
기기가 오프라인 상태인 경우 FCM 저장소에 메시지를 보관해야 하는 시간 (초)입니다. 지원되는 최대 TTL(수명)은 4주이며 기본값도 4주입니다. 자세한 내용은 메시지 수명 설정을 참조하세요.
**기본값:** 2419200 (4주를 초 단위로 나타냄)
서명:
timeToLive?: number;