Activity Constructors

Definition

Namespace:

Microsoft.Bot.Schema

Assembly:

Microsoft.Bot.Schema.dll

Package:

Microsoft.Bot.Schema v4.18.1

Overloads

Activity()

Initializes a new instance of the Activity class.

Activity(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, ChannelAccount, ConversationAccount, ChannelAccount, String, String, IList<ChannelAccount>, IList<ChannelAccount>, IList<MessageReaction>, IList<MessageReaction>, String, Nullable<Boolean>, String, String, String, String, String, SuggestedActions, IList<Attachment>, IList<Entity>, Object, String, String, String, String, Object, String, ConversationReference, String, Nullable<DateTimeOffset>, String, String, IList<String>, IList<TextHighlight>, SemanticAction, String)

Initializes a new instance of the Activity class.

Activity()

Initializes a new instance of the Activity class.

public Activity ();

Public Sub New ()

Activity(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, ChannelAccount, ConversationAccount, ChannelAccount, String, String, IList<ChannelAccount>, IList<ChannelAccount>, IList<MessageReaction>, IList<MessageReaction>, String, Nullable<Boolean>, String, String, String, String, String, SuggestedActions, IList<Attachment>, IList<Entity>, Object, String, String, String, String, Object, String, ConversationReference, String, Nullable<DateTimeOffset>, String, String, IList<String>, IList<TextHighlight>, SemanticAction, String)

Initializes a new instance of the Activity class.

public Activity (string type = default, string id = default, DateTimeOffset? timestamp = default, DateTimeOffset? localTimestamp = default, string serviceUrl = default, string channelId = default, Microsoft.Bot.Schema.ChannelAccount from = default, Microsoft.Bot.Schema.ConversationAccount conversation = default, Microsoft.Bot.Schema.ChannelAccount recipient = default, string textFormat = default, string attachmentLayout = default, System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount> membersAdded = default, System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount> membersRemoved = default, System.Collections.Generic.IList<Microsoft.Bot.Schema.MessageReaction> reactionsAdded = default, System.Collections.Generic.IList<Microsoft.Bot.Schema.MessageReaction> reactionsRemoved = default, string topicName = default, bool? historyDisclosed = default, string locale = default, string text = default, string speak = default, string inputHint = default, string summary = default, Microsoft.Bot.Schema.SuggestedActions suggestedActions = default, System.Collections.Generic.IList<Microsoft.Bot.Schema.Attachment> attachments = default, System.Collections.Generic.IList<Microsoft.Bot.Schema.Entity> entities = default, object channelData = default, string action = default, string replyToId = default, string label = default, string valueType = default, object value = default, string name = default, Microsoft.Bot.Schema.ConversationReference relatesTo = default, string code = default, DateTimeOffset? expiration = default, string importance = default, string deliveryMode = default, System.Collections.Generic.IList<string> listenFor = default, System.Collections.Generic.IList<Microsoft.Bot.Schema.TextHighlight> textHighlights = default, Microsoft.Bot.Schema.SemanticAction semanticAction = default, string localTimezone = default);

new Microsoft.Bot.Schema.Activity : string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * string * string * Microsoft.Bot.Schema.ChannelAccount * Microsoft.Bot.Schema.ConversationAccount * Microsoft.Bot.Schema.ChannelAccount * string * string * System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount> * System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount> * System.Collections.Generic.IList<Microsoft.Bot.Schema.MessageReaction> * System.Collections.Generic.IList<Microsoft.Bot.Schema.MessageReaction> * string * Nullable<bool> * string * string * string * string * string * Microsoft.Bot.Schema.SuggestedActions * System.Collections.Generic.IList<Microsoft.Bot.Schema.Attachment> * System.Collections.Generic.IList<Microsoft.Bot.Schema.Entity> * obj * string * string * string * string * obj * string * Microsoft.Bot.Schema.ConversationReference * string * Nullable<DateTimeOffset> * string * string * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<Microsoft.Bot.Schema.TextHighlight> * Microsoft.Bot.Schema.SemanticAction * string -> Microsoft.Bot.Schema.Activity

Public Sub New (Optional type As String = Nothing, Optional id As String = Nothing, Optional timestamp As Nullable(Of DateTimeOffset) = Nothing, Optional localTimestamp As Nullable(Of DateTimeOffset) = Nothing, Optional serviceUrl As String = Nothing, Optional channelId As String = Nothing, Optional from As ChannelAccount = Nothing, Optional conversation As ConversationAccount = Nothing, Optional recipient As ChannelAccount = Nothing, Optional textFormat As String = Nothing, Optional attachmentLayout As String = Nothing, Optional membersAdded As IList(Of ChannelAccount) = Nothing, Optional membersRemoved As IList(Of ChannelAccount) = Nothing, Optional reactionsAdded As IList(Of MessageReaction) = Nothing, Optional reactionsRemoved As IList(Of MessageReaction) = Nothing, Optional topicName As String = Nothing, Optional historyDisclosed As Nullable(Of Boolean) = Nothing, Optional locale As String = Nothing, Optional text As String = Nothing, Optional speak As String = Nothing, Optional inputHint As String = Nothing, Optional summary As String = Nothing, Optional suggestedActions As SuggestedActions = Nothing, Optional attachments As IList(Of Attachment) = Nothing, Optional entities As IList(Of Entity) = Nothing, Optional channelData As Object = Nothing, Optional action As String = Nothing, Optional replyToId As String = Nothing, Optional label As String = Nothing, Optional valueType As String = Nothing, Optional value As Object = Nothing, Optional name As String = Nothing, Optional relatesTo As ConversationReference = Nothing, Optional code As String = Nothing, Optional expiration As Nullable(Of DateTimeOffset) = Nothing, Optional importance As String = Nothing, Optional deliveryMode As String = Nothing, Optional listenFor As IList(Of String) = Nothing, Optional textHighlights As IList(Of TextHighlight) = Nothing, Optional semanticAction As SemanticAction = Nothing, Optional localTimezone As String = Nothing)

Parameters

type

String

Contains the activity type. Possible values include: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'.

id

String

Contains an ID that uniquely identifies the activity on the channel.

timestamp

Nullable<DateTimeOffset>

Contains the date and time when the message was sent, in UTC, expressed in ISO-8601 format.

localTimestamp

Nullable<DateTimeOffset>

Contains the date and time when the message was sent, in local time, expressed in ISO-8601 format. For example, 2016-09-23T13:07:49.4714686-07:00.

serviceUrl

String

Contains the URL that specifies the channel's service endpoint. Set by the channel.

channelId

String

Contains an ID that uniquely identifies the channel. Set by the channel.

from

ChannelAccount

Identifies the sender of the message.

conversation

ConversationAccount

Identifies the conversation to which the activity belongs.

recipient

ChannelAccount

Identifies the recipient of the message.

textFormat

String

Format of text fields. Default: markdown. Possible values include: 'markdown', 'plain', 'xml'.

attachmentLayout

String

The layout hint for multiple attachments. Default: list. Possible values include: 'list', 'carousel'.

membersAdded

IList<ChannelAccount>

The collection of members added to the conversation.

membersRemoved

IList<ChannelAccount>

The collection of members removed from the conversation.

reactionsAdded

IList<MessageReaction>

The collection of reactions added to the conversation.

reactionsRemoved

IList<MessageReaction>

The collection of reactions removed from the conversation.

topicName

String

The updated topic name of the conversation.

historyDisclosed

Nullable<Boolean>

Indicates whether the prior history of the channel is disclosed.

locale

String

A locale name for the contents of the text field. The locale name is a combination of an ISO 639 two- or three-letter culture code associated with a language and an ISO 3166 two-letter subculture code associated with a country or region. The locale name can also correspond to a valid BCP-47 language tag.

text

String

The text content of the message.

speak

String

The text to speak.

inputHint

String

Indicates whether your bot is accepting, expecting, or ignoring user input after the message is delivered to the client. Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput'.

summary

String

The text to display if the channel cannot render cards.

suggestedActions

SuggestedActions

The suggested actions for the activity.

attachments

IList<Attachment>

The attachments for the activity.

entities

IList<Entity>

Represents the entities that were mentioned in the message.

channelData

Object

Contains channel-specific content.

action

String

Indicates whether the recipient of a contactRelationUpdate was added to or removed from the sender's contact list.

replyToId

String

Contains the ID of the message to which this message is a reply.

label

String

A descriptive label for the activity.

valueType

String

The type of the activity's value object.

value

Object

A value that is associated with the activity.

name

String

The name of the operation associated with an invoke or event activity.

relatesTo

ConversationReference

A reference to another conversation or activity.

code

String

A code for endOfConversation activities that indicates why the conversation ended. Possible values include: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'.

expiration

Nullable<DateTimeOffset>

The time at which the activity should be considered to be "expired" and should not be presented to the recipient.

importance

String

The importance of the activity. Possible values include: 'low', 'normal', 'high'.

deliveryMode

String

A delivery hint to signal to the recipient alternate delivery paths for the activity. The default delivery mode is "default". Possible values include: 'normal', 'notification', 'expectReplies', 'ephemeral'.

listenFor

IList<String>

List of phrases and references that speech and language priming systems should listen for.

textHighlights

IList<TextHighlight>

The collection of text fragments to highlight when the activity contains a ReplyToId value.

semanticAction

SemanticAction

An optional programmatic action accompanying this request.

localTimezone

String

Contains the name of the timezone used to define local time for the message, expressed in IANA Time Zone database format. For example, America/Los_Angeles.