Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage Class Referenceabstract

Base message wrapper for all API messages. The format is: { type: (type-of-message), to: (to-user-MRI), from: (from-user-MRI), (optional additional-message-specific-properties), (optional additional-message-specific-properties), (optional additional-message-specific-properties), } More...

Inheritance diagram for Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage:

Public Member Functions

void Validate ()
 

Static Public Member Functions

static string GetMessageType (string json)
 

Public Attributes

const string FromHeaderKey = "from"
 
const string MessageTypeHeaderKey = "type"
 
const string ToHeaderKey = "to"
 

Static Public Attributes

static readonly ContentType JsonContentType = new ContentType("application/json")
 

Protected Member Functions

 BaseMessage (string messageType)
 
abstract void ValidateInternal ()
 

Static Protected Member Functions

static void ValidateMri (string value, string name)
 
static void VerifyPropertyExists (string value, string name)
 

Properties

string From [get, set]
 
string MessageType [get, set]
 
string To [get, set]
 

Detailed Description

Base message wrapper for all API messages. The format is: { type: (type-of-message), to: (to-user-MRI), from: (from-user-MRI), (optional additional-message-specific-properties), (optional additional-message-specific-properties), (optional additional-message-specific-properties), }

Definition at line 22 of file BaseMessage.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.BaseMessage ( string  messageType)
inlineprotected

Definition at line 36 of file BaseMessage.cs.

Member Function Documentation

static string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.GetMessageType ( string  json)
inlinestatic

Definition at line 59 of file BaseMessage.cs.

void Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.Validate ( )
inline

Definition at line 51 of file BaseMessage.cs.

abstract void Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.ValidateInternal ( )
protectedpure virtual
static void Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.ValidateMri ( string  value,
string  name 
)
inlinestaticprotected

Definition at line 80 of file BaseMessage.cs.

static void Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.VerifyPropertyExists ( string  value,
string  name 
)
inlinestaticprotected

Definition at line 75 of file BaseMessage.cs.

Member Data Documentation

const string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.FromHeaderKey = "from"

Definition at line 33 of file BaseMessage.cs.

readonly ContentType Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.JsonContentType = new ContentType("application/json")
static

Definition at line 31 of file BaseMessage.cs.

const string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.MessageTypeHeaderKey = "type"

Definition at line 34 of file BaseMessage.cs.

const string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.ToHeaderKey = "to"

Definition at line 32 of file BaseMessage.cs.

Property Documentation

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.From
getset

Definition at line 49 of file BaseMessage.cs.

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.MessageType
getset

Definition at line 43 of file BaseMessage.cs.

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.BaseMessage.To
getset

Definition at line 46 of file BaseMessage.cs.


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