ChoiceFactory.List Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.Agents.Core.Models.IActivity List(System.Collections.Generic.IList<Microsoft.Agents.Builder.Dialogs.Choices.Choice> choices, string text = default, string speak = default, Microsoft.Agents.Builder.Dialogs.Choices.ChoiceFactoryOptions options = default);static member List : System.Collections.Generic.IList<Microsoft.Agents.Builder.Dialogs.Choices.Choice> * string * string * Microsoft.Agents.Builder.Dialogs.Choices.ChoiceFactoryOptions -> Microsoft.Agents.Core.Models.IActivityPublic Shared Function List (choices As IList(Of Choice), Optional text As String = Nothing, Optional speak As String = Nothing, Optional options As ChoiceFactoryOptions = Nothing) As IActivityParameters
- text
- String
Optional, text of the message.
- speak
- String
Optional, SSML text to be spoken by the Agent on a speech-enabled channel.
- options
- ChoiceFactoryOptions
Optional, formatting options to tweak the rendering of the list.
Returns
An activity with choices as a numbered or bulleted list.
Applies to
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.Agents.Core.Models.IActivity List(System.Collections.Generic.IList<string> choices, string text = default, string speak = default, Microsoft.Agents.Builder.Dialogs.Choices.ChoiceFactoryOptions options = default);static member List : System.Collections.Generic.IList<string> * string * string * Microsoft.Agents.Builder.Dialogs.Choices.ChoiceFactoryOptions -> Microsoft.Agents.Core.Models.IActivityPublic Shared Function List (choices As IList(Of String), Optional text As String = Nothing, Optional speak As String = Nothing, Optional options As ChoiceFactoryOptions = Nothing) As IActivityParameters
- text
- String
Optional, the text of the message to send.
- speak
- String
Optional, the text to be spoken by your Agent on a speech-enabled channel.
- options
- ChoiceFactoryOptions
Optional, the formatting options to use when rendering as a list.
Returns
The created message activity.