Class: Action

NotificationClient.Action

Implements

• IAction

Constructors

constructor

• new Action()

Properties

buttonText

• buttonText: string = ""

Text to display on the button UI.

Implementation of

IAction.buttonText

---

channel

• Optional channel: string

Channel to transmit payload on QUERY, TRANSMIT and PUBLISH actions

Implementation of

IAction.channel

---

component

• Optional component: string

Component to spawn when using the spawn action.

Implementation of

IAction.component

---

id

• id: string = ""

For Internal use

Implementation of

IAction.id

---

markAsRead

• Optional markAsRead: boolean

Mark the Notification as read when performing this action. Defaults to true if not set.

Implementation of

IAction.markAsRead

---

milliseconds

• Optional milliseconds: number

Milliseconds to snooze for when using the snooze action

Implementation of

IAction.milliseconds

---

payload

• Optional payload: any

Payload transmitted along channel on QUERY, TRANSMIT and PUBLISH actions

Implementation of

IAction.payload

---

spawnParams

• Optional spawnParams: Object

The spawnParams passed to the spawn function. These are the configuration settings from the

finsemble.appd[].manifest.windowsection of the application manifest, except for the `options` element.

Implementation of

IAction.spawnParams

---

type

• type: string = ""

DISMISS | SNOOZE | SPAWN | QUERY | PUBLISH | TRANSMIT

Implementation of

IAction.type