ChoiceFactory.List Method

Definition

Namespace:

Microsoft.Bot.Builder.Dialogs.Choices

Assembly:

Microsoft.Bot.Builder.Dialogs.dll

Package:

Microsoft.Bot.Builder.Dialogs v4.22.7

Overloads

List(IList<Choice>, String, String, ChoiceFactoryOptions)	Creates a message activity containing a list of choices that has been formatted as a numbered or bulleted list.
List(IList<String>, String, String, ChoiceFactoryOptions)	Creates a message activity that includes a list of choices formatted as a numbered or bulleted list.

List(IList<Choice>, String, String, ChoiceFactoryOptions)

Creates a message activity containing a list of choices that has been formatted as a numbered or bulleted list.

public static Microsoft.Bot.Schema.Activity List (System.Collections.Generic.IList<Microsoft.Bot.Builder.Dialogs.Choices.Choice> choices, string text = default, string speak = default, Microsoft.Bot.Builder.Dialogs.Choices.ChoiceFactoryOptions options = default);

static member List : System.Collections.Generic.IList<Microsoft.Bot.Builder.Dialogs.Choices.Choice> * string * string * Microsoft.Bot.Builder.Dialogs.Choices.ChoiceFactoryOptions -> Microsoft.Bot.Schema.Activity

Public Shared Function List (choices As IList(Of Choice), Optional text As String = Nothing, Optional speak As String = Nothing, Optional options As ChoiceFactoryOptions = Nothing) As Activity

Parameters

choices

IList<Choice>

The list of choices to render.

text

String

Optional, text of the message.

speak

String

Optional, SSML text to be spoken by the bot on a speech-enabled channel.

options

ChoiceFactoryOptions

Optional, formatting options to tweak the rendering of the list.

Returns

Activity

An activity with choices as a numbered or bulleted list.

List(IList<String>, String, String, ChoiceFactoryOptions)

Creates a message activity that includes a list of choices formatted as a numbered or bulleted list.

public static Microsoft.Bot.Schema.Activity List (System.Collections.Generic.IList<string> choices, string text = default, string speak = default, Microsoft.Bot.Builder.Dialogs.Choices.ChoiceFactoryOptions options = default);

static member List : System.Collections.Generic.IList<string> * string * string * Microsoft.Bot.Builder.Dialogs.Choices.ChoiceFactoryOptions -> Microsoft.Bot.Schema.Activity

Public Shared Function List (choices As IList(Of String), Optional text As String = Nothing, Optional speak As String = Nothing, Optional options As ChoiceFactoryOptions = Nothing) As Activity

Parameters

choices

IList<String>

The list of choices to include.

text

String

Optional, the text of the message to send.

speak

String

Optional, the text to be spoken by your bot on a speech-enabled channel.

options

ChoiceFactoryOptions

Optional, the formatting options to use when rendering as a list.

Returns

Activity

The created message activity.