Edit

Share via

OpenNotificationButton interface

  • Reference
Package:
@ms-fabric/workload-client

An interface representing a button displayed on the notification toast

Extends

WorkloadAction<unknown>

Properties

buttonType
label

Text that display at button

Inherited Properties

action

The name of the action. The iframe that receives the action needs to distinguish the actions by name and apply different handling logic.
data

The payload data of the action
iframeType

The iframe type to receive the action. If not specified, by default, the action is received by the worker iframe.
userActionTimestamp

The timestamp of the user action that triggers the excute action event. Workload UX can use this timestamp as the time origin for some end-to-end, user-perceivable performance logging.
workloadName

The workload to receive the action

Property Details

buttonType

Warning

This API is now deprecated.

the buttons will share the same style

buttonType?: OpenNotificationButtonType

Property Value

OpenNotificationButtonType

label

Text that display at button

label?: string

Property Value

string

Inherited Property Details

action

The name of the action. The iframe that receives the action needs to distinguish the actions by name and apply different handling logic.

action: string

Property Value

string

Inherited From WorkloadAction.action

data

The payload data of the action

data?: unknown

Property Value

unknown

Inherited From WorkloadAction.data

iframeType

The iframe type to receive the action. If not specified, by default, the action is received by the worker iframe.

iframeType?: IFrameType

Property Value

IFrameType

Inherited From WorkloadAction.iframeType

userActionTimestamp

The timestamp of the user action that triggers the excute action event. Workload UX can use this timestamp as the time origin for some end-to-end, user-perceivable performance logging.

userActionTimestamp?: number

Property Value

number

Inherited From WorkloadAction.userActionTimestamp

workloadName

The workload to receive the action

workloadName: string

Property Value

string

Inherited From WorkloadAction.workloadName