Options

Defined in: plugins/notification/guest-js/index.ts:25

Options to send a notification.

Since

2.0.0

Properties

actionTypeId?

optional actionTypeId: string

Defined in: plugins/notification/guest-js/index.ts:62

Defines an action type for this notification.

---

attachments?

optional attachments: Attachment[]

Defined in: plugins/notification/guest-js/index.ts:104

Notification attachments.

---

autoCancel?

optional autoCancel: boolean

Defined in: plugins/notification/guest-js/index.ts:120

Automatically cancel the notification when the user clicks on it.

---

body?

optional body: string

Defined in: plugins/notification/guest-js/index.ts:44

Optional notification body.

---

channelId?

optional channelId: string

Defined in: plugins/notification/guest-js/index.ts:36

Identifier of the Channel that deliveres this notification.

If the channel does not exist, the notification won’t fire. Make sure the channel exists with listChannels and createChannel.

---

extra?

optional extra: Record<string, unknown>

Defined in: plugins/notification/guest-js/index.ts:108

Extra payload to store in the notification.

---

group?

optional group: string

Defined in: plugins/notification/guest-js/index.ts:68

Identifier used to group multiple notifications.

https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent/1649872-threadidentifier

---

groupSummary?

optional groupSummary: boolean

Defined in: plugins/notification/guest-js/index.ts:72

Instructs the system that this notification is the summary of a group on Android.

---

icon?

optional icon: string

Defined in: plugins/notification/guest-js/index.ts:90

Notification icon.

On Android the icon must be placed in the app’s res/drawable folder.

---

iconColor?

optional iconColor: string

Defined in: plugins/notification/guest-js/index.ts:100

Icon color on Android.

---

id?

optional id: number

Defined in: plugins/notification/guest-js/index.ts:29

The notification identifier to reference this object later. Must be a 32-bit integer.

---

inboxLines?

optional inboxLines: string[]

Defined in: plugins/notification/guest-js/index.ts:84

List of lines to add to the notification. Changes the notification style to inbox. Cannot be used with largeBody.

Only supports up to 5 lines.

---

largeBody?

optional largeBody: string

Defined in: plugins/notification/guest-js/index.ts:54

Multiline text. Changes the notification style to big text. Cannot be used with inboxLines.

---

largeIcon?

optional largeIcon: string

Defined in: plugins/notification/guest-js/index.ts:96

Notification large icon (Android).

The icon must be placed in the app’s res/drawable folder.

---

number?

optional number: number

Defined in: plugins/notification/guest-js/index.ts:132

Sets the number of items this notification represents on Android.

---

ongoing?

optional ongoing: boolean

Defined in: plugins/notification/guest-js/index.ts:116

If true, the notification cannot be dismissed by the user on Android.

An application service must manage the dismissal of the notification. It is typically used to indicate a background task that is pending (e.g. a file download) or the user is engaged with (e.g. playing music).

---

schedule?

optional schedule: Schedule

Defined in: plugins/notification/guest-js/index.ts:48

Schedule this notification to fire on a later time or a fixed interval.

---

silent?

optional silent: boolean

Defined in: plugins/notification/guest-js/index.ts:124

Changes the notification presentation to be silent on iOS (no badge, no sound, not listed).

---

sound?

optional sound: string

Defined in: plugins/notification/guest-js/index.ts:76

The sound resource name. Only available on mobile.

---

summary?

optional summary: string

Defined in: plugins/notification/guest-js/index.ts:58

Detail text for the notification with largeBody, inboxLines or groupSummary.

---

title

title: string

Defined in: plugins/notification/guest-js/index.ts:40

Notification title.

---

visibility?

optional visibility: Visibility

Defined in: plugins/notification/guest-js/index.ts:128

Notification visibility.