io.branch.referral

Class BranchRemoteInterface

java.lang.Object

io.branch.referral.BranchRemoteInterface

public class BranchRemoteInterface
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BRANCH_KEY
static int	NO_BRANCH_KEY_STATUS
static int	NO_CONNECTIVITY_STATUS
protected PrefHelper	prefHelper_ A PrefHelper object that is used throughout the class to allow access to read and write preferences related to the SDK.

Constructor Summary

Constructors

Constructor and Description
BranchRemoteInterface() Required, but empty constructor method.
BranchRemoteInterface(android.content.Context context) The main constructor of the BranchRemoteInterface class.

Method Summary

Methods

Modifier and Type	Method and Description
void	connectToDebug() Connect to server debug endpoint.
ServerResponse	createCustomUrlSync(org.json.JSONObject post) Create custom URL, and return the server response for use elsewhere within the app.
void	disconnectFromDebug() Disconnect from the server debug interface.
io.branch.referral.SystemObserver	getSystemObserver()
ServerResponse	make_restful_get(java.lang.String url, org.json.JSONObject params, java.lang.String tag, int timeout) Make a RESTful GET request, by calling make_restful_get(String, JSONObject, String, int, int, boolean) with the logging Boolean parameter pre-populated.
ServerResponse	make_restful_post(org.json.JSONObject body, java.lang.String url, java.lang.String tag, int timeout) Makes a RESTful POST call with logging enabled, without an associated data dictionary; passed as null.
ServerResponse	make_restful_post(org.json.JSONObject body, java.lang.String url, java.lang.String tag, int timeout, boolean log) Makes a RESTful POST call without an associated data dictionary; passed as null.
ServerResponse	make_restful_post(org.json.JSONObject body, java.lang.String url, java.lang.String tag, int timeout, io.branch.referral.BranchLinkData linkData) Makes a RESTful POST call with logging enabled.
void	sendLog(java.lang.String log) Log messages to the server's debug interface.
void	setNetworkCallbackListener(io.branch.referral.NetworkCallback callback) Sets a callback listener to handle network events received during this app session.

Methods inherited from class java.lang.Object

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

Field Detail

BRANCH_KEY

public static final java.lang.String BRANCH_KEY

See Also:

Constant Field Values

NO_CONNECTIVITY_STATUS

public static final int NO_CONNECTIVITY_STATUS

See Also:

Constant Field Values

NO_BRANCH_KEY_STATUS

public static final int NO_BRANCH_KEY_STATUS

See Also:

Constant Field Values

prefHelper_

protected PrefHelper prefHelper_

A PrefHelper object that is used throughout the class to allow access to read and write preferences related to the SDK.

See Also:

PrefHelper

Constructor Detail

BranchRemoteInterface

public BranchRemoteInterface()

Required, but empty constructor method.

Use BranchRemoteInterface(Context) instead, as it instantiates the class PrefHelper and SystemObserver handles for the class.

BranchRemoteInterface

public BranchRemoteInterface(android.content.Context context)

The main constructor of the BranchRemoteInterface class.

Parameters:

context - A Context from which this call was made.

Method Detail

setNetworkCallbackListener

public void setNetworkCallbackListener(io.branch.referral.NetworkCallback callback)

Sets a callback listener to handle network events received during this app session.

Parameters:

callback - A NetworkCallback object instance that will be triggered for each network event that occurs during this app session.

createCustomUrlSync

public ServerResponse createCustomUrlSync(org.json.JSONObject post)

Create custom URL, and return the server response for use elsewhere within the app.

Parameters:

post - A JSONObject containing post data key-value-pairs.

Returns:

A ServerResponse object containing the Branch API response to the request.

connectToDebug

public void connectToDebug()

Connect to server debug endpoint.

disconnectFromDebug

public void disconnectFromDebug()

Disconnect from the server debug interface.

sendLog

public void sendLog(java.lang.String log)

Log messages to the server's debug interface.

Parameters:

log - A String variable containing information to log.

getSystemObserver

public io.branch.referral.SystemObserver getSystemObserver()

make_restful_get

public ServerResponse make_restful_get(java.lang.String url,
                              org.json.JSONObject params,
                              java.lang.String tag,
                              int timeout)

Make a RESTful GET request, by calling make_restful_get(String, JSONObject, String, int, int, boolean) with the logging Boolean parameter pre-populated.

Parameters:

url - A String URL to request from.

params - A JSONObject with additional parameters and their values to send with the get request.

tag - A String tag for logging/analytics purposes.

timeout - An Integer value containing the number of milliseconds to wait before considering a server request to have timed out.

Returns:

A ServerResponse object containing the result of the RESTful request.

make_restful_post

public ServerResponse make_restful_post(org.json.JSONObject body,
                               java.lang.String url,
                               java.lang.String tag,
                               int timeout)

Makes a RESTful POST call with logging enabled, without an associated data dictionary; passed as null.

Parameters:

body - A JSONObject containing the main data body/payload of the request.

url - A String URL to request from.

tag - A String tag for logging/analytics purposes.

timeout - An Integer value containing the number of milliseconds to wait before considering a server request to have timed out.

Returns:

A ServerResponse object representing the HttpURLConnection response in Branch SDK terms.

make_restful_post

public ServerResponse make_restful_post(org.json.JSONObject body,
                               java.lang.String url,
                               java.lang.String tag,
                               int timeout,
                               io.branch.referral.BranchLinkData linkData)

Makes a RESTful POST call with logging enabled.

Parameters:

body - A JSONObject containing the main data body/payload of the request.

url - A String URL to request from.

tag - A String tag for logging/analytics purposes.

timeout - An Integer value containing the number of milliseconds to wait before considering a server request to have timed out.

linkData - A BranchLinkData object containing the data dictionary associated with the link subject of the original server request.

Returns:

A ServerResponse object representing the HttpURLConnection response in Branch SDK terms.

make_restful_post

public ServerResponse make_restful_post(org.json.JSONObject body,
                               java.lang.String url,
                               java.lang.String tag,
                               int timeout,
                               boolean log)

Makes a RESTful POST call without an associated data dictionary; passed as null.

Parameters:

body - A JSONObject containing the main data body/payload of the request.

url - A String URL to request from.

tag - A String tag for logging/analytics purposes.

timeout - An Integer value containing the number of milliseconds to wait before considering a server request to have timed out.

log - A Boolean value that specifies whether debug logging should be enabled for this request or not.

Returns:

A ServerResponse object representing the HttpURLConnection response in Branch SDK terms.