Paiwise.AuthenticationResult Class Reference

Basic implementation of IAuthenticationResult. More...

Inheritance diagram for Paiwise.AuthenticationResult:

Public Member Functions
	AuthenticationResult ()
	Null result. More...
	AuthenticationResult (bool Result)
	Authentication result More...
	AuthenticationResult (ErrorType ErrorType, string ErrorMessage, params KeyValuePair< string, object >[] Tags)
	Error result. More...
	AuthenticationResult (ErrorType ErrorType, string ErrorMessage, string ErrorLanguage, params KeyValuePair< string, object >[] Tags)
	Error result. More...
	AuthenticationResult (ErrorType ErrorType, string ErrorMessage, string ErrorLanguage, string ErrorCode, params KeyValuePair< string, object >[] Tags)
	Error result. More...

Properties
bool?	Result [get]
	true = authentication successful false = authentication rejected null = unable to perform authentication More...
ErrorType	ErrorType [get]
	Type of error. More...
string	ErrorMessage [get]
	Optional Error message that can be sent to origin More...
string	ErrorLanguage [get]
	Optional language of error message More...
string	ErrorCode [get]
	Optional Machine-readable error code. More...
KeyValuePair< string, object >[]	Tags [get]
	Tags annotating the error message. More...

Detailed Description

Basic implementation of IAuthenticationResult.

Definition at line 8 of file AuthenticationResult.cs.

Constructor & Destructor Documentation

AuthenticationResult() [1/5]

Paiwise.AuthenticationResult.AuthenticationResult

(

)

Null result.

Definition at line 13 of file AuthenticationResult.cs.

AuthenticationResult() [2/5]

Paiwise.AuthenticationResult.AuthenticationResult

(

bool

Result

)

Authentication result

Parameters

Result

Result

Definition at line 23 of file AuthenticationResult.cs.

AuthenticationResult() [3/5]

Paiwise.AuthenticationResult.AuthenticationResult	(	ErrorType	ErrorType,
		string	ErrorMessage,
		params KeyValuePair< string, object >[]	Tags
	)

Error result.

Parameters

ErrorType	Error Type
ErrorMessage	Human-readable error message.
Tags	Tags annotating the error message.

Definition at line 35 of file AuthenticationResult.cs.

AuthenticationResult() [4/5]

Paiwise.AuthenticationResult.AuthenticationResult	(	ErrorType	ErrorType,
		string	ErrorMessage,
		string	ErrorLanguage,
		params KeyValuePair< string, object >[]	Tags
	)

Error result.

Parameters

ErrorType	Error Type
ErrorMessage	Human-readable error message.
ErrorLanguage	Language code.
Tags	Tags annotating the error message.

Definition at line 47 of file AuthenticationResult.cs.

AuthenticationResult() [5/5]

Paiwise.AuthenticationResult.AuthenticationResult	(	ErrorType	ErrorType,
		string	ErrorMessage,
		string	ErrorLanguage,
		string	ErrorCode,
		params KeyValuePair< string, object >[]	Tags
	)

Error result.

Parameters

ErrorType	Error Type
ErrorMessage	Human-readable error message.
ErrorLanguage	Language code.
ErrorCode	Machine-readable Error code
Tags	Tags annotating the error message.

Definition at line 60 of file AuthenticationResult.cs.

Property Documentation

ErrorCode

string Paiwise.AuthenticationResult.ErrorCode

get

Optional Machine-readable error code.

Implements Paiwise.IAuthenticationResult.

Definition at line 100 of file AuthenticationResult.cs.

ErrorLanguage

string Paiwise.AuthenticationResult.ErrorLanguage

get

Optional language of error message

Implements Paiwise.IAuthenticationResult.

Definition at line 95 of file AuthenticationResult.cs.

ErrorMessage

string Paiwise.AuthenticationResult.ErrorMessage

get

Optional Error message that can be sent to origin

Implements Paiwise.IAuthenticationResult.

Definition at line 90 of file AuthenticationResult.cs.

ErrorType

ErrorType Paiwise.AuthenticationResult.ErrorType

get

Type of error.

Implements Paiwise.IAuthenticationResult.

Definition at line 85 of file AuthenticationResult.cs.

Result

bool? Paiwise.AuthenticationResult.Result

get

true = authentication successful false = authentication rejected null = unable to perform authentication

Implements Paiwise.IAuthenticationResult.

Definition at line 80 of file AuthenticationResult.cs.

Tags

KeyValuePair<string, object> [] Paiwise.AuthenticationResult.Tags

get

Tags annotating the error message.

Implements Paiwise.IAuthenticationResult.

Definition at line 105 of file AuthenticationResult.cs.

---

The documentation for this class was generated from the following file:

• C:/My Projects/IoTBroker/Waher.Payments/AuthenticationResult.cs