C# 클래스 hubiquitus4w8.hapi.hStructures.HMessage

Version 0.5 hAPI Message. For more info, see Hubiquitus reference
상속: Newtonsoft.Json.Linq.JObject
파일 보기 프로젝트 열기: hubiquitus-old/hubiquitus4w8 1 사용 예제들

공개 메소드들

메소드 설명
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