Edit

Share via

WorkloadAction interface

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

The interface representing an action that a particular workload can handle

Extends

BaseAction<TData>

Properties

iframeType

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

The workload to receive the action

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
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.

Property Details

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

workloadName

The workload to receive the action

workloadName: 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 BaseAction.action

data

The payload data of the action

data?: TData

Property Value

TData

Inherited From BaseAction.data

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 BaseAction.userActionTimestamp