Interface CompanionAdvancedFeedbackDefinition

The definition of an advanced feedback

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

Hierarchy (View Summary)

Properties

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

Properties

callback

callback: (
    feedback: CompanionFeedbackAdvancedEvent,
    context: CompanionCommonCallbackContext,
) =>
    | CompanionAdvancedFeedbackResult
    | Promise<CompanionAdvancedFeedbackResult>

Called to get the feedback value

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

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: "advanced"

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