Caplin.DataSource.Messaging.JSON.IJsonChannelMessage Interface Reference

Inheritance diagram for Caplin.DataSource.Messaging.JSON.IJsonChannelMessage:

Public Member Functions
String	getContribUser ()
T	GetJsonAsType< T > (T jsonType)
void	setJsonTree (Object jsonTree)
Public Member Functions inherited from Caplin.DataSource.Messaging.JSON.IJsonMessage
bool	isPatch ()
	Checks if the JSON object is a patch. More...

Additional Inherited Members
Properties inherited from Caplin.DataSource.Messaging.JSON.IJsonMessage
Object	JsonObject [get]
	Gets the the JSON object. More...
string	JsonString [get]
	Gets the the JSON object string. More...
Properties inherited from Caplin.DataSource.Messaging.IMessage
bool	Image [get, set]
	Gets or sets a boolean value indicating whether this IMessage represents an image or an update. More...
string	Subject [get]
	Gets the subject of this message. More...

Detailed Description

Provides an interface for receiving JSON Channel messages in a JsonChannel to allow json communication while avoiding having to deal with additional metadata contained in the packet.

Member Function Documentation

String Caplin.DataSource.Messaging.JSON.IJsonChannelMessage.getContribUser

(

)

Grabs the string value of the user who has contributed from the Json message metadata

Returns

the contribUser value as String

T Caplin.DataSource.Messaging.JSON.IJsonChannelMessage.GetJsonAsType< T >

(

T

jsonType

)

Returns the object JSON deserialized into a class of type which is passed in as jsonType

Parameters

jsonType

the class which we deserialize intp

Returns

the deserialized json class

void Caplin.DataSource.Messaging.JSON.IJsonChannelMessage.setJsonTree

(

Object

jsonTree

)

Set the JsonObject in the Message to the given value

Parameters

jsonTree

the json object to be set