zdk.objc
Instance Methods | Properties | List of all members
<ZDKBanafoServiceState> Protocol Reference

Banafo Service state. More...

#import <ZDKBanafoServiceState.h>

Inheritance diagram for <ZDKBanafoServiceState>:
<ZDKZHandle>

Instance Methods

(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKZHandle>
(long int) - handle
 
(void) - initialize
 
(void) - releaseReference
 
(NSString *) - handlesDescription
 

Properties

ZDKBanafoServiceStateType state
 The Banafo Service state. More...
 
int networkErrorCode
 The network error code. More...
 
ZDKBanafoServiceErrorType serviceErrorType
 The Banafo Service error. More...
 
NSString *_Nullable reason
 HTTP failure reason. More...
 
NSString *_Nullable accessToken
 The new Banafo Service Access Token. More...
 
NSString *_Nullable refreshToken
 The new Banafo Service Refresh Token. More...
 
NSString *_Nullable userCode
 The user code for Authorizing the Banafo Service verification. More...
 
NSString *_Nullable verificationURI
 The URI for verifying the new device. More...
 

Detailed Description

Banafo Service state.

Describes the current full state of the Banafo Service.

Method Documentation

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

Property Documentation

◆ accessToken

- (NSString* _Nullable) accessToken
readnonatomicassign

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) networkErrorCode
readnonatomicassign

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

- (NSString* _Nullable) reason
readnonatomicassign

HTTP failure reason.

Contains the HTTP failure reason.

Returns
The HTTP failure reason.

◆ refreshToken

- (NSString* _Nullable) refreshToken
readnonatomicassign

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

- (ZDKBanafoServiceErrorType) serviceErrorType
readnonatomicassign

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

- (ZDKBanafoServiceStateType) state
readnonatomicassign

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

- (NSString* _Nullable) userCode
readnonatomicassign

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

- (NSString* _Nullable) verificationURI
readnonatomicassign

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 protocol was generated from the following file: