InputDescriptor interface
Describes an input for subscriptions.
Properties
| dependency |
The ids of all inputs that the value of this input is dependent on. |
| description | Description of what this input is used for |
| group |
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. |
| has |
If true, the value information for this input is dynamic and should be fetched when the value of dependency inputs change. |
| id | Identifier for the subscription input |
| input |
Mode in which the value of this input should be entered |
| is |
Gets whether this input is confidential, such as for a password or application key |
| name | Localized name which can be shown as a label for the subscription input |
| properties | Custom properties for the input which can be used by the service provider |
| type | Underlying data type for the input value. When this value is specified, InputMode, Validation and Values are optional. |
| use |
Gets whether this input is included in the default generated action description. |
| validation | Information to use to validate this input's value |
| value |
A hint for input value. It can be used in the UI as the input placeholder. |
| values | Information about possible values for this input |
Property Details
dependencyInputIds
The ids of all inputs that the value of this input is dependent on.
dependencyInputIds: string[]Property Value
string[]
description
Description of what this input is used for
description: stringProperty Value
string
groupName
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.
groupName: stringProperty Value
string
hasDynamicValueInformation
If true, the value information for this input is dynamic and should be fetched when the value of dependency inputs change.
hasDynamicValueInformation: booleanProperty Value
boolean
id
Identifier for the subscription input
id: stringProperty Value
string
inputMode
Mode in which the value of this input should be entered
inputMode: InputModeProperty Value
isConfidential
Gets whether this input is confidential, such as for a password or application key
isConfidential: booleanProperty Value
boolean
name
Localized name which can be shown as a label for the subscription input
name: stringProperty Value
string
properties
Custom properties for the input which can be used by the service provider
properties: {[key: string]: any}Property Value
{[key: string]: any}
type
Underlying data type for the input value. When this value is specified, InputMode, Validation and Values are optional.
type: stringProperty Value
string
useInDefaultDescription
Gets whether this input is included in the default generated action description.
useInDefaultDescription: booleanProperty Value
boolean
validation
Information to use to validate this input's value
validation: InputValidationProperty Value
valueHint
A hint for input value. It can be used in the UI as the input placeholder.
valueHint: stringProperty Value
string