io.branch.referral

Class BranchError

java.lang.Object

io.branch.referral.BranchError

public class BranchError
extends java.lang.Object

Returns a general error if the server back-end is down.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERR_API_LVL_14_NEEDED
static int	ERR_BRANCH_DUPLICATE_REFERRAL_CODE
static int	ERR_BRANCH_DUPLICATE_URL
static int	ERR_BRANCH_INIT_FAILED
static int	ERR_BRANCH_INVALID_REQUEST
static int	ERR_BRANCH_KEY_INVALID
static int	ERR_BRANCH_NO_CONNECTIVITY
static int	ERR_BRANCH_NO_SHARE_OPTION
static int	ERR_BRANCH_NOT_INSTANTIATED
static int	ERR_BRANCH_REDEEM_REWARD
static int	ERR_BRANCH_REQ_TIMED_OUT
static int	ERR_BRANCH_RESOURCE_CONFLICT
static int	ERR_BRANCH_TRACKING_DISABLED
static int	ERR_BRANCH_UNABLE_TO_REACH_SERVERS
static int	ERR_INVALID_REFERRAL_CODE
static int	ERR_NO_INTERNET_PERMISSION
static int	ERR_NO_SESSION

Constructor Summary

Constructors

Constructor and Description
BranchError(java.lang.String failMsg, int statusCode)

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Returns an error code for this Branch Error.
java.lang.String	getMessage() Returns the message explaining the error.
java.lang.String	toString() Overridden toString method for this object; returns the error message rather than the object's address.

Methods inherited from class java.lang.Object

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

Field Detail

ERR_NO_SESSION

public static final int ERR_NO_SESSION

See Also:

Constant Field Values

ERR_NO_INTERNET_PERMISSION

public static final int ERR_NO_INTERNET_PERMISSION

See Also:

Constant Field Values

ERR_INVALID_REFERRAL_CODE

public static final int ERR_INVALID_REFERRAL_CODE

See Also:

Constant Field Values

ERR_BRANCH_INIT_FAILED

public static final int ERR_BRANCH_INIT_FAILED

See Also:

Constant Field Values

ERR_BRANCH_DUPLICATE_URL

public static final int ERR_BRANCH_DUPLICATE_URL

See Also:

Constant Field Values

ERR_BRANCH_DUPLICATE_REFERRAL_CODE

public static final int ERR_BRANCH_DUPLICATE_REFERRAL_CODE

See Also:

Constant Field Values

ERR_BRANCH_REDEEM_REWARD

public static final int ERR_BRANCH_REDEEM_REWARD

See Also:

Constant Field Values

ERR_API_LVL_14_NEEDED

public static final int ERR_API_LVL_14_NEEDED

See Also:

Constant Field Values

ERR_BRANCH_NOT_INSTANTIATED

public static final int ERR_BRANCH_NOT_INSTANTIATED

See Also:

Constant Field Values

ERR_BRANCH_NO_SHARE_OPTION

public static final int ERR_BRANCH_NO_SHARE_OPTION

See Also:

Constant Field Values

ERR_BRANCH_REQ_TIMED_OUT

public static final int ERR_BRANCH_REQ_TIMED_OUT

See Also:

Constant Field Values

ERR_BRANCH_UNABLE_TO_REACH_SERVERS

public static final int ERR_BRANCH_UNABLE_TO_REACH_SERVERS

See Also:

Constant Field Values

ERR_BRANCH_NO_CONNECTIVITY

public static final int ERR_BRANCH_NO_CONNECTIVITY

See Also:

Constant Field Values

ERR_BRANCH_KEY_INVALID

public static final int ERR_BRANCH_KEY_INVALID

See Also:

Constant Field Values

ERR_BRANCH_RESOURCE_CONFLICT

public static final int ERR_BRANCH_RESOURCE_CONFLICT

See Also:

Constant Field Values

ERR_BRANCH_INVALID_REQUEST

public static final int ERR_BRANCH_INVALID_REQUEST

See Also:

Constant Field Values

ERR_BRANCH_TRACKING_DISABLED

public static final int ERR_BRANCH_TRACKING_DISABLED

See Also:

Constant Field Values

Constructor Detail

BranchError

public BranchError(java.lang.String failMsg,
                   int statusCode)

Method Detail

getMessage

public java.lang.String getMessage()

Returns the message explaining the error.

Returns:

A String value that can be used in error logging or for dialog display to the user.

getErrorCode

public int getErrorCode()

Returns an error code for this Branch Error.

Returns:

An Integer specifying the error code for this error. Value will be one of the error code defined in branch errors.

toString

public java.lang.String toString()

Overridden toString method for this object; returns the error message rather than the object's address.

Overrides:

toString in class java.lang.Object

Returns:

A String value representing the object's current state.