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

    Module @microsoft/agents-activity

    @microsoft/agents-activity

    The @microsoft/agents-activity implements the Activity Protocol Specification https://github.com/microsoft/Agents/blob/main/specs/activity/protocol-activity.md.

    It provides declaration files defined with TypeScript and validators based on zod.

    To install the package, use npm:

    npm install @microsoft/agents-activity
    
    const activity = Activity.fromObject({ type: ActivityTypes.Message, text: 'Hello World' })
    

    Enumerations

    ActionTypes
    ActivityEventNames
    ActivityImportance
    ActivityTreatments
    ActivityTypes
    AttachmentLayoutTypes
    Channels
    DeliveryModes
    EndOfConversationCodes
    InputHints
    MembershipSourceTypes
    MembershipTypes
    MessageReactionTypes
    RoleTypes
    SemanticActionStateTypes
    TextFormatTypes

    Classes

    Activity
    ExceptionHelper
    Logger

    Interfaces

    AdaptiveCardInvokeAction
    AgentError
    AgentErrorDefinition
    AIEntity
    Attachment
    CardAction
    ChannelAccount
    ClientCitation
    ConversationAccount
    ConversationParameters
    ConversationReference
    Entity
    ExpectedReplies
    GeoCoordinates
    MembershipSource
    Mention
    MessageReaction
    Place
    SemanticAction
    SensitivityUsageInfo
    SuggestedActions
    TextHighlight
    Thing

    Type Aliases

    ClientCitationIconName

    Variables

    ActivityErrors
    activityZodSchema
    adaptiveCardInvokeActionZodSchema

    Functions

    addAIToActivity
    debug