Interface CompanionActionEvent

Extended information for execution of an action

interface CompanionActionEvent {
    actionId: string;
    controlId: string;
    id: string;
    options: CompanionOptionValues;
    surfaceId: undefined | string;
}

Hierarchy (view full)

Properties

actionId controlId id options surfaceId

Properties

ReadonlyactionId

actionId: string

The id of the action definition

ReadonlycontrolId

controlId: string

The unique id for the location of this action

Readonlyid

id: string

The unique id for this action

Readonlyoptions

options: CompanionOptionValues

The user selected options for the action

ReadonlysurfaceId

surfaceId: undefined | string

Identifier of the surface which triggered this action

Settings

Member Visibility

On This Page

Properties