Interface CompanionActionDefinition

The definition of an action

interface CompanionActionDefinition {
    callback: (
        action: CompanionActionEvent,
        context: CompanionActionContext,
    ) => void | Promise<void>;
    description?: string;
    learn?: (
        action: CompanionActionEvent,
        context: CompanionActionContext,
    ) =>
        | undefined
        | CompanionOptionValues
        | Promise<undefined | CompanionOptionValues>;
    learnTimeout?: number;
    name: string;
    options: SomeCompanionActionInputField[];
    optionsToIgnoreForSubscribe?: string[];
    skipUnsubscribeOnOptionsChange?: boolean;
    subscribe?: (
        action: CompanionActionInfo,
        context: CompanionActionContext,
    ) => void | Promise<void>;
    unsubscribe?: (
        action: CompanionActionInfo,
        context: CompanionActionContext,
    ) => void | Promise<void>;
}

Properties

callback description? learn? learnTimeout? name options optionsToIgnoreForSubscribe? skipUnsubscribeOnOptionsChange? subscribe? unsubscribe?

Properties

callback

callback: (
    action: CompanionActionEvent,
    context: CompanionActionContext,
) => void | Promise<void>

Called to execute the action

Optionaldescription

description?: string

Additional description of the action

Optionallearn

learn?: (
    action: CompanionActionEvent,
    context: CompanionActionContext,
) =>
    | undefined
    | CompanionOptionValues
    | Promise<undefined | CompanionOptionValues>

The user requested to 'learn' the values for this action.

OptionallearnTimeout

learnTimeout?: number

Timeout for the 'learn' function (in milliseconds) Companion sets a default value of 5s, to ensure that the learn does not get stuck never completing You can change this if this number does not work for you, but you should keep it to a sensible value

name

name: string

Name to show in the actions list

options

options: SomeCompanionActionInputField[]

The input fields for the action

OptionaloptionsToIgnoreForSubscribe

optionsToIgnoreForSubscribe?: string[]

Ignore changes to certain options and don't allow them to trigger the subscribe/unsubscribe callbacks This allows for ensuring that the subscribe callback is only called when values the action cares about change

OptionalskipUnsubscribeOnOptionsChange

skipUnsubscribeOnOptionsChange?: boolean

If true, the unsubscribe callback will not be called when the options change, only when the action is removed or disabled

Optionalsubscribe

subscribe?: (
    action: CompanionActionInfo,
    context: CompanionActionContext,
) => void | Promise<void>

Called to report the existence of an action Useful to ensure necessary data is loaded

Optionalunsubscribe

unsubscribe?: (
    action: CompanionActionInfo,
    context: CompanionActionContext,
) => void | Promise<void>

Called to report an action has been edited/removed Useful to cleanup subscriptions setup in subscribe

Settings

Member Visibility

On This Page

Properties