io.branch.referral

Class ServerRequestPing

java.lang.Object

io.branch.referral.ServerRequest

io.branch.referral.ServerRequestPing

public class ServerRequestPing
extends ServerRequest

*

The server request for pinging the API to process the queue.

Nested Class Summary

Nested classes/interfaces inherited from class io.branch.referral.ServerRequest

ServerRequest.BRANCH_API_VERSION

Field Summary

Fields inherited from class io.branch.referral.ServerRequest

constructError_, prefHelper_, requestPath_

Constructor Summary

Constructors

Constructor and Description
ServerRequestPing(android.content.Context context) Configures a server request to process the request queue.

Method Summary

Modifier and Type	Method and Description
void	clearCallbacks() Clears the callbacks associated to this request.
boolean	handleErrors(android.content.Context context) Should be implemented by the child class.Specifies any error associated with request.
void	handleFailure(int statusCode, java.lang.String causeMsg) Called when there is an error on executing this request.
boolean	isGetRequest() Specify whether the request is a GET or POST.
void	onRequestSucceeded(ServerResponse response, Branch branch) Called when execution of this request to server succeeds.

Methods inherited from class io.branch.referral.ServerRequest

addGetParam, addProcessWaitLock, doesAppHasInternetPermission, fromJSON, getBranchRemoteAPIVersion, getGetParams, getPost, getPostWithInstrumentationValues, getQueueWaitTime, getRequestPath, getRequestUrl, isGAdsParamsRequired, isWaitingOnProcessToFinish, onPreExecute, onRequestQueued, prepareExecuteWithoutTracking, removeProcessWaitLock, reportTrackingDisabledError, setPost, shouldRetryOnFail, shouldUpdateLimitFacebookTracking, toJSON, updateEnvironment

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerRequestPing

public ServerRequestPing(android.content.Context context)

Configures a server request to process the request queue.

Parameters:

context - Current Application context

Method Detail

handleErrors

public boolean handleErrors(android.content.Context context)

Description copied from class: ServerRequest

Should be implemented by the child class.Specifies any error associated with request. If there are errors request will not be executed.

Specified by:

handleErrors in class ServerRequest

Parameters:

context - Application context.

Returns:

A Boolean which is set to true if there are errors with this request. Child class is responsible for implementing its own logic for error check and reporting.

onRequestSucceeded

public void onRequestSucceeded(ServerResponse response,
                               Branch branch)

Description copied from class: ServerRequest

Called when execution of this request to server succeeds. Child class should implement its own logic for handling the post request execution.

Specified by:

onRequestSucceeded in class ServerRequest

Parameters:

response - A ServerResponse object containing server response for this request.

branch - Current Branch instance

handleFailure

public void handleFailure(int statusCode,
                          java.lang.String causeMsg)

Description copied from class: ServerRequest

Called when there is an error on executing this request. Child class should handle the failure accordingly.

Specified by:

handleFailure in class ServerRequest

Parameters:

statusCode - A Integer value specifying http return code or any branch specific error defined in BranchError.

causeMsg - A String value specifying cause for the error if any.

isGetRequest

public boolean isGetRequest()

Description copied from class: ServerRequest

Specify whether the request is a GET or POST. Child class has to implement accordingly.

Specified by:

isGetRequest in class ServerRequest

Returns:

A Boolean value specifying if this request is a GET or not.

clearCallbacks

public void clearCallbacks()

Description copied from class: ServerRequest

Clears the callbacks associated to this request.

Specified by:

clearCallbacks in class ServerRequest