C# Class hubiquitus4w8.hapi.hStructures.HResult

Version 0.5 hAPI result. For more info, see Hubiquitus reference

Inheritance: Newtonsoft.Json.Linq.JObject

Show file Open project: hubiquitus-old/hubiquitus4w8 Class Usage Examples

Public Methods

Method	Description
GetResult ( ) : object	If we don't know the type of result.
GetResultASJArray ( ) : Newtonsoft.Json.Linq.JArray	If result type is JArray.
GetResultAsBoolean ( ) : bool?	If the result type is bool.
GetResultAsDouble ( ) : double?	If the result type is double.
GetResultAsInt ( ) : int?	If the result type is int.
GetResultAsJObject ( ) : Newtonsoft.Json.Linq.JObject	If result type is JObject.
GetResultAsString ( ) : string	If result type is string.
GetStatus ( ) : ResultStatus?	Get the status of the result. Null if undefined.
HResult ( ) : System
HResult ( Newtonsoft.Json.Linq.JObject jsonObj ) : System
SetResult ( Newtonsoft.Json.Linq.JArray result ) : void
SetResult ( Newtonsoft.Json.Linq.JObject result ) : void
SetResult ( JToken result ) : void	The result type could be JObject, JArray, String, Boolean, Number.
SetResult ( bool result ) : void
SetResult ( double result ) : void
SetResult ( int result ) : void
SetResult ( string result ) : void
SetStatus ( ResultStatus status ) : void

Method Details

GetResult() public method

If we don't know the type of result.

public GetResult ( ) : object
return	object

GetResultASJArray() public method

If result type is JArray.

public GetResultASJArray ( ) : Newtonsoft.Json.Linq.JArray
return	Newtonsoft.Json.Linq.JArray

GetResultAsBoolean() public method

If the result type is bool.

public GetResultAsBoolean ( ) : bool?
return	bool?

GetResultAsDouble() public method

If the result type is double.

public GetResultAsDouble ( ) : double?
return	double?

GetResultAsInt() public method

If the result type is int.

public GetResultAsInt ( ) : int?
return	int?

GetResultAsJObject() public method

If result type is JObject.

public GetResultAsJObject ( ) : Newtonsoft.Json.Linq.JObject
return	Newtonsoft.Json.Linq.JObject

GetResultAsString() public method

If result type is string.

public GetResultAsString ( ) : string
return	string

GetStatus() public method

Get the status of the result. Null if undefined.

public GetStatus ( ) : ResultStatus?
return	ResultStatus?

HResult() public method

public HResult ( ) : System
return	System

HResult() public method

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

SetResult() public method

public SetResult ( Newtonsoft.Json.Linq.JArray result ) : void
result	Newtonsoft.Json.Linq.JArray
return	void

SetResult() public method

public SetResult ( Newtonsoft.Json.Linq.JObject result ) : void
result	Newtonsoft.Json.Linq.JObject
return	void

SetResult() public method

The result type could be JObject, JArray, String, Boolean, Number.

public SetResult ( JToken result ) : void
result	JToken
return	void

SetResult() public method

public SetResult ( bool result ) : void
result	bool
return	void

SetResult() public method

public SetResult ( double result ) : void
result	double
return	void

SetResult() public method

public SetResult ( int result ) : void
result	int
return	void

SetResult() public method

public SetResult ( string result ) : void
result	string
return	void

SetStatus() public method

public SetStatus ( ResultStatus status ) : void
status	ResultStatus
return	void