Microsoft.Bot.Connector.IEndOfConversationActivity Interface Reference

Conversation is ending, or a request to end the conversation More...

Inheritance diagram for Microsoft.Bot.Connector.IEndOfConversationActivity:

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...
 
string Code [get, set]
 Code indicating why the conversation has ended More...
 
ConversationAccount Conversation [get, set]
 Address for the conversation that this activity is associated with More...
 
IList< EntityEntities [get, set]
 Collection of Entity objects, each of which contains metadata about this activity. Each Entity object is typed. 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...
 
string Text [get, set]
 Content to display when ending the conversation More...
 
DateTime Timestamp [get, set]
 UTC Time when message was sent More...
 
string Type [get, set]
 Activity type More...
 

Detailed Description

Conversation is ending, or a request to end the conversation

Definition at line 10 of file IEndOfConversationActivity.cs.

Member Function Documentation

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

Return IContactRelationUpdateActivity if this is a contactRelationUpdate activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

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

Return IConversationUpdateActivity if this is a conversationUpdate activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

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

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

Implemented in Microsoft.Bot.Connector.Activity.

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

Returns IEventActivity if this is an event activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

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

Return IInstallationUpdateActivity if this is a installationUpdate activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

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

Returns IInvokeActivity if this is an invoke activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

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

Return IMessageActivity if this is a message activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

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

Return ITypingActivity if this is a typing activity, null otherwise

Implemented in Microsoft.Bot.Connector.Activity.

Property Documentation

dynamic Microsoft.Bot.Connector.IActivity.ChannelData
getsetinherited

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
getsetinherited

Channel this activity is associated with

Definition at line 39 of file IActivity.cs.

string Microsoft.Bot.Connector.IEndOfConversationActivity.Code
getset

Code indicating why the conversation has ended

Definition at line 15 of file IEndOfConversationActivity.cs.

ConversationAccount Microsoft.Bot.Connector.IActivity.Conversation
getsetinherited

Address for the conversation that this activity is associated with

Definition at line 49 of file IActivity.cs.

IList<Entity> Microsoft.Bot.Connector.IEndOfConversationActivity.Entities
getset

Collection of Entity objects, each of which contains metadata about this activity. Each Entity object is typed.

Definition at line 25 of file IEndOfConversationActivity.cs.

ChannelAccount Microsoft.Bot.Connector.IActivity.From
getsetinherited

Sender address data

Definition at line 44 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.Id
getsetinherited

Id for the activity

Definition at line 19 of file IActivity.cs.

DateTimeOffset Microsoft.Bot.Connector.IActivity.LocalTimestamp
getsetinherited

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
getsetinherited

Address that received the message

Definition at line 54 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.ReplyToId
getsetinherited

The original id this message is a response to

Definition at line 59 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.ServiceUrl
getsetinherited

ServiceUrl

Definition at line 24 of file IActivity.cs.

string Microsoft.Bot.Connector.IEndOfConversationActivity.Text
getset

Content to display when ending the conversation

Definition at line 20 of file IEndOfConversationActivity.cs.

DateTime Microsoft.Bot.Connector.IActivity.Timestamp
getsetinherited

UTC Time when message was sent

Definition at line 29 of file IActivity.cs.

string Microsoft.Bot.Connector.IActivity.Type
getsetinherited

Activity type

Definition at line 14 of file IActivity.cs.


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