Share via

IActivity Interface

  • Reference

Definition

Namespace:
Microsoft.Bot.Schema
Assembly:
Microsoft.Bot.Schema.dll
Package:
Microsoft.Bot.Schema v4.22.7

Shared properties for all activities.

public interface IActivity
type IActivity = interface
Public Interface IActivity
Derived

Properties

ChannelData

Gets or sets channel-specific payload.
ChannelId

Gets or sets Channel this activity is associated with.
Conversation

Gets or sets Address for the conversation that this activity is associated with.
Entities

Gets or sets collection of Entity objects, each of which contains metadata about this activity. Each Entity object is typed.
From

Gets or sets Sender address.
Id

Gets or sets iD for the activity.
LocalTimestamp

Gets or sets the local date and time of the message, expressed in ISO-8601 format. For example, 2016-09-23T13:07:49.4714686-07:00.
Recipient

Gets or sets address that received the message.
ReplyToId

Gets or sets the original ID this activity is a response to.
ServiceUrl

Gets or sets service URL where responses to this activity should be sent.
Timestamp

Gets or sets timestamp when this message was sent (UTC).
Type

Gets or sets activity type.

Methods

ApplyConversationReference(ConversationReference, Boolean)

Updates an activity with the delivery information from an existing conversation reference.
AsContactRelationUpdateActivity()

Return IContactRelationUpdateActivity if this is a contactRelationUpdate activity, null otherwise.
AsConversationUpdateActivity()

Return IConversationUpdateActivity if this is a conversationUpdate activity, null otherwise.
AsEndOfConversationActivity()

Return IEndOfConversationActivity if this is an end-of-conversation activity, null otherwise.
AsEventActivity()

Returns IEventActivity if this is an event activity, null otherwise.
AsInstallationUpdateActivity()

Return IInstallationUpdateActivity if this is a installationUpdate activity, null otherwise.
AsInvokeActivity()

Returns IInvokeActivity if this is an invoke activity, null otherwise.
AsMessageActivity()

Return IMessageActivity if this is a message activity, null otherwise.
AsMessageDeleteActivity()

Returns IMessageDeleteActivity if this is a message delete activity, null otherwise.
AsMessageReactionActivity()

Returns IMessageDeleteActivity if this is a message reaction activity, null otherwise.
AsMessageUpdateActivity()

Returns IMessageUpdateActivity if this is a message update activity, null otherwise.
AsSuggestionActivity()

Returns IMessageDeleteActivity if this is a suggestion activity, null otherwise.
AsTypingActivity()

Return ITypingActivity if this is a typing activity, null otherwise.
GetChannelData<TypeT>()

Gets the channel data as strongly typed object.
GetConversationReference()

Gets a conversation reference from an activity.
TryGetChannelData<TypeT>(TypeT)

Try to get the channeldata as a strongly typed object.

Extension Methods

TeamsGetChannelId(IActivity)

Gets the Team's channel id from the current activity.
TeamsGetMeetingInfo(IActivity)

Gets the TeamsMeetingInfo object from the current activity.
TeamsGetSelectedChannelId(IActivity)

Gets the Team's selected channel id from the current activity.
TeamsGetTeamInfo(IActivity)

Gets the TeamsInfo object from the current activity.
TeamsGetTeamOnBehalfOf(IActivity)

Gets the Teams OnBehalfOf list from the current activity.
TeamsNotifyUser(IActivity, Boolean, String)

Configures the current activity to generate a notification within Teams.
TeamsNotifyUser(IActivity)

Configures the current activity to generate a notification within Teams.
GetLocale(IActivity)

Gets the locale for the activity.
SetLocale(IActivity, String)

Sets the locale for the activity.

Applies to