react-native-notify-kit

react-native-notify-kit / FcmConfig

Type Alias: FcmConfig

FcmConfig = object

Defined in: packages/react-native/src/fcm/types.ts:23

Configuration for handleFcmMessage. Call setFcmConfig once at app startup (typically in index.js before registerComponent).

Properties

defaultChannelId?

optional defaultChannelId?: string

Defined in: packages/react-native/src/fcm/types.ts:30

Default channelId used when notifee_options.android.channelId is absent. If this is also absent and the payload has no channelId, displayNotification will throw on Android — same behavior as calling displayNotification without a channel.

defaultPressAction?

optional defaultPressAction?: object

Defined in: packages/react-native/src/fcm/types.ts:36

Default pressAction when notifee_options.android.pressAction is absent. Mirrors the existing behavior: { id: 'default', launchActivity: 'default' }.

id

id: string

launchActivity?

optional launchActivity?: string

fallbackBehavior?

optional fallbackBehavior?: "display" | "ignore"

Defined in: packages/react-native/src/fcm/types.ts:46

What to do when remoteMessage.data.notifee_options is absent entirely.

• 'display': build a minimal notification from remoteMessage.notification title/body (or data.title/data.body as a fallback). Uses defaultChannelId.
• 'ignore': return null without displaying anything.

Default

'display';

ios?

optional ios?: object

Defined in: packages/react-native/src/fcm/types.ts:49

iOS-specific options.

suppressForegroundBanner?

optional suppressForegroundBanner?: boolean

When true, foreground notifications delivered via handleFcmMessage are NOT displayed (only events are emitted).

Default

false;