Microsoft.Bot.Builder.Dialogs.ResumptionCookie Class Reference

The resumption cookie that can be used to resume a conversation with a user. More...

Inheritance diagram for Microsoft.Bot.Builder.Dialogs.ResumptionCookie:

Public Member Functions

 ResumptionCookie (Address address, string userName, bool isGroup, string locale)
 Creates an instance of the resumption cookie. More...
 
 ResumptionCookie (IMessageActivity msg)
 Creates an instance of resumption cookie form a Connector.IMessageActivity More...
 
bool Equals (ResumptionCookie other)
 
override bool Equals (object other)
 
override int GetHashCode ()
 
Activity GetMessage ()
 Creates a message from the resumption cookie. More...
 

Static Public Member Functions

static ResumptionCookie GZipDeserialize (string str)
 Deserializes the GZip serialized ResumptionCookie using Extensions.GZipSerialize(ResumptionCookie). More...
 

Properties

IAddress Address [get, set]
 The key that minimally and completely identifies a bot's conversation with a user on a channel. More...
 
bool IsGroup [get, set]
 The IsGroup flag for conversation. More...
 
bool IsTrustedServiceUrl [get]
 True if the IAddress.ServiceUrl is trusted; False otherwise. More...
 
string Locale [get, set]
 The locale of message. More...
 
string UserName [get, set]
 The user name. More...
 

Detailed Description

The resumption cookie that can be used to resume a conversation with a user.

Definition at line 48 of file ResumptionCookie.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Dialogs.ResumptionCookie.ResumptionCookie ( Address  address,
string  userName,
bool  isGroup,
string  locale 
)
inline

Creates an instance of the resumption cookie.

Parameters
addressThe address.
userNameThe user name.
isGroupThe IsGroup flag for conversation.
localeThe locale of the message.

Definition at line 86 of file ResumptionCookie.cs.

Microsoft.Bot.Builder.Dialogs.ResumptionCookie.ResumptionCookie ( IMessageActivity  msg)
inline

Creates an instance of resumption cookie form a Connector.IMessageActivity

Parameters
msgThe message.

Definition at line 99 of file ResumptionCookie.cs.

Member Function Documentation

bool Microsoft.Bot.Builder.Dialogs.ResumptionCookie.Equals ( ResumptionCookie  other)
inline

Definition at line 110 of file ResumptionCookie.cs.

override bool Microsoft.Bot.Builder.Dialogs.ResumptionCookie.Equals ( object  other)
inline

Definition at line 120 of file ResumptionCookie.cs.

override int Microsoft.Bot.Builder.Dialogs.ResumptionCookie.GetHashCode ( )
inline

Definition at line 125 of file ResumptionCookie.cs.

Activity Microsoft.Bot.Builder.Dialogs.ResumptionCookie.GetMessage ( )
inline

Creates a message from the resumption cookie.

Returns
The message that can be sent to bot based on the resumption cookie

Definition at line 134 of file ResumptionCookie.cs.

static ResumptionCookie Microsoft.Bot.Builder.Dialogs.ResumptionCookie.GZipDeserialize ( string  str)
inlinestatic

Deserializes the GZip serialized ResumptionCookie using Extensions.GZipSerialize(ResumptionCookie).

Parameters
strThe Base64 encoded string.
Returns
An instance of ResumptionCookie

Definition at line 164 of file ResumptionCookie.cs.

Property Documentation

IAddress Microsoft.Bot.Builder.Dialogs.ResumptionCookie.Address
getset

The key that minimally and completely identifies a bot's conversation with a user on a channel.

Definition at line 53 of file ResumptionCookie.cs.

bool Microsoft.Bot.Builder.Dialogs.ResumptionCookie.IsGroup
getset

The IsGroup flag for conversation.

Definition at line 71 of file ResumptionCookie.cs.

bool Microsoft.Bot.Builder.Dialogs.ResumptionCookie.IsTrustedServiceUrl
get

True if the IAddress.ServiceUrl is trusted; False otherwise.

Conversation.ResumeAsync adds the host of the IAddress.ServiceUrl to MicrosoftAppCredentials.TrustedHostNames if this flag is True.

Definition at line 66 of file ResumptionCookie.cs.

string Microsoft.Bot.Builder.Dialogs.ResumptionCookie.Locale
getset

The locale of message.

Definition at line 76 of file ResumptionCookie.cs.

string Microsoft.Bot.Builder.Dialogs.ResumptionCookie.UserName
getset

The user name.

Definition at line 58 of file ResumptionCookie.cs.


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