C# Class hubiquitus4w8.hapi.hStructures.HMessage

Version 0.5 hAPI Message. For more info, see Hubiquitus reference
Inheritance: Newtonsoft.Json.Linq.JObject
Mostrar archivo Open project: hubiquitus-old/hubiquitus4w8 Class Usage Examples

Public Methods

Method Description
GetActor ( ) : string

Mandatory. channel id. NULL if undefined

GetAuthor ( ) : string

author of this message. NULL if undefined

GetConvid ( ) : string

Mandatory. Filled by the hApi if empty. conversation id. NULL if undefined

GetHeaders ( ) : Newtonsoft.Json.Linq.JObject

The list of headers attached to this message. NULL if undefined

GetLocation ( ) : HLocation

The geographical location to which the message refer. NULL if undefined

GetMsgid ( ) : string

Mandatory. Filled by the hApi. message id. NULL if undefined

GetPayloadAsBoolean ( ) : bool?

If payload type is boolean.

GetPayloadAsDouble ( ) : double?

If payload type is double.

GetPayloadAsHCommand ( ) : HCommand

If payload type is HCommand.

GetPayloadAsHResult ( ) : HResult

If payload type is HResult.

GetPayloadAsInt ( ) : int?

If payload type is int

GetPayloadAsJArray ( ) : Newtonsoft.Json.Linq.JArray

If payload type is JArray.

GetPayloadAsJObject ( ) : Newtonsoft.Json.Linq.JObject

if payload type is JObject

GetPayloadAsString ( ) : string

If payload type is string.

GetPersistent ( ) : bool?

If true, the message is not persistent. persist message or not. NULL if undefined

GetPriority ( ) : HMessagePriority?

If UNDEFINED, priority lower to 0.

GetPublished ( ) : long
GetPublishedAsDate ( ) : DateTime?

Mandatory. The date and time at which the message has been published. NULL if undefined

GetPublisher ( ) : string

Mandatory. publisher of this message. NULL if undefined

GetRef ( ) : string

GetRelevance ( ) : long

Timestamp until which the message is considered as relevant. NULL if undefined

GetRelevanceAsDate ( ) : DateTime?
GetSent ( ) : long
GetSentAsDate ( ) : DateTime?

GetTimeout ( ) : int

GetType ( ) : string

Get type of the message payload. NULL if undefined

HMessage ( ) : System
HMessage ( Newtonsoft.Json.Linq.JObject jsonObj ) : System
SetActor ( string actor ) : void
SetAuthor ( string author ) : void
SetConvid ( string convid ) : void
SetHeaders ( Newtonsoft.Json.Linq.JObject headers ) : void
SetLocation ( HLocation location ) : void
SetMsgid ( string msgid ) : void
SetPayload ( HCommand payload ) : void
SetPayload ( HResult payload ) : void
SetPayload ( Newtonsoft.Json.Linq.JArray payload ) : void
SetPayload ( Newtonsoft.Json.Linq.JObject payload ) : void
SetPayload ( JToken payload ) : void

Payload type could be instance of JSONObject(HAlert, HAck ...), JSONArray, String, Boolean, Number.

SetPayload ( bool payload ) : void
SetPayload ( double payload ) : void
SetPayload ( int payload ) : void
SetPayload ( string payload ) : void
SetPersistent ( bool persistent ) : void
SetPriority ( HMessagePriority priority ) : void
SetPublished ( System.DateTime published ) : void
SetPublished ( long published ) : void
SetPublisher ( string publisher ) : void
SetRef ( string @ref ) : void
SetRelevance ( System.DateTime relevance ) : void
SetRelevance ( long relevance ) : void
SetSent ( System.DateTime sent ) : void
SetSent ( long sent ) : void
SetTimeout ( int timeout ) : void
SetType ( string type ) : void

Method Details

GetActor() public method

Mandatory. channel id. NULL if undefined
public GetActor ( ) : string
return string

GetAuthor() public method

author of this message. NULL if undefined
public GetAuthor ( ) : string
return string

GetConvid() public method

Mandatory. Filled by the hApi if empty. conversation id. NULL if undefined
public GetConvid ( ) : string
return string

GetHeaders() public method

The list of headers attached to this message. NULL if undefined
public GetHeaders ( ) : Newtonsoft.Json.Linq.JObject
return Newtonsoft.Json.Linq.JObject

GetLocation() public method

The geographical location to which the message refer. NULL if undefined
public GetLocation ( ) : HLocation
return HLocation

GetMsgid() public method

Mandatory. Filled by the hApi. message id. NULL if undefined
public GetMsgid ( ) : string
return string

GetPayloadAsBoolean() public method

If payload type is boolean.
public GetPayloadAsBoolean ( ) : bool?
return bool?

GetPayloadAsDouble() public method

If payload type is double.
public GetPayloadAsDouble ( ) : double?
return double?

GetPayloadAsHCommand() public method

If payload type is HCommand.
public GetPayloadAsHCommand ( ) : HCommand
return HCommand

GetPayloadAsHResult() public method

If payload type is HResult.
public GetPayloadAsHResult ( ) : HResult
return HResult

GetPayloadAsInt() public method

If payload type is int
public GetPayloadAsInt ( ) : int?
return int?

GetPayloadAsJArray() public method

If payload type is JArray.
public GetPayloadAsJArray ( ) : Newtonsoft.Json.Linq.JArray
return Newtonsoft.Json.Linq.JArray

GetPayloadAsJObject() public method

if payload type is JObject
public GetPayloadAsJObject ( ) : Newtonsoft.Json.Linq.JObject
return Newtonsoft.Json.Linq.JObject

GetPayloadAsString() public method

If payload type is string.
public GetPayloadAsString ( ) : string
return string

GetPersistent() public method

If true, the message is not persistent. persist message or not. NULL if undefined
public GetPersistent ( ) : bool?
return bool?

GetPriority() public method

If UNDEFINED, priority lower to 0.
public GetPriority ( ) : HMessagePriority?
return HMessagePriority?

GetPublished() public method

public GetPublished ( ) : long
return long

GetPublishedAsDate() public method

Mandatory. The date and time at which the message has been published. NULL if undefined
public GetPublishedAsDate ( ) : DateTime?
return DateTime?

GetPublisher() public method

Mandatory. publisher of this message. NULL if undefined
public GetPublisher ( ) : string
return string

GetRef() public method

public GetRef ( ) : string
return string

GetRelevance() public method

Timestamp until which the message is considered as relevant. NULL if undefined
public GetRelevance ( ) : long
return long

GetRelevanceAsDate() public method

public GetRelevanceAsDate ( ) : DateTime?
return DateTime?

GetSent() public method

public GetSent ( ) : long
return long

GetSentAsDate() public method

public GetSentAsDate ( ) : DateTime?
return DateTime?

GetTimeout() public method

public GetTimeout ( ) : int
return int

GetType() public method

Get type of the message payload. NULL if undefined
public GetType ( ) : string
return string

HMessage() public method

public HMessage ( ) : System
return System

HMessage() public method

public HMessage ( Newtonsoft.Json.Linq.JObject jsonObj ) : System
jsonObj Newtonsoft.Json.Linq.JObject
return System

SetActor() public method

public SetActor ( string actor ) : void
actor string
return void

SetAuthor() public method

public SetAuthor ( string author ) : void
author string
return void

SetConvid() public method

public SetConvid ( string convid ) : void
convid string
return void

SetHeaders() public method

public SetHeaders ( Newtonsoft.Json.Linq.JObject headers ) : void
headers Newtonsoft.Json.Linq.JObject
return void

SetLocation() public method

public SetLocation ( HLocation location ) : void
location HLocation
return void

SetMsgid() public method

public SetMsgid ( string msgid ) : void
msgid string
return void

SetPayload() public method

public SetPayload ( HCommand payload ) : void
payload HCommand
return void

SetPayload() public method

public SetPayload ( HResult payload ) : void
payload HResult
return void

SetPayload() public method

public SetPayload ( Newtonsoft.Json.Linq.JArray payload ) : void
payload Newtonsoft.Json.Linq.JArray
return void

SetPayload() public method

public SetPayload ( Newtonsoft.Json.Linq.JObject payload ) : void
payload Newtonsoft.Json.Linq.JObject
return void

SetPayload() public method

Payload type could be instance of JSONObject(HAlert, HAck ...), JSONArray, String, Boolean, Number.
public SetPayload ( JToken payload ) : void
payload JToken
return void

SetPayload() public method

public SetPayload ( bool payload ) : void
payload bool
return void

SetPayload() public method

public SetPayload ( double payload ) : void
payload double
return void

SetPayload() public method

public SetPayload ( int payload ) : void
payload int
return void

SetPayload() public method

public SetPayload ( string payload ) : void
payload string
return void

SetPersistent() public method

public SetPersistent ( bool persistent ) : void
persistent bool
return void

SetPriority() public method

public SetPriority ( HMessagePriority priority ) : void
priority HMessagePriority
return void

SetPublished() public method

public SetPublished ( System.DateTime published ) : void
published System.DateTime
return void

SetPublished() public method

public SetPublished ( long published ) : void
published long
return void

SetPublisher() public method

public SetPublisher ( string publisher ) : void
publisher string
return void

SetRef() public method

public SetRef ( string @ref ) : void
@ref string
return void

SetRelevance() public method

public SetRelevance ( System.DateTime relevance ) : void
relevance System.DateTime
return void

SetRelevance() public method

public SetRelevance ( long relevance ) : void
relevance long
return void

SetSent() public method

public SetSent ( System.DateTime sent ) : void
sent System.DateTime
return void

SetSent() public method

public SetSent ( long sent ) : void
sent long
return void

SetTimeout() public method

public SetTimeout ( int timeout ) : void
timeout int
return void

SetType() public method

public SetType ( string type ) : void
type string
return void