Documentation - v1.2.0-alpha.3
    Preparing search index...

    Class MessageFactory

    A factory class for creating various types of message activities.

    Index

    Constructors

    constructor

    Methods

    attachment carousel contentUrl list suggestedActions text

    Constructors

    Methods

    • Creates a message activity with a single attachment.

      Parameters

      • attachment: Attachment

        The attachment to include in the message.

      • Optionaltext: string

        (Optional) The text of the message.

      • Optionalspeak: string

        (Optional) The text to be spoken by the agent.

      • OptionalinputHint: string

        (Optional) The input hint for the message.

      Returns Activity

      The created message activity with an attachment.

    • Creates a message activity with a carousel of attachments.

      Parameters

      • attachments: Attachment[]

        The list of attachments to include in the carousel.

      • Optionaltext: string

        (Optional) The text of the message.

      • Optionalspeak: string

        (Optional) The text to be spoken by the agent.

      • OptionalinputHint: string

        (Optional) The input hint for the message.

      Returns Activity

      The created message activity with a carousel of attachments.

    • Creates a message activity with content from a URL.

      Parameters

      • url: string

        The URL of the content.

      • contentType: string

        The content type of the attachment.

      • Optionalname: string

        (Optional) The name of the attachment.

      • Optionaltext: string

        (Optional) The text of the message.

      • Optionalspeak: string

        (Optional) The text to be spoken by the agent.

      • OptionalinputHint: string

        (Optional) The input hint for the message.

      Returns Activity

      The created message activity with content from a URL.

    • Creates a message activity with a list of attachments.

      Parameters

      • attachments: Attachment[]

        The list of attachments to include in the message.

      • Optionaltext: string

        (Optional) The text of the message.

      • Optionalspeak: string

        (Optional) The text to be spoken by the agent.

      • OptionalinputHint: string

        (Optional) The input hint for the message.

      Returns Activity

      The created message activity with a list of attachments.

    • Creates a message activity with suggested actions.

      Parameters

      • actions: (string | CardAction)[]

        The suggested actions.

      • Optionaltext: string

        (Optional) The text of the message.

      • Optionalspeak: string

        (Optional) The text to be spoken by the agent.

      • OptionalinputHint: string

        (Optional) The input hint for the message.

      Returns Activity

      The created message activity with suggested actions.

    Statictext

    • text(text: string, speak?: string, inputHint?: string): Activity

      Creates a text message activity.

      Parameters

      • text: string

        The text of the message.

      • Optionalspeak: string

        (Optional) The text to be spoken by the agent.

      • OptionalinputHint: string

        (Optional) The input hint for the message.

      Returns Activity

      The created text message activity.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods