io.branch.referral

Class ServerResponse

java.lang.Object

io.branch.referral.ServerResponse

public class ServerResponse
extends java.lang.Object

Class providing the structure of a HTTP response as recieved from the Branch API.

Supports the following methods:

• getTag()
• getStatusCode()
• setPost(Object)
• getObject()
• getArray()
• getLinkData()

Constructor Summary

Constructors

Constructor and Description
ServerResponse(java.lang.String tag, int statusCode) Constructor method for the ServerResponse class that allows for the instantiation of a server response object as a direct result of a server call.
ServerResponse(java.lang.String tag, int statusCode, io.branch.referral.BranchLinkData linkData) Main constructor method for the ServerResponse class that allows for the instantiation of a server response object as a direct result of a server call.

Method Summary

Methods

Modifier and Type	Method and Description
org.json.JSONArray	getArray() Checks whether the post data associated with the current request is an instance of a JSONArray object, and if so type-casts it to the corresponding class type.
java.lang.String	getFailReason() Get the reason for failure if there any
io.branch.referral.BranchLinkData	getLinkData() Gets a BranchLinkData object containing the data associated with the current Branch link.
org.json.JSONObject	getObject() Checks whether the post data associated with the current request is an instance of a JSONObject object, and if so type-casts it to the corresponding class type.
int	getStatusCode() Gets the HttpStatus code of the current response.
java.lang.String	getTag() Gets the String value of the Tag attribute of the current link.
void	setPost(java.lang.Object post) Sets the post data attached to the current server request, as a generic Object instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerResponse

public ServerResponse(java.lang.String tag,
              int statusCode)

Constructor method for the ServerResponse class that allows for the instantiation of a server response object as a direct result of a server call. Omits BranchLinkData , so is used where that value is null or unavailable.

Parameters:

tag - A String value of the Tag attribute of the current link.

statusCode - Integer value of the HTTP status code.

ServerResponse

public ServerResponse(java.lang.String tag,
              int statusCode,
              io.branch.referral.BranchLinkData linkData)

Main constructor method for the ServerResponse class that allows for the instantiation of a server response object as a direct result of a server call.

Parameters:

tag - A String value of the Tag attribute of the current link.

statusCode - Integer value of the HTTP status code.

linkData - A BranchLinkData object containing data attributes associated with a Branch link.

Method Detail

getTag

public java.lang.String getTag()

Gets the String value of the Tag attribute of the current link.

Returns:

A String value of the Tag attribute of the current link.

getStatusCode

public int getStatusCode()

Gets the HttpStatus code of the current response.

Returns:

Integer value of the HTTP status code.

setPost

public void setPost(java.lang.Object post)

Sets the post data attached to the current server request, as a generic Object instance. This object can be type-cast by other methods within this class:

Parameters:

post - Generic Object instance containing post data associated with current response.

getObject

public org.json.JSONObject getObject()

Checks whether the post data associated with the current request is an instance of a JSONObject object, and if so type-casts it to the corresponding class type.

Returns:

A JSONObject containing the post data sent with a server request, or a null value if the post data is not of the JSONObject type.

getArray

public org.json.JSONArray getArray()

Checks whether the post data associated with the current request is an instance of a JSONArray object, and if so type-casts it to the corresponding class type.

Returns:

A JSONArray containing the post data sent with a server request, or a null value if the post data is not of the JSONArray type.

getLinkData

public io.branch.referral.BranchLinkData getLinkData()

Gets a BranchLinkData object containing the data associated with the current Branch link.

Returns:

a BranchLinkData object containing data attributes associated with a Branch link.

getFailReason

public java.lang.String getFailReason()

Get the reason for failure if there any

Returns:

A String value with failure reason