@companion-module/base
    Preparing search index...

    Interface CompanionFeedbackDefinitionBase

    The common definition of a feedback

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

    Hierarchy (View Summary)

    Index

    Properties

    description? learn? learnTimeout? name options subscribe? type unsubscribe?

    Properties

    description?: string

    Additional description of the feedback

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

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

    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: string

    Name to show in the feedbacks list

    options: SomeCompanionFeedbackInputField[]

    The input fields for the feedback

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

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

    type: "boolean" | "value" | "advanced"
    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