com.zoiper.zdk

Class BanafoServiceState

java.lang.Object

com.zoiper.zdk.BanafoServiceState

public class BanafoServiceState
extends java.lang.Object

Banafo Service state Describes the current full state of the Banafo Service.

Constructor Summary

Constructors

Constructor and Description
BanafoServiceState(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
java.lang.String	accessToken() 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.
protected void	finalize() Ensures the underlying native object destruction
long	handle() Gets the pointer/address to the underlying native object
int	networkErrorCode() The network error code Contains the network error code if the new state is BanafoServicestateType::NetworkError.
java.lang.String	reason() HTTP failure reason.
java.lang.String	refreshToken() 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.
BanafoServiceErrorType	serviceErrorType() The Banafo Service error Contains the Banafo error code if the new state is BanafoServicestateType::Error.
BanafoServiceStateType	state() The Banafo Service state Indicates the new state in which the Banafo Service has transitioned into.
java.lang.String	userCode() 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.
java.lang.String	verificationURI() 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.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BanafoServiceState

public BanafoServiceState(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

state

public BanafoServiceStateType state()

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

networkErrorCode

public int networkErrorCode()

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

serviceErrorType

public BanafoServiceErrorType serviceErrorType()

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

reason

public java.lang.String reason()

HTTP failure reason. Contains the HTTP failure reason.

Returns:

The HTTP failure reason.

accessToken

public java.lang.String accessToken()

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

refreshToken

public java.lang.String refreshToken()

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

userCode

public java.lang.String userCode()

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

public java.lang.String verificationURI()

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