Class ChoiceFactory

constructor

• new ChoiceFactory(): ChoiceFactory

  Returns ChoiceFactory

Static ReadonlyMAX_ACTION_TITLE_LENGTH

StaticforChannel

• forChannel(
      channelOrContext: string | TurnContext,
      choices: (string | Choice)[],
      text?: string,
      speak?: string,
      options?: ChoiceFactoryOptions,
      conversationType?: string,
  ): Activity

  Returns a 'message' activity containing a list of choices that has been automatically formatted based on the capabilities of a given channel.

  Parameters

  • channelOrContext: string | TurnContext

    Channel ID or context object for the current turn of conversation.

  • choices: (string | Choice)[]

    List of choices to render.

  • Optionaltext: string

    (Optional) text of the message.

  • Optionalspeak: string

    (Optional) SSML to speak for the message.

  • Optionaloptions: ChoiceFactoryOptions

    (Optional) formatting options to use when rendering as a list.

  • OptionalconversationType: string

    (Optional) the type of the conversation.

  Returns Activity

  The created message activity.

StaticheroCard

• heroCard(choices: (string | Choice)[], text?: string, speak?: string): Activity

  Returns a 'message' activity that includes a list of choices that have been added as HeroCard's.

  Parameters

  • choices: (string | Choice)[]

    List of choices to render.

  • Optionaltext: string

    (Optional) Text of the message.

  • Optionalspeak: string

    (Optional) SSML to speak for the message.

  Returns Activity

  The created message activity with choices as a HeroCard with buttons.

Staticinline

• inline(
      choices: (string | Choice)[],
      text?: string,
      speak?: string,
      options?: ChoiceFactoryOptions,
  ): Activity

  Returns a 'message' activity containing a list of choices that has been formatted as an inline list.

  Parameters

  • choices: (string | Choice)[]

    List of choices to render.

  • Optionaltext: string

    (Optional) text of the message.

  • Optionalspeak: string

    (Optional) SSML to speak for the message.

  • Optionaloptions: ChoiceFactoryOptions

    (Optional) formatting options to tweak rendering of list.

  Returns Activity

  The created message activity.

Staticlist

• list(
      choices: (string | Choice)[],
      text?: string,
      speak?: string,
      options?: ChoiceFactoryOptions,
  ): Activity

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

  Parameters

  • choices: (string | Choice)[]

    List of choices to render.

  • Optionaltext: string

    (Optional) text of the message.

  • Optionalspeak: string

    (Optional) SSML to speak for the message.

  • Optionaloptions: ChoiceFactoryOptions

    (Optional) formatting options to tweak rendering of list.

  Returns Activity

  The created message activity.

StaticsuggestedActions

• suggestedActions(
      choices: (string | Choice)[],
      text?: string,
      speak?: string,
  ): Activity

  Returns a 'message' activity containing a list of choices that has been formatted as suggested actions.

  Parameters

  • choices: (string | Choice)[]

    List of choices to render.

  • Optionaltext: string

    (Optional) Text of the message.

  • Optionalspeak: string

    (Optional) SSML to speak for the message.

  Returns Activity

  The created message activity.

StatictoChoices

• toChoices(choices: (string | Choice)[]): Choice[]

  Takes a mixed list of string and Choice based choices and returns them as a Choice[].

  Parameters

  • choices: (string | Choice)[]

    List of choices to add.

  Returns Choice[]

  A list of choices.