ChoiceSet class

Пакет:

botbuilder-dialogs-adaptive

Определяет коллекцию ChoiceSet.

Extends

Array<Choice>

Конструкторы

ChoiceSet(any)

Инициализирует новый экземпляр класса ChoiceSet.

Свойства

Array

Унаследованные свойства

length

Возвращает или задает длину массива. Это число один выше, чем самый высокий элемент, определенный в массиве.

Методы

bind(DialogContext, DialogStateManager)

Привязка данных к шаблону.

Наследуемые методы

concat(ConcatArray<Choice>[])	Объединяет два или более массивов.
concat(T | ConcatArray<T>[])	Объединяет два или более массивов.
copyWithin(number, number, number)	Возвращает этот объект после копирования раздела массива, определяемого по началу и окончанию к тому же массиву, начиная с целевого объекта позиции.
entries()	Возвращает итератор ключей, пары значений для каждой записи в массиве
every((value: Choice, index: number, array: Choice[]) => unknown, any)	Определяет, соответствуют ли все члены массива указанному тесту.
fill(Choice, number, number)	Возвращает этот объект после заполнения раздела, определяемого по началу и концу со значением
filter((value: Choice, index: number, array: Choice[]) => unknown, any)	Возвращает элементы массива, соответствующего условию, указанному в функции обратного вызова.
filter<S>((value: Choice, index: number, array: Choice[]) => boolean, any)	Возвращает элементы массива, соответствующего условию, указанному в функции обратного вызова.
find((value: Choice, index: number, obj: Choice[]) => unknown, any)
find<S>((this: void, value: Choice, index: number, obj: Choice[]) => boolean, any)	Возвращает значение первого элемента в массиве, где предикат имеет значение true, и не определено в противном случае.
findIndex((value: Choice, index: number, obj: Choice[]) => unknown, any)	Возвращает индекс первого элемента в массиве, где предикат имеет значение true, и -1 в противном случае.
forEach((value: Choice, index: number, array: Choice[]) => void, any)	Выполняет указанное действие для каждого элемента в массиве.
includes(Choice, number)	Определяет, включает ли массив определенный элемент, возвращая значение true или false в соответствии с соответствующим образом.
indexOf(Choice, number)	Возвращает индекс первого вхождения значения в массиве.
join(string)	Добавляет все элементы массива, разделенные указанной строкой разделителя.
keys()	Возвращает итератор ключей в массиве
lastIndexOf(Choice, number)	Возвращает индекс последнего вхождения указанного значения в массиве.
map<U>((value: Choice, index: number, array: Choice[]) => U, any)	Вызывает определенную функцию обратного вызова для каждого элемента массива и возвращает массив, содержащий результаты.
pop()	Удаляет последний элемент из массива и возвращает его.
push(Choice[])	Добавляет новые элементы в массив и возвращает новую длину массива.
reduce((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice)	Вызывает указанную функцию обратного вызова для всех элементов в массиве. Возвращаемое значение функции обратного вызова является накопленным результатом и предоставляется в качестве аргумента в следующем вызове функции обратного вызова.
reduce((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, Choice)
reduce<U>((previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, U)	Вызывает указанную функцию обратного вызова для всех элементов в массиве. Возвращаемое значение функции обратного вызова является накопленным результатом и предоставляется в качестве аргумента в следующем вызове функции обратного вызова.
reduceRight((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice)	Вызывает указанную функцию обратного вызова для всех элементов массива в порядке убывания. Возвращаемое значение функции обратного вызова является накопленным результатом и предоставляется в качестве аргумента в следующем вызове функции обратного вызова.
reduceRight((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, Choice)
reduceRight<U>((previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, U)	Вызывает указанную функцию обратного вызова для всех элементов массива в порядке убывания. Возвращаемое значение функции обратного вызова является накопленным результатом и предоставляется в качестве аргумента в следующем вызове функции обратного вызова.
reverse()	Отменяет элементы в массиве.
shift()	Удаляет первый элемент из массива и возвращает его.
slice(number, number)	Возвращает раздел массива.
some((value: Choice, index: number, array: Choice[]) => unknown, any)	Определяет, возвращает ли указанная функция обратного вызова значение true для любого элемента массива.
sort((a: Choice, b: Choice) => number)	Сортирует массив.
splice(number, number)	Удаляет элементы из массива и при необходимости вставляет новые элементы в их место, возвращая удаленные элементы.
splice(number, number, Choice[])	Удаляет элементы из массива и при необходимости вставляет новые элементы в их место, возвращая удаленные элементы.
toLocaleString()	Возвращает строковое представление массива. Элементы преобразуются в строку с помощью методов toLocalString.
toString()	Возвращает строковое представление массива.
unshift(Choice[])	Вставляет новые элементы в начало массива.
values()	Возвращает итератор значений в массиве

Сведения о конструкторе

ChoiceSet(any)

Инициализирует новый экземпляр класса ChoiceSet.

new ChoiceSet(obj: any)

Параметры

obj

any

Значения выбора.

Сведения о свойстве

Array

static Array: ArrayConstructor

Значение свойства

ArrayConstructor

Сведения об унаследованном свойстве

length

Возвращает или задает длину массива. Это число один выше, чем самый высокий элемент, определенный в массиве.

length: number

Значение свойства

number

наследуется от массива.length

Сведения о методе

bind(DialogContext, DialogStateManager)

Привязка данных к шаблону.

function bind(dialogContext: DialogContext, data?: DialogStateManager): Promise<ChoiceSet>

Параметры

dialogContext

DialogContext

DialogContext

data

DialogStateManager

Данные для привязки.

Возвращаемое значение

Promise<ChoiceSet>

Привязываемый набор данных ChoiceSet.

Сведения о наследуемом методе

concat(ConcatArray<Choice>[])

Объединяет два или более массивов.

function concat(items: ConcatArray<Choice>[]): Choice[]

Параметры

items

ConcatArray<Choice>[]

Дополнительные элементы для добавления в конец массива1.

Возвращаемое значение

Choice[]

наследуется от массива.concat

concat(T | ConcatArray<T>[])

Объединяет два или более массивов.

function concat(items: T | ConcatArray<T>[]): Choice[]

Параметры

items

T | ConcatArray<T>[]

Дополнительные элементы для добавления в конец массива1.

Возвращаемое значение

Choice[]

наследуется от массива.concat

copyWithin(number, number, number)

Возвращает этот объект после копирования раздела массива, определяемого по началу и окончанию к тому же массиву, начиная с целевого объекта позиции.

function copyWithin(target: number, start: number, end?: number): this

Параметры

target

number

Если целевой объект является отрицательным, он обрабатывается как длина и целевой объект, где длина — длина массива.

start

number

Если начало отрицательное, оно рассматривается как длина и начало. Если конец отрицательный, он обрабатывается как длина и конец.

end

number

Если этот объект не указан, длина этого объекта используется в качестве значения по умолчанию.

Возвращаемое значение

this

наследуется от массива.copyWithin

entries()

Возвращает итератор ключей, пары значений для каждой записи в массиве

function entries(): IterableIterator<[number, Choice]>

Возвращаемое значение

IterableIterator<[number, Choice]>

унаследовано от Array.entries

every((value: Choice, index: number, array: Choice[]) => unknown, any)

Определяет, соответствуют ли все члены массива указанному тесту.

function every(callbackfn: (value: Choice, index: number, array: Choice[]) => unknown, thisArg?: any): boolean

Параметры

callbackfn

(value: Choice, index: number, array: Choice[]) => unknown

Функция, принимаюющая до трех аргументов. Каждый метод вызывает функцию callbackfn для каждого элемента в массиве1, пока обратный вызов не возвращает false или до конца массива.

thisArg

any

Объект, к которому это ключевое слово может ссылаться в функции callbackfn. Если параметр thisArg опущен, неопределенный используется в качестве этого значения.

Возвращаемое значение

boolean

наследуется от массива.every

fill(Choice, number, number)

Возвращает этот объект после заполнения раздела, определяемого по началу и концу со значением

function fill(value: Choice, start?: number, end?: number): this

Параметры

value

Choice

значение для заполнения раздела массива

start

number

Индекс, чтобы начать заполнение массива. Если запуск отрицательный, он обрабатывается как длина и начало, где длина — длина массива.

end

number

индекс, чтобы остановить заполнение массива. Если конец отрицательный, он обрабатывается как длина и конец.

Возвращаемое значение

this

унаследован от массива.fill

filter((value: Choice, index: number, array: Choice[]) => unknown, any)

Возвращает элементы массива, соответствующего условию, указанному в функции обратного вызова.

function filter(callbackfn: (value: Choice, index: number, array: Choice[]) => unknown, thisArg?: any): Choice[]

Параметры

callbackfn

(value: Choice, index: number, array: Choice[]) => unknown

Функция, принимаюющая до трех аргументов. Метод фильтра вызывает функцию callbackfn один раз для каждого элемента в массиве.

thisArg

any

Объект, к которому это ключевое слово может ссылаться в функции callbackfn. Если параметр thisArg опущен, неопределенный используется в качестве этого значения.

Возвращаемое значение

Choice[]

наследуется от массива.filter

filter<S>((value: Choice, index: number, array: Choice[]) => boolean, any)

Возвращает элементы массива, соответствующего условию, указанному в функции обратного вызова.

function filter<S>(callbackfn: (value: Choice, index: number, array: Choice[]) => boolean, thisArg?: any): S[]

Параметры

callbackfn

(value: Choice, index: number, array: Choice[]) => boolean

Функция, принимаюющая до трех аргументов. Метод фильтра вызывает функцию callbackfn один раз для каждого элемента в массиве.

thisArg

any

Объект, к которому это ключевое слово может ссылаться в функции callbackfn. Если параметр thisArg опущен, неопределенный используется в качестве этого значения.

Возвращаемое значение

S[]

наследуется от массива.filter

find((value: Choice, index: number, obj: Choice[]) => unknown, any)

function find(predicate: (value: Choice, index: number, obj: Choice[]) => unknown, thisArg?: any): Choice | undefined

Параметры

predicate

(value: Choice, index: number, obj: Choice[]) => unknown

thisArg

any

Возвращаемое значение

Choice | undefined

наследуется от массива.find

find<S>((this: void, value: Choice, index: number, obj: Choice[]) => boolean, any)

Возвращает значение первого элемента в массиве, где предикат имеет значение true, и не определено в противном случае.

function find<S>(predicate: (this: void, value: Choice, index: number, obj: Choice[]) => boolean, thisArg?: any): S | undefined

Параметры

predicate

(this: void, value: Choice, index: number, obj: Choice[]) => boolean

найдите предикат вызовов один раз для каждого элемента массива в порядке возрастания, пока не обнаружит, где предикат возвращает значение true. Если такой элемент найден, найдите сразу же возвращает это значение элемента. В противном случае поиск возвращает неопределенное значение.

thisArg

any

Если оно указано, оно будет использоваться в качестве значения для каждого вызова предиката. Если она не указана, вместо этого используется неопределенная.

Возвращаемое значение

S | undefined

наследуется от массива.find

findIndex((value: Choice, index: number, obj: Choice[]) => unknown, any)

Возвращает индекс первого элемента в массиве, где предикат имеет значение true, и -1 в противном случае.

function findIndex(predicate: (value: Choice, index: number, obj: Choice[]) => unknown, thisArg?: any): number

Параметры

predicate

(value: Choice, index: number, obj: Choice[]) => unknown

найдите предикат вызовов один раз для каждого элемента массива в порядке возрастания, пока не обнаружит, где предикат возвращает значение true. Если такой элемент найден, findIndex немедленно возвращает этот индекс элемента. В противном случае findIndex возвращает -1.

thisArg

any

Если оно указано, оно будет использоваться в качестве значения для каждого вызова предиката. Если она не указана, вместо этого используется неопределенная.

Возвращаемое значение

number

унаследовано от массива.findIndex

forEach((value: Choice, index: number, array: Choice[]) => void, any)

Выполняет указанное действие для каждого элемента в массиве.

function forEach(callbackfn: (value: Choice, index: number, array: Choice[]) => void, thisArg?: any)

Параметры

callbackfn

(value: Choice, index: number, array: Choice[]) => void

Функция, принимаюющая до трех аргументов. forEach вызывает функцию callbackfn один раз для каждого элемента в массиве.

thisArg

any

Объект, к которому это ключевое слово может ссылаться в функции callbackfn. Если параметр thisArg опущен, неопределенный используется в качестве этого значения.

унаследован от массива.forEach

includes(Choice, number)

Определяет, включает ли массив определенный элемент, возвращая значение true или false в соответствии с соответствующим образом.

function includes(searchElement: Choice, fromIndex?: number): boolean

Параметры

searchElement

Choice

Элемент для поиска.

fromIndex

number

Позиция в этом массиве, с которой начинается поиск поискаElement.

Возвращаемое значение

boolean

наследуется от массива.includes

indexOf(Choice, number)

Возвращает индекс первого вхождения значения в массиве.

function indexOf(searchElement: Choice, fromIndex?: number): number

Параметры

searchElement

Choice

Значение, которое нужно найти в массиве.

fromIndex

number

Индекс массива, с которого начинается поиск. Если параметр fromIndex опущен, поиск начинается с индекса 0.

Возвращаемое значение

number

Наследуется от массива.indexOf

join(string)

Добавляет все элементы массива, разделенные указанной строкой разделителя.

function join(separator?: string): string

Параметры

separator

string

Строка, используемая для разделения одного элемента массива от следующего в результирующем строке. Если опущено, элементы массива отделяются запятой.

Возвращаемое значение

string

наследуется от массива.join

keys()

Возвращает итератор ключей в массиве

function keys(): IterableIterator<number>

Возвращаемое значение

IterableIterator<number>

наследуется от Array.keys

lastIndexOf(Choice, number)

Возвращает индекс последнего вхождения указанного значения в массиве.

function lastIndexOf(searchElement: Choice, fromIndex?: number): number

Параметры

searchElement

Choice

Значение, которое нужно найти в массиве.

fromIndex

number

Индекс массива, с которого начинается поиск. Если параметр fromIndex опущен, поиск начинается с последнего индекса в массиве.

Возвращаемое значение

number

унаследован от массива.lastIndexOf

map<U>((value: Choice, index: number, array: Choice[]) => U, any)

Вызывает определенную функцию обратного вызова для каждого элемента массива и возвращает массив, содержащий результаты.

function map<U>(callbackfn: (value: Choice, index: number, array: Choice[]) => U, thisArg?: any): U[]

Параметры

callbackfn

(value: Choice, index: number, array: Choice[]) => U

Функция, принимаюющая до трех аргументов. Метод map вызывает функцию callbackfn один раз для каждого элемента в массиве.

thisArg

any

Объект, к которому это ключевое слово может ссылаться в функции callbackfn. Если параметр thisArg опущен, неопределенный используется в качестве этого значения.

Возвращаемое значение

U[]

Наследуется от массива.map

pop()

Удаляет последний элемент из массива и возвращает его.

function pop(): Choice | undefined

Возвращаемое значение

Choice | undefined

унаследован от массива.pop

push(Choice[])

Добавляет новые элементы в массив и возвращает новую длину массива.

function push(items: Choice[]): number

Параметры

items

Choice[]

Новые элементы массива.

Возвращаемое значение

number

унаследован от массива.push

reduce((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice)

Вызывает указанную функцию обратного вызова для всех элементов в массиве. Возвращаемое значение функции обратного вызова является накопленным результатом и предоставляется в качестве аргумента в следующем вызове функции обратного вызова.

function reduce(callbackfn: (previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice): Choice

Параметры

callbackfn

(previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice

Функция, принимаюющая до четырех аргументов. Метод reduce вызывает функцию callbackfn один раз для каждого элемента в массиве.

Возвращаемое значение

Choice

наследуется от массива.reduce

reduce((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, Choice)

function reduce(callbackfn: (previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, initialValue: Choice): Choice

Параметры

callbackfn

(previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice

initialValue

Choice

Возвращаемое значение

Choice

наследуется от массива.reduce

reduce<U>((previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, U)

Вызывает указанную функцию обратного вызова для всех элементов в массиве. Возвращаемое значение функции обратного вызова является накопленным результатом и предоставляется в качестве аргумента в следующем вызове функции обратного вызова.

function reduce<U>(callbackfn: (previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, initialValue: U): U

Параметры

callbackfn

(previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U

Функция, принимаюющая до четырех аргументов. Метод reduce вызывает функцию callbackfn один раз для каждого элемента в массиве.

initialValue

U

Если задано начальное значение, оно используется в качестве начального значения для запуска накопления. Первый вызов функции callbackfn предоставляет это значение как аргумент вместо значения массива.

Возвращаемое значение

U

наследуется от массива.reduce

reduceRight((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice)

Вызывает указанную функцию обратного вызова для всех элементов массива в порядке убывания. Возвращаемое значение функции обратного вызова является накопленным результатом и предоставляется в качестве аргумента в следующем вызове функции обратного вызова.

function reduceRight(callbackfn: (previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice): Choice

Параметры

callbackfn

(previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice

Функция, принимаюющая до четырех аргументов. Метод reduceRight вызывает функцию callbackfn один раз для каждого элемента в массиве.

Возвращаемое значение

Choice

унаследован от массива.reduceRight

reduceRight((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, Choice)

function reduceRight(callbackfn: (previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, initialValue: Choice): Choice

Параметры

callbackfn

(previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice

initialValue

Choice

Возвращаемое значение

Choice

унаследован от массива.reduceRight

reduceRight<U>((previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, U)

Вызывает указанную функцию обратного вызова для всех элементов массива в порядке убывания. Возвращаемое значение функции обратного вызова является накопленным результатом и предоставляется в качестве аргумента в следующем вызове функции обратного вызова.

function reduceRight<U>(callbackfn: (previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, initialValue: U): U

Параметры

callbackfn

(previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U

Функция, принимаюющая до четырех аргументов. Метод reduceRight вызывает функцию callbackfn один раз для каждого элемента в массиве.

initialValue

U

Если задано начальное значение, оно используется в качестве начального значения для запуска накопления. Первый вызов функции callbackfn предоставляет это значение как аргумент вместо значения массива.

Возвращаемое значение

U

унаследован от массива.reduceRight

reverse()

Отменяет элементы в массиве.

function reverse(): Choice[]

Возвращаемое значение

Choice[]

унаследован от массива.reverse

shift()

Удаляет первый элемент из массива и возвращает его.

function shift(): Choice | undefined

Возвращаемое значение

Choice | undefined

унаследован от массива.shift

slice(number, number)

Возвращает раздел массива.

function slice(start?: number, end?: number): Choice[]

Параметры

start

number

Начало указанной части массива.

end

number

Конец указанной части массива.

Возвращаемое значение

Choice[]

унаследован от массива.slice

some((value: Choice, index: number, array: Choice[]) => unknown, any)

Определяет, возвращает ли указанная функция обратного вызова значение true для любого элемента массива.

function some(callbackfn: (value: Choice, index: number, array: Choice[]) => unknown, thisArg?: any): boolean

Параметры

callbackfn

(value: Choice, index: number, array: Choice[]) => unknown

Функция, принимаюющая до трех аргументов. Некоторый метод вызывает функцию callbackfn для каждого элемента в массиве1, пока callbackfn не возвращает значение true или до конца массива.

thisArg

any

Объект, к которому это ключевое слово может ссылаться в функции callbackfn. Если параметр thisArg опущен, неопределенный используется в качестве этого значения.

Возвращаемое значение

boolean

наследуется от массива.some

sort((a: Choice, b: Choice) => number)

Сортирует массив.

function sort(compareFn?: (a: Choice, b: Choice) => number): this

Параметры

compareFn

(a: Choice, b: Choice) => number

Имя функции, используемой для определения порядка элементов. Если опущено, элементы сортируются по возрастанию, порядок символов ASCII.

Возвращаемое значение

this

наследуется от массива.sort

splice(number, number)

Удаляет элементы из массива и при необходимости вставляет новые элементы в их место, возвращая удаленные элементы.

function splice(start: number, deleteCount?: number): Choice[]

Параметры

start

number

Отсчитывающее от нуля расположение в массиве, с которого начинается удаление элементов.

deleteCount

number

Количество элементов для удаления.

Возвращаемое значение

Choice[]

наследуется от Array.splice

splice(number, number, Choice[])

Удаляет элементы из массива и при необходимости вставляет новые элементы в их место, возвращая удаленные элементы.

function splice(start: number, deleteCount: number, items: Choice[]): Choice[]

Параметры

start

number

Отсчитывающее от нуля расположение в массиве, с которого начинается удаление элементов.

deleteCount

number

Количество элементов для удаления.

items

Choice[]

Элементы для вставки в массив вместо удаленных элементов.

Возвращаемое значение

Choice[]

наследуется от Array.splice

toLocaleString()

Возвращает строковое представление массива. Элементы преобразуются в строку с помощью методов toLocalString.

function toLocaleString(): string

Возвращаемое значение

string

наследуется от массива.toLocaleString

toString()

Возвращает строковое представление массива.

function toString(): string

Возвращаемое значение

string

унаследован от массива.toString

unshift(Choice[])

Вставляет новые элементы в начало массива.

function unshift(items: Choice[]): number

Параметры

items

Choice[]

Элементы для вставки в начале массива.

Возвращаемое значение

number

унаследован от массива.unshift

values()

Возвращает итератор значений в массиве

function values(): IterableIterator<Choice>

Возвращаемое значение

IterableIterator<Choice>

наследуется от массива.values