Interface CompanionFeedbackAdvancedEvent

Extended information for execution of an advanced feedback

interface CompanionFeedbackAdvancedEvent {
    controlId: string;
    feedbackId: string;
    id: string;
    image?: {
        height: number;
        width: number;
    };
    options: CompanionOptionValues;
    type: "boolean" | "advanced";
}

Hierarchy (view full)

Properties

controlId feedbackId id image? options type

Properties

ReadonlycontrolId

controlId: string

The unique id for the location of this feedback

ReadonlyfeedbackId

feedbackId: string

The id of the feedback definition

Readonlyid

id: string

The unique id for this feedback

Optional Readonlyimage

image?: {
    height: number;
    width: number;
}

If control supports an imageBuffer, the dimensions the buffer should be

Readonlyoptions

options: CompanionOptionValues

The user selected options for the feedback

Readonlytype

type: "boolean" | "advanced"

The type of the feedback

Settings

Member Visibility

On This Page

Properties