AndroidConfig interface

Stay organized with collections Save and categorize content based on your preferences.

Represents the Android-specific options that can be included in an Message.

Signature:

exportinterfaceAndroidConfig

Properties

AndroidConfig.collapseKey

Collapse key for the message. Collapse key serves as an identifier for a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed. A maximum of four different collapse keys may be active at any given time.

Signature:

collapseKey?:string;

AndroidConfig.data

A collection of data fields to be included in the message. All values must be strings. When provided, overrides any data fields set on the top-level Message.

Signature:

data?:{[key:string]:string;};

AndroidConfig.directBootOk

A boolean indicating whether messages will be allowed to be delivered to the app while the device is in direct boot mode.

Signature:

directBootOk?:boolean;

AndroidConfig.fcmOptions

Options for features provided by the FCM SDK for Android.

Signature:

fcmOptions?:AndroidFcmOptions;

AndroidConfig.notification

Android notification to be included in the message.

Signature:

notification?:AndroidNotification;

AndroidConfig.priority

Priority of the message. Must be either normal or high.

Signature:

priority?:('high'|'normal');

AndroidConfig.restrictedPackageName

Package name of the application where the registration tokens must match in order to receive the message.

Signature:

restrictedPackageName?:string;

AndroidConfig.ttl

Time-to-live duration of the message in milliseconds.

Signature:

ttl?:number;