Interface CompanionBooleanFeedbackDefinition

The definition of a boolean feedback

interface CompanionBooleanFeedbackDefinition {
    callback: (
        feedback: CompanionFeedbackInfo,
        context: CompanionCommonCallbackContext,
    ) => boolean | Promise<boolean>;
    defaultStyle: Partial<Partial<CompanionButtonStyleProps>>;
    description?: string;
    learn?: (
        action: CompanionFeedbackInfo,
        context: CompanionCommonCallbackContext,
    ) =>
        | undefined
        | CompanionOptionValues
        | Promise<undefined | CompanionOptionValues>;
    learnTimeout?: number;
    name: string;
    options: SomeCompanionFeedbackInputField[];
    showInvert?: boolean;
    subscribe?: (
        feedback: CompanionFeedbackInfo,
        context: CompanionCommonCallbackContext,
    ) => void | Promise<void>;
    type: "boolean";
    unsubscribe?: (
        feedback: CompanionFeedbackInfo,
        context: CompanionCommonCallbackContext,
    ) => void | Promise<void>;
}

Hierarchy (View Summary)

Properties

callback defaultStyle description? learn? learnTimeout? name options showInvert? subscribe? type unsubscribe?

Properties

callback

callback: (
    feedback: CompanionFeedbackInfo,
    context: CompanionCommonCallbackContext,
) => boolean | Promise<boolean>

Called to get the feedback value

defaultStyle

defaultStyle: Partial<Partial<CompanionButtonStyleProps>>

The default style properties for this feedback

Optionaldescription

description?: string

Additional description of the feedback

Optionallearn

learn?: (
    action: CompanionFeedbackInfo,
    context: CompanionCommonCallbackContext,
) =>
    | undefined
    | CompanionOptionValues
    | Promise<undefined | CompanionOptionValues>

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

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 feedbacks list

options

options: SomeCompanionFeedbackInputField[]

The input fields for the feedback

OptionalshowInvert

showInvert?: boolean

If undefined or true, Companion will add an 'Inverted' checkbox for your feedback, and handle the logic for you. By setting this to false, you can disable this for your feedback. You should do this if it does not make sense for your feedback.

Optionalsubscribe

subscribe?: (
    feedback: CompanionFeedbackInfo,
    context: CompanionCommonCallbackContext,
) => void | Promise<void>

Called to report the existence of a feedback. Useful to ensure necessary data is loaded

type

type: "boolean"

The type of the feedback

Optionalunsubscribe

unsubscribe?: (
    feedback: CompanionFeedbackInfo,
    context: CompanionCommonCallbackContext,
) => void | Promise<void>

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

Settings

Member Visibility

On This Page

Properties