Skip to main content

Interface: IAction

NotificationClient.IAction

property {string} id - UUID

property {string} buttonText - Text to display on the button UI.

property {string} type - Type of action.

property {number} milliseconds - Milliseconds to snooze for.

property {string} component - Component to spawn.

property {Object} spawnParams - params passed to the spawn function.

property {string} channel - channel to transmit payload on.

property payload {any} - payload transmitted along channel.

Implemented by​

Properties​

buttonText​

• buttonText: string

Text to display on the button UI.

channel​

• Optional channel: string

Channel to transmit payload on QUERY, TRANSMIT and PUBLISH actions

component​

• Optional component: string

Component to spawn when using the spawn action.

id​

• Optional id: string

For Internal use

markAsRead​

• Optional markAsRead: boolean

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

milliseconds​

• Optional milliseconds: number

Milliseconds to snooze for when using the snooze action

payload​

• Optional payload: any

Payload transmitted along channel on QUERY, TRANSMIT and PUBLISH actions

spawnParams​

• Optional spawnParams: any

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.

type​

• type: string

DISMISS | SNOOZE | SPAWN | QUERY | PUBLISH | TRANSMIT