InputDescriptor interface
Описывает входные данные для подписок.
Свойства
| dependency |
Идентификаторы всех входных данных, от которые зависит значение этого ввода. |
| description | Описание того, для чего используются эти входные данные |
| group |
Локализованное имя группы, к которому принадлежит этот вход, и может отображаться как заголовок контейнера, который будет включать все входные данные в группе. |
| has |
Если значение имеет значение true, данные о значении этого входного значения являются динамическими и должны быть извлекаемы при изменении значения входных данных зависимостей. |
| id | Идентификатор входных данных подписки |
| input |
Режим, в котором должно быть введено значение этого входного значения. |
| is |
Получает, является ли этот вход конфиденциальным, например для пароля или ключа приложения. |
| name | Локализованное имя, которое может отображаться как метка для входных данных подписки |
| properties | Настраиваемые свойства для входных данных, которые могут использоваться поставщиком услуг |
| type | Базовый тип данных для входного значения. Если это значение указано, InputMode, Validation и Values необязательны. |
| use |
Возвращает значение, включенное в описание действия, созданного по умолчанию. |
| validation | Сведения, используемые для проверки значения входных данных |
| value |
Указание входного значения. Его можно использовать в пользовательском интерфейсе в качестве заполнителя входных данных. |
| values | Сведения о возможных значениях для этих входных данных |
Сведения о свойстве
dependencyInputIds
Идентификаторы всех входных данных, от которые зависит значение этого ввода.
dependencyInputIds: string[]
Значение свойства
string[]
description
Описание того, для чего используются эти входные данные
description: string
Значение свойства
string
groupName
Локализованное имя группы, к которому принадлежит этот вход, и может отображаться как заголовок контейнера, который будет включать все входные данные в группе.
groupName: string
Значение свойства
string
hasDynamicValueInformation
Если значение имеет значение true, данные о значении этого входного значения являются динамическими и должны быть извлекаемы при изменении значения входных данных зависимостей.
hasDynamicValueInformation: boolean
Значение свойства
boolean
id
Идентификатор входных данных подписки
id: string
Значение свойства
string
inputMode
Режим, в котором должно быть введено значение этого входного значения.
inputMode: InputMode
Значение свойства
isConfidential
Получает, является ли этот вход конфиденциальным, например для пароля или ключа приложения.
isConfidential: boolean
Значение свойства
boolean
name
Локализованное имя, которое может отображаться как метка для входных данных подписки
name: string
Значение свойства
string
properties
Настраиваемые свойства для входных данных, которые могут использоваться поставщиком услуг
properties: {[key: string]: any}
Значение свойства
{[key: string]: any}
type
Базовый тип данных для входного значения. Если это значение указано, InputMode, Validation и Values необязательны.
type: string
Значение свойства
string
useInDefaultDescription
Возвращает значение, включенное в описание действия, созданного по умолчанию.
useInDefaultDescription: boolean
Значение свойства
boolean
validation
Сведения, используемые для проверки значения входных данных
validation: InputValidation
Значение свойства
valueHint
Указание входного значения. Его можно использовать в пользовательском интерфейсе в качестве заполнителя входных данных.
valueHint: string
Значение свойства
string
values
Сведения о возможных значениях для этих входных данных
values: InputValues