Interface InputDescriptor

Describes an input for subscriptions.

interface InputDescriptor {
    dependencyInputIds: string[];
    description: string;
    groupName: string;
    hasDynamicValueInformation: boolean;
    id: string;
    inputMode: InputMode;
    isConfidential: boolean;
    name: string;
    useInDefaultDescription: boolean;
    validation: InputValidation;
    valueHint: string;
    values: InputValues;
}

Properties

dependencyInputIds description groupName hasDynamicValueInformation id inputMode isConfidential name useInDefaultDescription validation valueHint values

Properties

dependencyInputIds

dependencyInputIds: string[]

The ids of all inputs that the value of this input is dependent on.

description

description: string

Description of what this input is used for

groupName

groupName: string

The group localized name to which this input belongs and can be shown as a header for the container that will include all the inputs in the group.

hasDynamicValueInformation

hasDynamicValueInformation: boolean

If true, the value information for this input is dynamic and should be fetched when the value of dependency inputs change.

id

id: string

Identifier for the subscription input

inputMode

inputMode: InputMode

Mode in which the value of this input should be entered

isConfidential

isConfidential: boolean

Gets whether this input is confidential, such as for a password or application key

name

name: string

Localized name which can be shown as a label for the subscription input

useInDefaultDescription

useInDefaultDescription: boolean

Gets whether this input is included in the default generated action description.

validation

validation: InputValidation

Information to use to validate this input's value

valueHint

valueHint: string

A hint for input value. It can be used in the UI as the input placeholder.

values

values: InputValues

Information about possible values for this input

Settings

Member Visibility

On This Page

Properties