Interface CompanionActionEvent<TOptions>

Extended information for execution of an action

interface CompanionActionEvent<
    TOptions extends CompanionOptionValues = CompanionOptionValues,
> {
    actionId: string;
    controlId: string;
    id: string;
    options: TOptions;
    surfaceId: string | undefined;
}

Type Parameters

TOptions extends CompanionOptionValues = CompanionOptionValues

Hierarchy (View Summary)

CompanionActionInfo<TOptions>
- CompanionActionEvent

Index

Properties

actionId controlId id options surfaceId

Properties

`Readonly`actionId

actionId: string

The id of the action definition

`Readonly`controlId

controlId: string

The unique id for the location of this action

`Readonly`id

id: string

The unique id for this action

`Readonly`options

options: TOptions

The user selected options for the action

`Readonly`surfaceId

surfaceId: string | undefined

Identifier of the surface which triggered this action