Edit

Share via

ChoiceSet class

  • Reference
Package:
botbuilder-dialogs-adaptive

Defines ChoiceSet collection.

Extends

Array<Choice>

Constructors

ChoiceSet(any)

Initializes a new instance of the ChoiceSet class.

Properties

Array

Inherited Properties

length

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Methods

bind(DialogContext, DialogStateManager)

Bind data to template.

Inherited Methods

concat(ConcatArray<Choice>[])

Combines two or more arrays.
concat(T | ConcatArray<T>[])

Combines two or more arrays.
copyWithin(number, number, number)

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
entries()

Returns an iterable of key, value pairs for every entry in the array
every((value: Choice, index: number, array: Choice[]) => unknown, any)

Determines whether all the members of an array satisfy the specified test.
fill(Choice, number, number)

Returns the this object after filling the section identified by start and end with value
filter((value: Choice, index: number, array: Choice[]) => unknown, any)

Returns the elements of an array that meet the condition specified in a callback function.
filter<S>((value: Choice, index: number, array: Choice[]) => boolean, any)

Returns the elements of an array that meet the condition specified in a callback function.
find((value: Choice, index: number, obj: Choice[]) => unknown, any)
find<S>((this: void, value: Choice, index: number, obj: Choice[]) => boolean, any)

Returns the value of the first element in the array where predicate is true, and undefined otherwise.
findIndex((value: Choice, index: number, obj: Choice[]) => unknown, any)

Returns the index of the first element in the array where predicate is true, and -1 otherwise.
forEach((value: Choice, index: number, array: Choice[]) => void, any)

Performs the specified action for each element in an array.
includes(Choice, number)

Determines whether an array includes a certain element, returning true or false as appropriate.
indexOf(Choice, number)

Returns the index of the first occurrence of a value in an array.
join(string)

Adds all the elements of an array separated by the specified separator string.
keys()

Returns an iterable of keys in the array
lastIndexOf(Choice, number)

Returns the index of the last occurrence of a specified value in an array.
map<U>((value: Choice, index: number, array: Choice[]) => U, any)

Calls a defined callback function on each element of an array, and returns an array that contains the results.
pop()

Removes the last element from an array and returns it.
push(Choice[])

Appends new elements to an array, and returns the new length of the array.
reduce((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduce((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, Choice)
reduce<U>((previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, U)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight((previousValue: Choice, currentValue: Choice, currentIndex: number, array: Choice[]) => Choice, Choice)
reduceRight<U>((previousValue: U, currentValue: Choice, currentIndex: number, array: Choice[]) => U, U)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reverse()

Reverses the elements in an Array.
shift()

Removes the first element from an array and returns it.
slice(number, number)

Returns a section of an array.
some((value: Choice, index: number, array: Choice[]) => unknown, any)

Determines whether the specified callback function returns true for any element of an array.
sort((a: Choice, b: Choice) => number)

Sorts an array.
splice(number, number)

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice(number, number, Choice[])

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
toLocaleString()

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
toString()

Returns a string representation of an array.
unshift(Choice[])

Inserts new elements at the start of an array.
values()

Returns an iterable of values in the array

Constructor Details

ChoiceSet(any)

Initializes a new instance of the ChoiceSet class.

new ChoiceSet(obj: any)

Parameters

obj

any

Choice values.

Property Details

Array 

static Array: ArrayConstructor

Property Value

ArrayConstructor

Inherited Property Details

length

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

length: number

Property Value

number

Inherited From Array.length

Method Details

bind(DialogContext, DialogStateManager)

Bind data to template.

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

Parameters

dialogContext

DialogContext

DialogContext

data

DialogStateManager

Data to bind to.

Returns

Promise<ChoiceSet>

Data binded ChoiceSet.

Inherited Method Details

concat(ConcatArray<Choice>[])

Combines two or more arrays.

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

Parameters

items

ConcatArray<Choice>[]

Additional items to add to the end of array1.

Returns

Choice[]

Inherited From Array.concat

concat(T | ConcatArray<T>[])

Combines two or more arrays.

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

Parameters

items

T | ConcatArray<T>[]

Additional items to add to the end of array1.

Returns

Choice[]

Inherited From Array.concat

copyWithin(number, number, number)

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

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

Parameters

target

number

If target is negative, it is treated as length+target where length is the length of the array.

start

number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end

number

If not specified, length of the this object is used as its default value.

Returns

this

Inherited From Array.copyWithin

entries()

Returns an iterable of key, value pairs for every entry in the array

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

Returns

IterableIterator<[number, Choice]>

Inherited From Array.entries

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

Determines whether all the members of an array satisfy the specified test.

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

Parameters

callbackfn

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

A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

thisArg

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited From Array.every

fill(Choice, number, number)

Returns the this object after filling the section identified by start and end with value

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

Parameters

value

Choice

value to fill array section with

start

number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end

number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited From Array.fill

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

Returns the elements of an array that meet the condition specified in a callback function.

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

Parameters

callbackfn

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

A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

thisArg

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

Choice[]

Inherited From Array.filter

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

Returns the elements of an array that meet the condition specified in a callback function.

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

Parameters

callbackfn

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

A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

thisArg

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited From 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

Parameters

predicate

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

thisArg

any

Returns

Choice | undefined

Inherited From Array.find

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

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

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

Parameters

predicate

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

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

S | undefined

Inherited From Array.find

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

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

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

Parameters

predicate

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

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited From Array.findIndex

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

Performs the specified action for each element in an array.

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

Parameters

callbackfn

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

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Inherited From Array.forEach

includes(Choice, number)

Determines whether an array includes a certain element, returning true or false as appropriate.

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

Parameters

searchElement

Choice

The element to search for.

fromIndex

number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited From Array.includes

indexOf(Choice, number)

Returns the index of the first occurrence of a value in an array.

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

Parameters

searchElement

Choice

The value to locate in the array.

fromIndex

number

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited From Array.indexOf

join(string)

Adds all the elements of an array separated by the specified separator string.

function join(separator?: string): string

Parameters

separator

string

A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns

string

Inherited From Array.join

keys()

Returns an iterable of keys in the array

function keys(): IterableIterator<number>

Returns

IterableIterator<number>

Inherited From Array.keys

lastIndexOf(Choice, number)

Returns the index of the last occurrence of a specified value in an array.

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

Parameters

searchElement

Choice

The value to locate in the array.

fromIndex

number

The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited From Array.lastIndexOf

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

Calls a defined callback function on each element of an array, and returns an array that contains the results.

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

Parameters

callbackfn

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

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited From Array.map

pop()

Removes the last element from an array and returns it.

function pop(): Choice | undefined

Returns

Choice | undefined

Inherited From Array.pop

push(Choice[])

Appends new elements to an array, and returns the new length of the array.

function push(items: Choice[]): number

Parameters

items

Choice[]

New elements of the Array.

Returns

number

Inherited From Array.push

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

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

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

Parameters

callbackfn

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

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

Choice

Inherited From 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

Parameters

callbackfn

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

initialValue

Choice

Returns

Choice

Inherited From Array.reduce

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

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

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

Parameters

callbackfn

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

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited From Array.reduce

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

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

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

Parameters

callbackfn

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

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

Choice

Inherited From 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

Parameters

callbackfn

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

initialValue

Choice

Returns

Choice

Inherited From Array.reduceRight

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

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

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

Parameters

callbackfn

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

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited From Array.reduceRight

reverse()

Reverses the elements in an Array.

function reverse(): Choice[]

Returns

Choice[]

Inherited From Array.reverse

shift()

Removes the first element from an array and returns it.

function shift(): Choice | undefined

Returns

Choice | undefined

Inherited From Array.shift

slice(number, number)

Returns a section of an array.

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

Parameters

start

number

The beginning of the specified portion of the array.

end

number

The end of the specified portion of the array.

Returns

Choice[]

Inherited From Array.slice

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

Determines whether the specified callback function returns true for any element of an array.

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

Parameters

callbackfn

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

A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

thisArg

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited From Array.some

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

Sorts an array.

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

Parameters

compareFn

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

The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns

this

Inherited From Array.sort

splice(number, number)

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

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

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove.

Returns

Choice[]

Inherited From Array.splice

splice(number, number, Choice[])

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

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

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove.

items

Choice[]

Elements to insert into the array in place of the deleted elements.

Returns

Choice[]

Inherited From Array.splice

toLocaleString()

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

function toLocaleString(): string

Returns

string

Inherited From Array.toLocaleString

toString()

Returns a string representation of an array.

function toString(): string

Returns

string

Inherited From Array.toString

unshift(Choice[])

Inserts new elements at the start of an array.

function unshift(items: Choice[]): number

Parameters

items

Choice[]

Elements to insert at the start of the Array.

Returns

number

Inherited From Array.unshift

values()

Returns an iterable of values in the array

function values(): IterableIterator<Choice>

Returns

IterableIterator<Choice>

Inherited From Array.values