ChoiceSet class

Pacote:

botbuilder-dialogs-adaptive

Define a coleção ChoiceSet.

Extends

Array<Choice>

Construtores

ChoiceSet(any)

Inicializa uma nova instância da classe ChoiceSet.

Propriedades

Array

Propriedades herdadas

length

Obtém ou define o comprimento da matriz. Esse é um número um maior do que o elemento mais alto definido em uma matriz.

Métodos

bind(DialogContext, DialogStateManager)

Associar dados ao modelo.

Métodos herdados

concat(ConcatArray<Choice>[])	Combina duas ou mais matrizes.
concat(T | ConcatArray<T>[])	Combina duas ou mais matrizes.
copyWithin(number, number, number)	Retorna o objeto depois de copiar uma seção da matriz identificada por início e término para a mesma matriz começando no destino de posição
entries()	Retorna um iterável de chave, pares de valor para cada entrada na matriz
every((value: Choice, index: number, array: Choice[]) => unknown, any)	Determina se todos os membros de uma matriz atendem ao teste especificado.
fill(Choice, number, number)	Retorna o objeto depois de preencher a seção identificada por início e término com valor
filter((value: Choice, index: number, array: Choice[]) => unknown, any)	Retorna os elementos de uma matriz que atendem à condição especificada em uma função de retorno de chamada.
filter<S>((value: Choice, index: number, array: Choice[]) => boolean, any)	Retorna os elementos de uma matriz que atendem à condição especificada em uma função de retorno de chamada.
find((value: Choice, index: number, obj: Choice[]) => unknown, any)
find<S>((this: void, value: Choice, index: number, obj: Choice[]) => boolean, any)	Retorna o valor do primeiro elemento na matriz em que o predicado é verdadeiro e indefinido de outra forma.
findIndex((value: Choice, index: number, obj: Choice[]) => unknown, any)	Retorna o índice do primeiro elemento na matriz em que o predicado é verdadeiro e -1 caso contrário.
forEach((value: Choice, index: number, array: Choice[]) => void, any)	Executa a ação especificada para cada elemento em uma matriz.
includes(Choice, number)	Determina se uma matriz inclui um determinado elemento, retornando true ou false conforme apropriado.
indexOf(Choice, number)	Retorna o índice da primeira ocorrência de um valor em uma matriz.
join(string)	Adiciona todos os elementos de uma matriz separada pela cadeia de caracteres do separador especificada.
keys()	Retorna uma iterável de chaves na matriz
lastIndexOf(Choice, number)	Retorna o índice da última ocorrência de um valor especificado em uma matriz.
map<U>((value: Choice, index: number, array: Choice[]) => U, any)	Chama uma função de retorno de chamada definida em cada elemento de uma matriz e retorna uma matriz que contém os resultados.
pop()	Remove o último elemento de uma matriz e o retorna.
push(Choice[])	Acrescenta novos elementos a uma matriz e retorna o novo comprimento da matriz.
reduce((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice)	Chama a função de retorno de chamada especificada para todos os elementos em uma matriz. O valor retornado da função de retorno de chamada é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de retorno de chamada.
reduce((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, Choice)
reduce<U>((previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, U)	Chama a função de retorno de chamada especificada para todos os elementos em uma matriz. O valor retornado da função de retorno de chamada é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de retorno de chamada.
reduceRight((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice)	Chama a função de retorno de chamada especificada para todos os elementos em uma matriz, em ordem decrescente. O valor retornado da função de retorno de chamada é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de retorno de chamada.
reduceRight((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, Choice)
reduceRight<U>((previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, U)	Chama a função de retorno de chamada especificada para todos os elementos em uma matriz, em ordem decrescente. O valor retornado da função de retorno de chamada é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de retorno de chamada.
reverse()	Inverte os elementos em uma Matriz.
shift()	Remove o primeiro elemento de uma matriz e o retorna.
slice(number, number)	Retorna uma seção de uma matriz.
some((value: Choice, index: number, array: Choice[]) => unknown, any)	Determina se a função de retorno de chamada especificada retorna true para qualquer elemento de uma matriz.
sort((a: Choice, b: Choice) => number)	Classifica uma matriz.
splice(number, number)	Remove elementos de uma matriz e, se necessário, insere novos elementos em seu lugar, retornando os elementos excluídos.
splice(number, number, Choice[])	Remove elementos de uma matriz e, se necessário, insere novos elementos em seu lugar, retornando os elementos excluídos.
toLocaleString()	Retorna uma representação de cadeia de caracteres de uma matriz. Os elementos são convertidos em cadeia de caracteres usando seus métodos toLocalString.
toString()	Retorna uma representação de cadeia de caracteres de uma matriz.
unshift(Choice[])	Insere novos elementos no início de uma matriz.
values()	Retorna um iterável de valores na matriz

Detalhes do construtor

ChoiceSet(any)

Inicializa uma nova instância da classe ChoiceSet.

new ChoiceSet(obj: any)

Parâmetros

obj

any

Valores de escolha.

Detalhes da propriedade

Array

static Array: ArrayConstructor

Valor da propriedade

ArrayConstructor

Detalhes das propriedades herdadas

length

Obtém ou define o comprimento da matriz. Esse é um número um maior do que o elemento mais alto definido em uma matriz.

length: number

Valor da propriedade

number

Herdado de Array.length

Detalhes do método

bind(DialogContext, DialogStateManager)

Associar dados ao modelo.

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

Parâmetros

dialogContext

DialogContext

DialogContext

data

DialogStateManager

Dados a serem associados.

Retornos

Promise<ChoiceSet>

ChoiceSet associado a dados.

Detalhes do método herdado

concat(ConcatArray<Choice>[])

Combina duas ou mais matrizes.

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

Parâmetros

items

ConcatArray<Choice>[]

Itens adicionais a serem adicionados ao final da matriz1.

Retornos

Choice[]

herdado de Array.concat

concat(T | ConcatArray<T>[])

Combina duas ou mais matrizes.

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

Parâmetros

items

T | ConcatArray<T>[]

Itens adicionais a serem adicionados ao final da matriz1.

Retornos

Choice[]

herdado de Array.concat

copyWithin(number, number, number)

Retorna o objeto depois de copiar uma seção da matriz identificada por início e término para a mesma matriz começando no destino de posição

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

Parâmetros

target

number

Se o destino for negativo, ele será tratado como comprimento+destino, onde o comprimento é o comprimento da matriz.

start

number

Se o início for negativo, ele será tratado como length+start. Se o final for negativo, ele será tratado como length+end.

end

number

Se não for especificado, o comprimento desse objeto será usado como seu valor padrão.

Retornos

this

Herdado de Array.copyWithin

entries()

Retorna um iterável de chave, pares de valor para cada entrada na matriz

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

Retornos

IterableIterator<[number, Choice]>

Herdado de Array.entries

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

Determina se todos os membros de uma matriz atendem ao teste especificado.

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

Parâmetros

callbackfn

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

Uma função que aceita até três argumentos. Cada método chama a função callbackfn para cada elemento na matriz1 até que o callbackfn retorne false ou até o final da matriz.

thisArg

any

Um objeto ao qual essa palavra-chave pode se referir na função callbackfn. Se thisArg for omitido, undefined será usado como esse valor.

Retornos

boolean

herdado de Array.every

fill(Choice, number, number)

Retorna o objeto depois de preencher a seção identificada por início e término com valor

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

Parâmetros

value

Choice

valor para preencher a seção matriz com

start

number

para começar a preencher a matriz. Se o início for negativo, ele será tratado como length+start, onde o comprimento é o comprimento da matriz.

end

number

índice para parar de preencher a matriz em. Se o final for negativo, ele será tratado como length+end.

Retornos

this

herdado de Array.fill

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

Retorna os elementos de uma matriz que atendem à condição especificada em uma função de retorno de chamada.

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

Parâmetros

callbackfn

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

Uma função que aceita até três argumentos. O método de filtro chama a função callbackfn uma vez para cada elemento na matriz.

thisArg

any

Um objeto ao qual essa palavra-chave pode se referir na função callbackfn. Se thisArg for omitido, undefined será usado como esse valor.

Retornos

Choice[]

herdado de Array.filter

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

Retorna os elementos de uma matriz que atendem à condição especificada em uma função de retorno de chamada.

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

Parâmetros

callbackfn

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

Uma função que aceita até três argumentos. O método de filtro chama a função callbackfn uma vez para cada elemento na matriz.

thisArg

any

Um objeto ao qual essa palavra-chave pode se referir na função callbackfn. Se thisArg for omitido, undefined será usado como esse valor.

Retornos

S[]

herdado de Array.filter

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

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

Parâmetros

predicate

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

thisArg

any

Retornos

Choice | undefined

Herdado de Array.find

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

Retorna o valor do primeiro elemento na matriz em que o predicado é verdadeiro e indefinido de outra forma.

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

Parâmetros

predicate

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

localize o predicado de chamadas uma vez para cada elemento da matriz, em ordem crescente, até encontrar um em que o predicado retorne verdadeiro. Se esse elemento for encontrado, localize imediatamente esse valor de elemento. Caso contrário, localizar retornará indefinido.

thisArg

any

Se fornecido, ele será usado como o valor para cada invocação de predicado. Se não for fornecido, indefinido será usado em vez disso.

Retornos

S | undefined

Herdado de Array.find

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

Retorna o índice do primeiro elemento na matriz em que o predicado é verdadeiro e -1 caso contrário.

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

Parâmetros

predicate

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

localize o predicado de chamadas uma vez para cada elemento da matriz, em ordem crescente, até encontrar um em que o predicado retorne verdadeiro. Se esse elemento for encontrado, findIndex retornará imediatamente esse índice de elemento. Caso contrário, findIndex retornará -1.

thisArg

any

Se fornecido, ele será usado como o valor para cada invocação de predicado. Se não for fornecido, indefinido será usado em vez disso.

Retornos

number

Herdado de Array.findIndex

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

Executa a ação especificada para cada elemento em uma matriz.

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

Parâmetros

callbackfn

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

Uma função que aceita até três argumentos. forEach chama a função callbackfn uma vez para cada elemento na matriz.

thisArg

any

Um objeto ao qual essa palavra-chave pode se referir na função callbackfn. Se thisArg for omitido, undefined será usado como esse valor.

herdado de Array.forEach

includes(Choice, number)

Determina se uma matriz inclui um determinado elemento, retornando true ou false conforme apropriado.

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

Parâmetros

searchElement

Choice

O elemento a ser pesquisado.

fromIndex

number

A posição nessa matriz na qual começar a pesquisar searchElement.

Retornos

boolean

Herdado de Array.includes

indexOf(Choice, number)

Retorna o índice da primeira ocorrência de um valor em uma matriz.

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

Parâmetros

searchElement

Choice

O valor a ser localizado na matriz.

fromIndex

number

O índice de matriz no qual iniciar a pesquisa. Se fromIndex for omitido, a pesquisa será iniciada no índice 0.

Retornos

number

Herdado de Array.indexOf

join(string)

Adiciona todos os elementos de uma matriz separada pela cadeia de caracteres do separador especificada.

function join(separator?: string): string

Parâmetros

separator

string

Uma cadeia de caracteres usada para separar um elemento de uma matriz da próxima na cadeia de caracteres resultante. Se omitido, os elementos da matriz serão separados com uma vírgula.

Retornos

string

Herdado de Array.join

keys()

Retorna uma iterável de chaves na matriz

function keys(): IterableIterator<number>

Retornos

IterableIterator<number>

herdado de Array.keys

lastIndexOf(Choice, number)

Retorna o índice da última ocorrência de um valor especificado em uma matriz.

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

Parâmetros

searchElement

Choice

O valor a ser localizado na matriz.

fromIndex

number

O índice de matriz no qual iniciar a pesquisa. Se fromIndex for omitido, a pesquisa será iniciada no último índice da matriz.

Retornos

number

herdado de Array.lastIndexOf

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

Chama uma função de retorno de chamada definida em cada elemento de uma matriz e retorna uma matriz que contém os resultados.

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

Parâmetros

callbackfn

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

Uma função que aceita até três argumentos. O método de mapa chama a função callbackfn uma vez para cada elemento na matriz.

thisArg

any

Um objeto ao qual essa palavra-chave pode se referir na função callbackfn. Se thisArg for omitido, undefined será usado como esse valor.

Retornos

U[]

herdado de Array.map

pop()

Remove o último elemento de uma matriz e o retorna.

function pop(): Choice | undefined

Retornos

Choice | undefined

Herdado de Array.pop

push(Choice[])

Acrescenta novos elementos a uma matriz e retorna o novo comprimento da matriz.

function push(items: Choice[]): number

Parâmetros

items

Choice[]

Novos elementos da Matriz.

Retornos

number

herdado de Array.push

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

Chama a função de retorno de chamada especificada para todos os elementos em uma matriz. O valor retornado da função de retorno de chamada é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de retorno de chamada.

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

Parâmetros

callbackfn

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

Uma função que aceita até quatro argumentos. O método de redução chama a função callbackfn uma vez para cada elemento na matriz.

Retornos

Choice

herdado de Array.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

Parâmetros

callbackfn

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

initialValue

Choice

Retornos

Choice

herdado de Array.reduce

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

Chama a função de retorno de chamada especificada para todos os elementos em uma matriz. O valor retornado da função de retorno de chamada é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de retorno de chamada.

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

Parâmetros

callbackfn

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

Uma função que aceita até quatro argumentos. O método de redução chama a função callbackfn uma vez para cada elemento na matriz.

initialValue

U

Se initialValue for especificado, ele será usado como o valor inicial para iniciar o acúmulo. A primeira chamada para a função callbackfn fornece esse valor como um argumento em vez de um valor de matriz.

Retornos

U

herdado de Array.reduce

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

Chama a função de retorno de chamada especificada para todos os elementos em uma matriz, em ordem decrescente. O valor retornado da função de retorno de chamada é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de retorno de chamada.

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

Parâmetros

callbackfn

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

Uma função que aceita até quatro argumentos. O método reduceRight chama a função callbackfn uma vez para cada elemento na matriz.

Retornos

Choice

herdado de Array.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

Parâmetros

callbackfn

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

initialValue

Choice

Retornos

Choice

herdado de Array.reduceRight

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

Chama a função de retorno de chamada especificada para todos os elementos em uma matriz, em ordem decrescente. O valor retornado da função de retorno de chamada é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de retorno de chamada.

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

Parâmetros

callbackfn

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

Uma função que aceita até quatro argumentos. O método reduceRight chama a função callbackfn uma vez para cada elemento na matriz.

initialValue

U

Se initialValue for especificado, ele será usado como o valor inicial para iniciar o acúmulo. A primeira chamada para a função callbackfn fornece esse valor como um argumento em vez de um valor de matriz.

Retornos

U

herdado de Array.reduceRight

reverse()

Inverte os elementos em uma Matriz.

function reverse(): Choice[]

Retornos

Choice[]

Herdado de Array.reverse

shift()

Remove o primeiro elemento de uma matriz e o retorna.

function shift(): Choice | undefined

Retornos

Choice | undefined

herdado de Array.shift

slice(number, number)

Retorna uma seção de uma matriz.

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

Parâmetros

start

number

O início da parte especificada da matriz.

end

number

O final da parte especificada da matriz.

Retornos

Choice[]

Herdado de Array.slice

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

Determina se a função de retorno de chamada especificada retorna true para qualquer elemento de uma matriz.

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

Parâmetros

callbackfn

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

Uma função que aceita até três argumentos. O método alguns chama a função callbackfn para cada elemento na matriz1 até que o callbackfn retorne true ou até o final da matriz.

thisArg

any

Um objeto ao qual essa palavra-chave pode se referir na função callbackfn. Se thisArg for omitido, undefined será usado como esse valor.

Retornos

boolean

herdado de Array.some

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

Classifica uma matriz.

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

Parâmetros

compareFn

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

O nome da função usada para determinar a ordem dos elementos. Se omitidos, os elementos serão classificados em ordem crescente de caracteres ASCII.

Retornos

this

Herdado de Array.sort

splice(number, number)

Remove elementos de uma matriz e, se necessário, insere novos elementos em seu lugar, retornando os elementos excluídos.

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

Parâmetros

start

number

O local baseado em zero na matriz da qual começar a remover elementos.

deleteCount

number

O número de elementos a serem removidos.

Retornos

Choice[]

Herdado de Array.splice

splice(number, number, Choice[])

Remove elementos de uma matriz e, se necessário, insere novos elementos em seu lugar, retornando os elementos excluídos.

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

Parâmetros

start

number

O local baseado em zero na matriz da qual começar a remover elementos.

deleteCount

number

O número de elementos a serem removidos.

items

Choice[]

Elementos a serem inseridos na matriz no lugar dos elementos excluídos.

Retornos

Choice[]

Herdado de Array.splice

toLocaleString()

Retorna uma representação de cadeia de caracteres de uma matriz. Os elementos são convertidos em cadeia de caracteres usando seus métodos toLocalString.

function toLocaleString(): string

Retornos

string

herdado de Array.toLocaleString

toString()

Retorna uma representação de cadeia de caracteres de uma matriz.

function toString(): string

Retornos

string

herdado de Array.toString

unshift(Choice[])

Insere novos elementos no início de uma matriz.

function unshift(items: Choice[]): number

Parâmetros

items

Choice[]

Elementos a serem inseridos no início da Matriz.

Retornos

number

herdado de Array.unshift

values()

Retorna um iterável de valores na matriz

function values(): IterableIterator<Choice>

Retornos

IterableIterator<Choice>

Herdado de Array.values