VideoOS.Platform.Messaging.Message Class Reference

A Message contains information send from a sender to one or multiple receivers. It is identified by a String, the well known messages created and send by the MIP Environment are defined in class VideoOS.Platform.Messaging.MessageId.
The fields may be filled out or not filled out depending on the MessageId. The MessageId is the identification of the message, a plugin can use any MessageId they choose of additional communication.
The field Reason - is a string containing why this message has been send, could be the name of a rule, a black list, or simply a user action. The RelatedFQID is used for some Messages – see documentation for each MessageId. The Data field is simply an object relevant to the specific MessageId. More...

Public Member Functions
	Message (String messageId)
	The Message contains a singe string as the ID.
	Message (String messageId, FQID relatedFQID)
	The Message contains a single string as the ID. The message relates to the relatedFQID.
	Message (String messageId, FQID relatedFQID, object data)
	The Message contains a singe string as the ID.
	Message (String messageId, FQID relatedFQID, object data, String reason)
	The Message contains a singe string as the ID.
	Message (String messageId, object data)
	The Message contains a singe string as the ID and a Data object. T.

Properties
object	Data [get, set]
	The data can be any object as defined by the MessageId. Built-in messages uses a name format for the Data field like the messageId appended with 'Data'.
FQID	ExternalMessageSourceEndPoint [get, set]
	If this message originated from another application, this FQID will identify the Source EndPoint's FQID. This can be used for the destinationEndPoint if you need to replay back in the MessageCommunication.Transmit method.
String	MessageId [get]
	The identification of the message begin sent. Built-in message id's are located in class Messaging.MessageId Plugin defined messages are suggested to be of a namespace format with the plugin type as the initial name. e.g. "MyPlugin.Info.PayAttention".
String	Reason [get, set]
	The Reason is an informative field that can be used to display or trace additional reason for the Sending of this message.
FQID	RelatedFQID [get, set]
	The RelatedFQID identifies an Item that subject to an action/event, e.g. as a parameter. The destination FQID on the SendMessage is usually the one receiving the message and RelatedFQID.

Detailed Description

A Message contains information send from a sender to one or multiple receivers. It is identified by a String, the well known messages created and send by the MIP Environment are defined in class VideoOS.Platform.Messaging.MessageId.
The fields may be filled out or not filled out depending on the MessageId. The MessageId is the identification of the message, a plugin can use any MessageId they choose of additional communication.
The field Reason - is a string containing why this message has been send, could be the name of a rule, a black list, or simply a user action. The RelatedFQID is used for some Messages – see documentation for each MessageId. The Data field is simply an object relevant to the specific MessageId.

Constructor & Destructor Documentation

Message() [1/5]

VideoOS.Platform.Messaging.Message.Message ( String messageId )

inline

The Message contains a singe string as the ID.

Parameters

messageId

The ID

Message() [2/5]

VideoOS.Platform.Messaging.Message.Message ( String messageId, FQID relatedFQID )

inline

The Message contains a single string as the ID. The message relates to the relatedFQID.

Parameters

messageId	The Id of the message
relatedFQID	FQID of a related Item to the Destination FQID

Message() [3/5]

VideoOS.Platform.Messaging.Message.Message ( String messageId, object data )

inline

The Message contains a singe string as the ID and a Data object. T.

Parameters

messageId	The Id of the message
data	Can contain data to be send with the message, or data where fields can be filled by receiver

Message() [4/5]

VideoOS.Platform.Messaging.Message.Message ( String messageId, FQID relatedFQID, object data )

inline

The Message contains a singe string as the ID.

Parameters

messageId	The Id of the message
relatedFQID	FQID of a related Item to the Destination FQID
data	Can contain data to be send with the message, or data where fields can be filled by receiver

Message() [5/5]

VideoOS.Platform.Messaging.Message.Message ( String messageId, FQID relatedFQID, object data, String reason )

inline

The Message contains a singe string as the ID.

Parameters

messageId	The Id of the message
relatedFQID	FQID of a related Item to the Destination FQID
data	Can contain data to be send with the message, or data where fields can be filled by receiver
reason	Explain why this message is being sent

Property Documentation

Data

object VideoOS.Platform.Messaging.Message.Data

getset

The data can be any object as defined by the MessageId. Built-in messages uses a name format for the Data field like the messageId appended with 'Data'.

ExternalMessageSourceEndPoint

FQID VideoOS.Platform.Messaging.Message.ExternalMessageSourceEndPoint

getset

If this message originated from another application, this FQID will identify the Source EndPoint's FQID.
This can be used for the destinationEndPoint if you need to replay back in the MessageCommunication.Transmit method.

MessageId

String VideoOS.Platform.Messaging.Message.MessageId

get

The identification of the message begin sent. Built-in message id's are located in class Messaging.MessageId Plugin defined messages are suggested to be of a namespace format with the plugin type as the initial name. e.g. "MyPlugin.Info.PayAttention".

Reason

String VideoOS.Platform.Messaging.Message.Reason

getset

The Reason is an informative field that can be used to display or trace additional reason for the Sending of this message.

RelatedFQID

FQID VideoOS.Platform.Messaging.Message.RelatedFQID

getset

The RelatedFQID identifies an Item that subject to an action/event, e.g. as a parameter. The destination FQID on the SendMessage is usually the one receiving the message and RelatedFQID.