C# Класс hubiquitus4w8.hapi.hStructures.HMessage

Version 0.5 hAPI Message. For more info, see Hubiquitus reference
Наследование: Newtonsoft.Json.Linq.JObject
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
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

Описание методов

GetActor() публичный Метод

Mandatory. channel id. NULL if undefined
public GetActor ( ) : string
Результат string

GetAuthor() публичный Метод

author of this message. NULL if undefined
public GetAuthor ( ) : string
Результат string

GetConvid() публичный Метод

Mandatory. Filled by the hApi if empty. conversation id. NULL if undefined
public GetConvid ( ) : string
Результат string

GetHeaders() публичный Метод

The list of headers attached to this message. NULL if undefined
public GetHeaders ( ) : Newtonsoft.Json.Linq.JObject
Результат Newtonsoft.Json.Linq.JObject

GetLocation() публичный Метод

The geographical location to which the message refer. NULL if undefined
public GetLocation ( ) : HLocation
Результат HLocation

GetMsgid() публичный Метод

Mandatory. Filled by the hApi. message id. NULL if undefined
public GetMsgid ( ) : string
Результат string

GetPayloadAsBoolean() публичный Метод

If payload type is boolean.
public GetPayloadAsBoolean ( ) : bool?
Результат bool?

GetPayloadAsDouble() публичный Метод

If payload type is double.
public GetPayloadAsDouble ( ) : double?
Результат double?

GetPayloadAsHCommand() публичный Метод

If payload type is HCommand.
public GetPayloadAsHCommand ( ) : HCommand
Результат HCommand

GetPayloadAsHResult() публичный Метод

If payload type is HResult.
public GetPayloadAsHResult ( ) : HResult
Результат HResult

GetPayloadAsInt() публичный Метод

If payload type is int
public GetPayloadAsInt ( ) : int?
Результат int?

GetPayloadAsJArray() публичный Метод

If payload type is JArray.
public GetPayloadAsJArray ( ) : Newtonsoft.Json.Linq.JArray
Результат Newtonsoft.Json.Linq.JArray

GetPayloadAsJObject() публичный Метод

if payload type is JObject
public GetPayloadAsJObject ( ) : Newtonsoft.Json.Linq.JObject
Результат Newtonsoft.Json.Linq.JObject

GetPayloadAsString() публичный Метод

If payload type is string.
public GetPayloadAsString ( ) : string
Результат string

GetPersistent() публичный Метод

If true, the message is not persistent. persist message or not. NULL if undefined
public GetPersistent ( ) : bool?
Результат bool?

GetPriority() публичный Метод

If UNDEFINED, priority lower to 0.
public GetPriority ( ) : HMessagePriority?
Результат HMessagePriority?

GetPublished() публичный Метод

public GetPublished ( ) : long
Результат long

GetPublishedAsDate() публичный Метод

Mandatory. The date and time at which the message has been published. NULL if undefined
public GetPublishedAsDate ( ) : DateTime?
Результат DateTime?

GetPublisher() публичный Метод

Mandatory. publisher of this message. NULL if undefined
public GetPublisher ( ) : string
Результат string

GetRef() публичный Метод

public GetRef ( ) : string
Результат string

GetRelevance() публичный Метод

Timestamp until which the message is considered as relevant. NULL if undefined
public GetRelevance ( ) : long
Результат long

GetRelevanceAsDate() публичный Метод

public GetRelevanceAsDate ( ) : DateTime?
Результат DateTime?

GetSent() публичный Метод

public GetSent ( ) : long
Результат long

GetSentAsDate() публичный Метод

public GetSentAsDate ( ) : DateTime?
Результат DateTime?

GetTimeout() публичный Метод

public GetTimeout ( ) : int
Результат int

GetType() публичный Метод

Get type of the message payload. NULL if undefined
public GetType ( ) : string
Результат string

HMessage() публичный Метод

public HMessage ( ) : System
Результат System

HMessage() публичный Метод

public HMessage ( Newtonsoft.Json.Linq.JObject jsonObj ) : System
jsonObj Newtonsoft.Json.Linq.JObject
Результат System

SetActor() публичный Метод

public SetActor ( string actor ) : void
actor string
Результат void

SetAuthor() публичный Метод

public SetAuthor ( string author ) : void
author string
Результат void

SetConvid() публичный Метод

public SetConvid ( string convid ) : void
convid string
Результат void

SetHeaders() публичный Метод

public SetHeaders ( Newtonsoft.Json.Linq.JObject headers ) : void
headers Newtonsoft.Json.Linq.JObject
Результат void

SetLocation() публичный Метод

public SetLocation ( HLocation location ) : void
location HLocation
Результат void

SetMsgid() публичный Метод

public SetMsgid ( string msgid ) : void
msgid string
Результат void

SetPayload() публичный Метод

public SetPayload ( HCommand payload ) : void
payload HCommand
Результат void

SetPayload() публичный Метод

public SetPayload ( HResult payload ) : void
payload HResult
Результат void

SetPayload() публичный Метод

public SetPayload ( Newtonsoft.Json.Linq.JArray payload ) : void
payload Newtonsoft.Json.Linq.JArray
Результат void

SetPayload() публичный Метод

public SetPayload ( Newtonsoft.Json.Linq.JObject payload ) : void
payload Newtonsoft.Json.Linq.JObject
Результат void

SetPayload() публичный Метод

Payload type could be instance of JSONObject(HAlert, HAck ...), JSONArray, String, Boolean, Number.
public SetPayload ( JToken payload ) : void
payload JToken
Результат void

SetPayload() публичный Метод

public SetPayload ( bool payload ) : void
payload bool
Результат void

SetPayload() публичный Метод

public SetPayload ( double payload ) : void
payload double
Результат void

SetPayload() публичный Метод

public SetPayload ( int payload ) : void
payload int
Результат void

SetPayload() публичный Метод

public SetPayload ( string payload ) : void
payload string
Результат void

SetPersistent() публичный Метод

public SetPersistent ( bool persistent ) : void
persistent bool
Результат void

SetPriority() публичный Метод

public SetPriority ( HMessagePriority priority ) : void
priority HMessagePriority
Результат void

SetPublished() публичный Метод

public SetPublished ( System.DateTime published ) : void
published System.DateTime
Результат void

SetPublished() публичный Метод

public SetPublished ( long published ) : void
published long
Результат void

SetPublisher() публичный Метод

public SetPublisher ( string publisher ) : void
publisher string
Результат void

SetRef() публичный Метод

public SetRef ( string @ref ) : void
@ref string
Результат void

SetRelevance() публичный Метод

public SetRelevance ( System.DateTime relevance ) : void
relevance System.DateTime
Результат void

SetRelevance() публичный Метод

public SetRelevance ( long relevance ) : void
relevance long
Результат void

SetSent() публичный Метод

public SetSent ( System.DateTime sent ) : void
sent System.DateTime
Результат void

SetSent() публичный Метод

public SetSent ( long sent ) : void
sent long
Результат void

SetTimeout() публичный Метод

public SetTimeout ( int timeout ) : void
timeout int
Результат void

SetType() публичный Метод

public SetType ( string type ) : void
type string
Результат void