Interface CompanionMigrationFeedback

A feedback that could be upgraded

interface CompanionMigrationFeedback {
    controlId: string;
    feedbackId: string;
    id: string;
    isInverted: boolean;
    options: OptionsObject;
    style?: Partial<Partial<CompanionButtonStyleProps>>;
}

Properties

controlId feedbackId id isInverted options style?

Properties

ReadonlycontrolId

controlId: string

The unique id for the location of this feedback

feedbackId

feedbackId: string

The id of the feedback definition

Readonlyid

id: string

The unique id for this feedback

isInverted

isInverted: boolean

Only valid for a boolean feedback. True if this feedback has been inverted inside Companion, you do not have access to this when the feedback is executed.

options

options: OptionsObject

The user selected options for the feedback

Optionalstyle

style?: Partial<Partial<CompanionButtonStyleProps>>

If the feedback is being converted to a boolean feedback, the style can be set here. If it is already a boolean feedback or is a different type of feedback, this will be ignored.

Settings

Member Visibility

On This Page

Properties