com.feedhenry.sdk

Class FH

java.lang.Object

com.feedhenry.sdk.FH

public class FH
extends Object

The FH class provides static methods to initialize the library, create new instances of all the API request objects, and configure global settings.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOG_LEVEL_DEBUG
static int	LOG_LEVEL_ERROR
static int	LOG_LEVEL_INFO
static int	LOG_LEVEL_NONE
static int	LOG_LEVEL_VERBOSE
static int	LOG_LEVEL_WARNING
static String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
static FHActRequest	buildActRequest(String pRemoteAction, JSONObject pParams) Deprecated.
static FHAuthRequest	buildAuthRequest() Builds an instance of FHAuthRequest object to perform an authentication request.
static FHAuthRequest	buildAuthRequest(String pPolicyId) Builds an instance of FHAuthRequest object to perform an authentication request with an auth policy id set.
static FHAuthRequest	buildAuthRequest(String pPolicyId, String pUserName, String pPassword) Builds an instance of FHAuthRequest to perform an authentication request with an auth policy id, user name, and password set.
static FHCloudRequest	buildCloudRequest(String pPath, String pMethod, cz.msebera.android.httpclient.Header[] pHeaders, JSONObject pParams) Builds an instance of FHCloudRequest to call cloud APIs.
static void	cloud(String pPath, String pMethod, cz.msebera.android.httpclient.Header[] pHeaders, JSONObject pParams, FHActCallback pCallback) Calls cloud APIs asynchronously.
static String	getCloudHost() Gets the cloud host.
static JSONObject	getDefaultParams() Gets the default params for customised HTTP Requests.
static cz.msebera.android.httpclient.Header[]	getDefaultParamsAsHeaders(cz.msebera.android.httpclient.Header[] pHeaders) Similar to getDefaultParams, but returns HTTP headers instead.
static int	getLogLevel() Gets the current log level for the FH library.
static String	getUserAgent() Gets the customized user-agent string for the SDK.
static void	init(android.content.Context pContext, FHActCallback pCallback) Initializes the application.
static boolean	isOnline()
static boolean	isReady() Checks if FH is ready.
static void	pushRegister(FHActCallback pCallback) Registers a device on a push network.
static void	pushRegister(PushConfig pPushConfig, FHActCallback pCallback) Registers a device on a push network.
static void	sendPushMetrics(String pMessageId, FHActCallback pCallback) Sends confirmation a message was opened.
static void	setLogLevel(int pLogLevel) Sets the log level for the library.
static void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

LOG_LEVEL_VERBOSE

public static final int LOG_LEVEL_VERBOSE

See Also:

Constant Field Values

LOG_LEVEL_DEBUG

public static final int LOG_LEVEL_DEBUG

See Also:

Constant Field Values

LOG_LEVEL_INFO

public static final int LOG_LEVEL_INFO

See Also:

Constant Field Values

LOG_LEVEL_WARNING

public static final int LOG_LEVEL_WARNING

See Also:

Constant Field Values

LOG_LEVEL_ERROR

public static final int LOG_LEVEL_ERROR

See Also:

Constant Field Values

LOG_LEVEL_NONE

public static final int LOG_LEVEL_NONE

See Also:

Constant Field Values

VERSION

public static final String VERSION

See Also:

Constant Field Values

Method Detail

init

public static void init(android.content.Context pContext,
        FHActCallback pCallback)

Initializes the application. This must be called before the application can use the FH library. The initialization process happens in a background thread so that the UI thread won't be blocked. If you need to call other FH API methods, you need to make sure they are called after the init finishes. The best way to do it is to provide a FHActCallback instance and implement the success method. The callback functions are invoked on the main UI thread. For example, in your main activity class's onCreate method, you can do this:

 FH.init(this, new FHActCallback() {
    public void success(FHResponse pRes) {
      //pRes will be null for init call if it succeeds, don't use it to access response data
      FHActRequest request = FH.buildActRequest("readData", new JSONObject());
      request.executeAsync(new FHActCallback(){
        public void success(FHResponse pResp){
          //process response data
        }

        public void fail(FHResponse pResp){
          //process error data
        }
      })
    }

    public void fail(FHResponse pRes) {
      Log.e("FHInit", pRes.getErrorMessage(), pRes.getError());
    }
  });
 
 

Parameters:

pContext - your application's context

pCallback - the callback function to be executed after initialization is finished

isOnline

public static boolean isOnline()

stop

public static void stop()

isReady

public static boolean isReady()

Checks if FH is ready.

Returns:

whether FH has finished initialization

buildActRequest

@Deprecated
public static FHActRequest buildActRequest(String pRemoteAction,
                                      JSONObject pParams)
                                    throws FHNotReadyException

Deprecated.

Throws:

FHNotReadyException

buildAuthRequest

public static FHAuthRequest buildAuthRequest()
                                      throws FHNotReadyException

Builds an instance of FHAuthRequest object to perform an authentication request.

Returns:

an instance of FHAuthRequest

Throws:

FHNotReadyException - if init has not been called

buildAuthRequest

public static FHAuthRequest buildAuthRequest(String pPolicyId)
                                      throws FHNotReadyException

Builds an instance of FHAuthRequest object to perform an authentication request with an auth policy id set.

Parameters:

pPolicyId - the auth policy id used by this auth request

Returns:

an instance of FHAuthRequest

Throws:

FHNotReadyException - if init has not been called

buildAuthRequest

public static FHAuthRequest buildAuthRequest(String pPolicyId,
                             String pUserName,
                             String pPassword)
                                      throws FHNotReadyException

Builds an instance of FHAuthRequest to perform an authentication request with an auth policy id, user name, and password set.

Parameters:

pPolicyId - the auth policy id used by this auth request

pUserName - the required user name for the auth request

pPassword - the required password for the auth request

Returns:

an instance of FHAuthRequest

Throws:

FHNotReadyException - if init has not been called

buildCloudRequest

public static FHCloudRequest buildCloudRequest(String pPath,
                               String pMethod,
                               cz.msebera.android.httpclient.Header[] pHeaders,
                               JSONObject pParams)
                                        throws FHNotReadyException

Builds an instance of FHCloudRequest to call cloud APIs.

Parameters:

pPath - the path of the cloud API

pMethod - currently supports GET, POST, PUT and DELETE

pHeaders - headers need to be set, can be null

pParams - the request params, can be null

Returns:

an instance of FHCloudRequest

Throws:

FHNotReadyException - if init has not been called

IllegalArgumentException - if pMethod is not one of GET, POST, PUT or DELETE

getCloudHost

public static String getCloudHost()
                           throws FHNotReadyException

Gets the cloud host.

Returns:

the cloud host of the app

Throws:

FHNotReadyException - if init has not been called

getDefaultParams

public static JSONObject getDefaultParams()

Gets the default params for customised HTTP Requests. These params will be required to enable app analytics on the FH platform. You can either add the params to your request body as a JSONObject with the key "__fh", or use the getDefaultParamsAsHeaders method to add them as HTTP request headers.

Returns:

a JSONObject contains the default params

Throws:

IllegalStateException - if the app property file is not loaded

getDefaultParamsAsHeaders

public static cz.msebera.android.httpclient.Header[] getDefaultParamsAsHeaders(cz.msebera.android.httpclient.Header[] pHeaders)

Similar to getDefaultParams, but returns HTTP headers instead.

Parameters:

pHeaders - existing headers

Returns:

new headers by combining existing headers and default headers

Throws:

IllegalStateException - if the app property file is not loaded

cloud

public static void cloud(String pPath,
         String pMethod,
         cz.msebera.android.httpclient.Header[] pHeaders,
         JSONObject pParams,
         FHActCallback pCallback)
                  throws FHNotReadyException

Calls cloud APIs asynchronously.

Parameters:

pPath - the path to the cloud API

pMethod - currently supports GET, POST, PUT and DELETE

pHeaders - headers need to be set, can be null

pParams - the request params, can be null. Will be converted to query strings depending on the HTTP method

pCallback - the callback to be executed when the cloud call is finished

Throws:

FHNotReadyException - if init has not been called

IllegalArgumentException - if pMethod is not one of GET, POST, PUT and DELETE

setLogLevel

public static void setLogLevel(int pLogLevel)

Sets the log level for the library. The default level is LOG_LEVEL_ERROR. Please make sure this is set to LOG_LEVEL_ERROR or LOG_LEVEL_NONE before releasing the application. The log level can be one of

• LOG_LEVEL_VERBOSE
• LOG_LEVEL_DEBUG
• LOG_LEVEL_INFO
• LOG_LEVEL_WARNING
• LOG_LEVEL_ERROR
• LOG_LEVEL_NONE

Parameters:

pLogLevel - The level of logging for the FH library

getLogLevel

public static int getLogLevel()

Gets the current log level for the FH library.

Returns:

The current log level

getUserAgent

public static String getUserAgent()

Gets the customized user-agent string for the SDK.

Returns:

customized user-agent string

pushRegister

public static void pushRegister(FHActCallback pCallback)

Registers a device on a push network. The push information will be loaded from fhconfig.properties. This method need to be called after an init(android.content.Context, FHActCallback) success callback.

Parameters:

pCallback - the pCallback function to be executed after the device registration is finished

pushRegister

public static void pushRegister(PushConfig pPushConfig,
                FHActCallback pCallback)

Registers a device on a push network. The push information will be loaded from fhconfig.properties. This method need to be called after an init(android.content.Context, FHActCallback) success callback.

Parameters:

pPushConfig - extra configuration for push

pCallback - the pCallback function to be executed after the device registration is finished

sendPushMetrics

public static void sendPushMetrics(String pMessageId,
                   FHActCallback pCallback)

Sends confirmation a message was opened.

Parameters:

pMessageId - Id of the message received

pCallback - the pCallback function to be executed after the metrics sent