MessagingOptions interface

FCM 레거시 API를 통해 메시지를 보낼 때 제공할 수 있는 옵션을 나타내는 인터페이스입니다.

코드 샘플 및 자세한 문서는 보내기 요청 빌드를 참조하세요.

서명:

export interface MessagingOptions 

속성

재산 유형 설명
축소키 배달이 재개될 때 마지막 메시지만 전송되도록 축소할 수 있는 메시지 그룹(예: "업데이트 가능")을 식별하는 문자열입니다. 이는 장치가 다시 온라인 상태가 되거나 활성화될 때 동일한 메시지를 너무 많이 보내는 것을 방지하는 데 사용됩니다. 메시지가 전송되는 순서는 보장되지 않습니다. 주어진 시간에 최대 4개의 서로 다른 축소 키가 허용됩니다. 이는 FCM 서버가 클라이언트 앱당 4개의 서로 다른 동기화 전송 메시지를 동시에 저장할 수 있음을 의미합니다. 이 숫자를 초과하면 FCM 서버가 어떤 축소 키 4개를 ​​유지할지 보장할 수 없습니다. **기본값:** 없음
콘텐츠 이용 가능 부울 iOS에서는 이 필드를 사용하여 APN 페이로드에서 content-available 나타냅니다. 알림 또는 데이터 메시지가 전송되고 이것이 true 로 설정되면 비활성 클라이언트 앱이 활성화됩니다. Android에서는 데이터 메시지가 기본적으로 앱을 깨웁니다. Chrome에서는 현재 이 플래그가 지원되지 않습니다. **기본값:** false
드라이런 부울 메시지를 실제로 보내야 하는지 여부입니다. true 로 설정하면 개발자가 실제로 메시지를 보내지 않고도 요청을 테스트할 수 있습니다. false 로 설정하면 메시지가 전송됩니다. **기본값:** false
변경 가능한 콘텐츠 부울 iOS에서는 이 필드를 사용하여 APN 페이로드의 mutable-content 나타냅니다. 알림이 전송되고 이것이 true 로 설정되면 알림 서비스 앱 확장을 사용하여 알림 내용을 표시하기 전에 수정할 수 있습니다. . Android 및 웹에서는 이 매개변수가 무시됩니다. **기본값:** false
우선 사항 메시지의 우선순위입니다. 유효한 값은 "normal""high". iOS에서는 APN 우선순위 510 에 해당합니다. 기본적으로 알림 메시지는 높은 우선순위로 전송되고 데이터 메시지는 보통 우선순위로 전송됩니다. 보통 우선순위는 클라이언트 앱의 배터리 소모를 최적화하며 즉각적인 전달이 필요한 경우가 아니면 사용해야 합니다. 우선순위가 보통인 메시지의 경우 앱은 지정되지 않은 지연으로 메시지를 수신할 수 있습니다. 높은 우선순위로 메시지가 전송되면 즉시 전송되며, 앱은 잠자고 있는 장치를 깨우고 서버에 대한 네트워크 연결을 열 수 있습니다. 자세한 내용은 메시지 우선순위 설정을 참조하세요. . **기본값:** 알림 메시지는 "high" , 데이터 메시지는 "normal"
제한된 패키지 이름 메시지를 수신하기 위해 등록 토큰이 일치해야 하는 애플리케이션의 패키지 이름입니다. **기본값:** 없음
timeToLive 숫자 기기가 오프라인인 경우 메시지가 FCM 저장소에 보관되어야 하는 기간(초)입니다. 지원되는 최대 TTL(Time to Live)은 4주이며 기본값도 4주입니다. 자세한 내용은 메시지 수명 설정을 참조하세요. . **기본값:** 2419200 (4주를 초 단위로 나타냄)

MessagingOptions.collapseKey

배달이 재개될 때 마지막 메시지만 전송되도록 축소할 수 있는 메시지 그룹(예: "업데이트 가능")을 식별하는 문자열입니다. 이는 장치가 다시 온라인 상태가 되거나 활성화될 때 동일한 메시지를 너무 많이 보내는 것을 방지하는 데 사용됩니다.

메시지가 전송되는 순서는 보장되지 않습니다.

주어진 시간에 최대 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.priority

메시지의 우선순위입니다. 유효한 값은 "normal""high". iOS에서는 APN 우선순위 510 에 해당합니다. .

기본적으로 알림 메시지는 높은 우선순위로 전송되고 데이터 메시지는 보통 우선순위로 전송됩니다. 보통 우선순위는 클라이언트 앱의 배터리 소모를 최적화하며 즉각적인 전달이 필요한 경우가 아니면 사용해야 합니다. 우선순위가 보통인 메시지의 경우 앱은 지정되지 않은 지연으로 메시지를 수신할 수 있습니다.

높은 우선순위로 메시지가 전송되면 즉시 전송되며, 앱은 잠자고 있는 장치를 깨우고 서버에 대한 네트워크 연결을 열 수 있습니다.

자세한 내용은 메시지 우선순위 설정을 참조하세요. .

**기본값:** 알림 메시지는 "high" , 데이터 메시지는 "normal"

서명:

priority?: string;

MessagingOptions.restrictedPackageName

메시지를 수신하기 위해 등록 토큰이 일치해야 하는 애플리케이션의 패키지 이름입니다.

**기본값:** 없음

서명:

restrictedPackageName?: string;

MessagingOptions.timeToLive

기기가 오프라인인 경우 메시지가 FCM 저장소에 보관되어야 하는 기간(초)입니다. 지원되는 최대 TTL(Time to Live)은 4주이며 기본값도 4주입니다. 자세한 내용은 메시지 수명 설정을 참조하세요. .

**기본값:** 2419200 (4주를 초 단위로 나타냄)

서명:

timeToLive?: number;