Microsoft.Bot.Connector.IActivity Interface Reference

Shared properties for all activities More...

Inheritance diagram for Microsoft.Bot.Connector.IActivity:

Public Member Functions

IContactRelationUpdateActivity AsContactRelationUpdateActivity ()
 Return IContactRelationUpdateActivity if this is a contactRelationUpdate activity, null otherwise More...
 
IConversationUpdateActivity AsConversationUpdateActivity ()
 Return IConversationUpdateActivity if this is a conversationUpdate activity, null otherwise More...
 
IEndOfConversationActivity AsEndOfConversationActivity ()
 Return IEndOfConversationActivity if this is an end-of-conversation activity, null otherwise More...
 
IEventActivity AsEventActivity ()
 Returns IEventActivity if this is an event activity, null otherwise More...
 
IInstallationUpdateActivity AsInstallationUpdateActivity ()
 Return IInstallationUpdateActivity if this is a installationUpdate activity, null otherwise More...
 
IInvokeActivity AsInvokeActivity ()
 Returns IInvokeActivity if this is an invoke activity, null otherwise More...
 
IMessageActivity AsMessageActivity ()
 Return IMessageActivity if this is a message activity, null otherwise More...
 
ITypingActivity AsTypingActivity ()
 Return ITypingActivity if this is a typing activity, null otherwise More...
 

Properties

dynamic ChannelData [get, set]
 Channel specific payload More...
 
string ChannelId [get, set]
 Channel this activity is associated with More...
 
ConversationAccount Conversation [get, set]
 Address for the conversation that this activity is associated with More...
 
ChannelAccount From [get, set]
 Sender address data More...
 
string Id [get, set]
 Id for the activity More...
 
DateTimeOffset LocalTimestamp [get, set]
 Client Time when message was sent Ex: 2016-09-23T13:07:49.4714686-07:00 More...
 
ChannelAccount Recipient [get, set]
 Address that received the message More...
 
string ReplyToId [get, set]
 The original id this message is a response to More...
 
string ServiceUrl [get, set]
 ServiceUrl More...
 
DateTime Timestamp [get, set]
 UTC Time when message was sent More...
 
string Type [get, set]
 Activity type More...
 

Detailed Description

Shared properties for all activities

Definition at line 9 of file IActivity.cs.

Member Function Documentation

IContactRelationUpdateActivity Microsoft.Bot.Connector.IActivity.AsContactRelationUpdateActivity ( )

Return IContactRelationUpdateActivity if this is a contactRelationUpdate activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

IConversationUpdateActivity Microsoft.Bot.Connector.IActivity.AsConversationUpdateActivity ( )

Return IConversationUpdateActivity if this is a conversationUpdate activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

IEndOfConversationActivity Microsoft.Bot.Connector.IActivity.AsEndOfConversationActivity ( )

Return IEndOfConversationActivity if this is an end-of-conversation activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

IEventActivity Microsoft.Bot.Connector.IActivity.AsEventActivity ( )

Returns IEventActivity if this is an event activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

IInstallationUpdateActivity Microsoft.Bot.Connector.IActivity.AsInstallationUpdateActivity ( )

Return IInstallationUpdateActivity if this is a installationUpdate activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

IInvokeActivity Microsoft.Bot.Connector.IActivity.AsInvokeActivity ( )

Returns IInvokeActivity if this is an invoke activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

IMessageActivity Microsoft.Bot.Connector.IActivity.AsMessageActivity ( )

Return IMessageActivity if this is a message activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

ITypingActivity Microsoft.Bot.Connector.IActivity.AsTypingActivity ( )

Return ITypingActivity if this is a typing activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

Property Documentation

dynamic Microsoft.Bot.Connector.IActivity.ChannelData
getset

Channel specific payload

Some channels will provide channel specific data.

For a message originating in the channel it might provide the original native schema object for the channel.

For a message coming into the channel it might accept a payload allowing you to create a "native" response for the channel.

Example:

  • Email - The Email Channel will put the original Email metadata into the ChannelData object for outgoing messages, and will accep on incoming message a Subject property, and a HtmlBody which can contain Html.

The channel data essentially allows a bot to have access to native functionality on a per channel basis.

Definition at line 77 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.ChannelId
getset

Channel this activity is associated with

Definition at line 39 of file IActivity.cs.

ConversationAccount Microsoft.Bot.Connector.IActivity.Conversation
getset

Address for the conversation that this activity is associated with

Definition at line 49 of file IActivity.cs.

ChannelAccount Microsoft.Bot.Connector.IActivity.From
getset

Sender address data

Definition at line 44 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.Id
getset

Id for the activity

Definition at line 19 of file IActivity.cs.

DateTimeOffset Microsoft.Bot.Connector.IActivity.LocalTimestamp
getset

Client Time when message was sent Ex: 2016-09-23T13:07:49.4714686-07:00

Definition at line 34 of file IActivity.cs.

ChannelAccount Microsoft.Bot.Connector.IActivity.Recipient
getset

Address that received the message

Definition at line 54 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.ReplyToId
getset

The original id this message is a response to

Definition at line 59 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.ServiceUrl
getset

ServiceUrl

Definition at line 24 of file IActivity.cs.

DateTime Microsoft.Bot.Connector.IActivity.Timestamp
getset

UTC Time when message was sent

Definition at line 29 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.Type
getset

Activity type

Definition at line 14 of file IActivity.cs.


The documentation for this interface was generated from the following file: