Banafo Service state. More...

#include <BanafoServiceState.h>

Inheritance diagram for ZDK_NET::BanafoServiceState:

Public Member Functions
	BanafoServiceState (ZDK::Shared::BanafoServiceState src)

virtual long long	Handle () override

virtual void	Initialize () override

virtual void	ReleaseReference () override

Public Attributes
ZDK::IBanafoServiceState *	cppRef = nullptr

Properties
ZDK_NET::BanafoServiceStateType	State `[get]`
	The Banafo Service state. More...

int	NetworkErrorCode `[get]`
	The network error code. More...

ZDK_NET::BanafoServiceErrorType	ServiceErrorType `[get]`
	The Banafo Service error. More...

System::String^	Reason `[get]`
	HTTP failure reason. More...

System::String^	AccessToken `[get]`
	The new Banafo Service Access Token. More...

System::String^	RefreshToken `[get]`
	The new Banafo Service Refresh Token. More...

System::String^	UserCode `[get]`
	The user code for Authorizing the Banafo Service verification. More...

System::String^	VerificationURI `[get]`
	The URI for verifying the new device. More...

Detailed Description

Banafo Service state.

Describes the current full state of the Banafo Service.

Property Documentation

◆ AccessToken

System:: String^ ZDK_NET::BanafoServiceState::AccessToken

get

The new Banafo Service Access Token.

Contains the new access token that is going to be used for requests if the new state is BanafoServiceStateType::Authorized.

Returns: The new Banafo Service Access Token

See also: State()

◆ NetworkErrorCode

int ZDK_NET::BanafoServiceState::NetworkErrorCode

get

The network error code.

Contains the network error code if the new state is BanafoServiceStateType::NetworkError. If the code is below 100 it is a CURL error code and its value can be checked here https:

If the error is above 100 it is a HTTP error code.

Returns: The network error code

See also: State()

◆ Reason

System:: String^ ZDK_NET::BanafoServiceState::Reason

get

HTTP failure reason.

Contains the HTTP failure reason.

Returns: The HTTP failure reason.

◆ RefreshToken

System:: String^ ZDK_NET::BanafoServiceState::RefreshToken

get

The new Banafo Service Refresh Token.

Contains the new refresh token that is going to be used for requests if the new state is BanafoServiceStateType::Authorized. The user may save this token to avoid new authorization upon restart.

Returns: The new Banafo Service Refresh Token

See also: State()

◆ ServiceErrorType

ZDK_NET:: BanafoServiceErrorType ZDK_NET::BanafoServiceState::ServiceErrorType

get

The Banafo Service error.

Contains the Banafo error code if the new state is BanafoServiceStateType::Error.

Returns: The Banafo Service error code

See also: State()

◆ State

ZDK_NET:: BanafoServiceStateType ZDK_NET::BanafoServiceState::State

get

The Banafo Service state.

Indicates the new state in which the Banafo Service has transitioned into.

Returns: The new Banafo Service state

See also: BanafoServiceStateType

◆ UserCode

System:: String^ ZDK_NET::BanafoServiceState::UserCode

get

The user code for Authorizing the Banafo Service verification.

Contains the new user code that has to be displayed to the end user if the new state is BanafoServiceStateType::VerifyingAuthorizing.

Returns: The user code for Authorizing the Banafo Service verification

See also: State()

◆ VerificationURI

System:: String^ ZDK_NET::BanafoServiceState::VerificationURI

get

The URI for verifying the new device.

Contains the URI where the end user have to visit to be able to verify the new device if the new state is BanafoServiceStateType::VerifyingAuthorizing.

Returns: The URI for verifying the new device

See also: State()

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

BanafoServiceState.h

Public Member Functions

Public Attributes

Properties