Overview
Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
I
L
M
N
O
P
R
S
T
U
V
A
APP_APIKEY_KEY
- Static variable in class com.feedhenry.sdk.
FH
APP_CONNECTION_TAG_KEY
- Static variable in class com.feedhenry.sdk.
FH
APP_HOST_KEY
- Static variable in class com.feedhenry.sdk.
FH
APP_ID_KEY
- Static variable in class com.feedhenry.sdk.
FH
APP_MODE_KEY
- Static variable in class com.feedhenry.sdk.
FH
APP_PROJECT_KEY
- Static variable in class com.feedhenry.sdk.
FH
B
BROADCAST_ACTION_FILTER
- Static variable in class com.feedhenry.sdk.oauth.
FHOAuthWebView
buildActRequest(String, JSONObject)
- Static method in class com.feedhenry.sdk.
FH
Deprecated.
buildAuthRequest()
- Static method in class com.feedhenry.sdk.
FH
Build an instance of FHAuthRequest object to perform authentication request.
buildAuthRequest(String)
- Static method in class com.feedhenry.sdk.
FH
Build an instance of FHAuthRequest object to perform authentication request and set the auth policy id
buildAuthRequest(String, String, String)
- Static method in class com.feedhenry.sdk.
FH
Build an instance of FHAuthRequest object to perform authentication request and set the auth policy id, user name and passowrd
buildCloudRequest(String, String, Header[], JSONObject)
- Static method in class com.feedhenry.sdk.
FH
Build an instance of FHCloudRequest object to call cloud APIs
buildHeaders(Header[])
- Method in class com.feedhenry.sdk.api.
FHActRequest
buildHeaders(Header[])
- Method in class com.feedhenry.sdk.api.
FHAuthRequest
buildHeaders(Header[])
- Method in class com.feedhenry.sdk.api.
FHCloudRequest
buildHeaders(Header[])
- Method in class com.feedhenry.sdk.
FHRemote
C
CLIENT_STORAGE_FAILED_CODE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
CLIENT_STORAGE_FAILED_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
clone()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
close()
- Method in class com.feedhenry.sdk.oauth.
FHOAuthWebView
cloud(String, String, Header[], JSONObject, FHActCallback)
- Static method in class com.feedhenry.sdk.
FH
Call cloud APIs asynchronously.
CloudProps
- Class in
com.feedhenry.sdk
CloudProps(Properties, JSONObject)
- Constructor for class com.feedhenry.sdk.
CloudProps
COLLISION_DETECTED_CDOE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
COLLISION_DETECTED_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
com.feedhenry.sdk
- package com.feedhenry.sdk
com.feedhenry.sdk.api
- package com.feedhenry.sdk.api
com.feedhenry.sdk.exceptions
- package com.feedhenry.sdk.exceptions
com.feedhenry.sdk.oauth
- package com.feedhenry.sdk.oauth
com.feedhenry.sdk.sync
- package com.feedhenry.sdk.sync
create(String, JSONObject)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Create a new data record in dataset with pDataId
D
delete(String, String)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Delete a data record in the dataset with pDataId
DELTA_RECEIVED_CODE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
DELTA_RECEIVED_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
destroy()
- Method in class com.feedhenry.sdk.oauth.
FHOAuthWebView
destroy()
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Stop all sync processes for all the datasets managed by the sync client.
E
equals(FHCloudRequest.Methods)
- Method in enum com.feedhenry.sdk.api.
FHCloudRequest.Methods
executeAsync(FHActCallback)
- Method in class com.feedhenry.sdk.api.
FHAuthRequest
executeAsync(FHActCallback)
- Method in class com.feedhenry.sdk.api.
FHCloudRequest
executeAsync()
- Method in interface com.feedhenry.sdk.
FHAct
Execute the request asynchronously.
executeAsync(FHActCallback)
- Method in interface com.feedhenry.sdk.
FHAct
Execute the request asynchronously.
executeAsync()
- Method in class com.feedhenry.sdk.
FHRemote
executeAsync(FHActCallback)
- Method in class com.feedhenry.sdk.
FHRemote
F
fail(FHResponse)
- Method in interface com.feedhenry.sdk.
FHActCallback
Will be run if the action call is failed
FH
- Class in
com.feedhenry.sdk
The FH class provides static methods to initialize the library, create new instance of all the API request objects and configure global settings.
FHAct
- Interface in
com.feedhenry.sdk
Representing a request call to FeedHenry.
FHActCallback
- Interface in
com.feedhenry.sdk
A FHActCallback will be used to execute code after a FH API request finishes running on a background thread.
FHActRequest
- Class in
com.feedhenry.sdk.api
The request for calling the cloud side function of the app.
FHActRequest(Context, CloudProps)
- Constructor for class com.feedhenry.sdk.api.
FHActRequest
Constructor
FHAuthRequest
- Class in
com.feedhenry.sdk.api
The request for calling the authentication function.
FHAuthRequest(Context, Properties)
- Constructor for class com.feedhenry.sdk.api.
FHAuthRequest
Constructor
FHCloudRequest
- Class in
com.feedhenry.sdk.api
FHCloudRequest(Context, CloudProps)
- Constructor for class com.feedhenry.sdk.api.
FHCloudRequest
FHCloudRequest.Methods
- Enum in
com.feedhenry.sdk.api
FHNotReadyException
- Exception in
com.feedhenry.sdk.exceptions
This exception will be thrown if an FH API method is called before FH.init finishes.
FHNotReadyException()
- Constructor for exception com.feedhenry.sdk.exceptions.
FHNotReadyException
FHOAuthIntent
- Class in
com.feedhenry.sdk.oauth
An intent wrapper for the webview
FHOAuthIntent()
- Constructor for class com.feedhenry.sdk.oauth.
FHOAuthIntent
FHOAuthWebView
- Class in
com.feedhenry.sdk.oauth
Construct a WebView window and load a url request.
FHOAuthWebView(Activity, Bundle)
- Constructor for class com.feedhenry.sdk.oauth.
FHOAuthWebView
FHRemote
- Class in
com.feedhenry.sdk
The base class that implements
FHAct
.
FHRemote(Context, Properties)
- Constructor for class com.feedhenry.sdk.
FHRemote
FHResponse
- Class in
com.feedhenry.sdk
Representing the response data from FeedHenry when an API call is finished
FHResponse(JSONObject, JSONArray, Throwable, String)
- Constructor for class com.feedhenry.sdk.
FHResponse
FHSyncClient
- Class in
com.feedhenry.sdk.sync
The sync client is part of the FeedHenry data sync framework.
FHSyncClient()
- Constructor for class com.feedhenry.sdk.sync.
FHSyncClient
FHSyncConfig
- Class in
com.feedhenry.sdk.sync
The configuration options for the sync framework.
FHSyncConfig()
- Constructor for class com.feedhenry.sdk.sync.
FHSyncConfig
FHSyncListener
- Interface in
com.feedhenry.sdk.sync
Implement the listener interface to monitor events invoked by the sync framework.
fromJSON(JSONObject)
- Static method in class com.feedhenry.sdk.sync.
FHSyncConfig
Create a new configuration object from JSON.
G
getApiURl()
- Method in class com.feedhenry.sdk.api.
FHActRequest
getApiURl()
- Method in class com.feedhenry.sdk.
FHRemote
getAppProperties()
- Method in class com.feedhenry.sdk.
CloudProps
getArray()
- Method in class com.feedhenry.sdk.
FHResponse
Get the response data as JSONArray
getCloudHost()
- Method in class com.feedhenry.sdk.
CloudProps
Return the cloud host of the app
getCloudHost()
- Static method in class com.feedhenry.sdk.
FH
Get the cloud host after app finish initialising
getCode()
- Method in class com.feedhenry.sdk.sync.
NotificationMessage
The code message associated with the event
getCrashCountWait()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Get the maximum crash count.
getDataId()
- Method in class com.feedhenry.sdk.sync.
NotificationMessage
The id of the dataset associated with the event
getDefaultParams()
- Static method in class com.feedhenry.sdk.
FH
Get the default params for customised HTTP Requests.
getDefaultParamsAsHeaders(Header[])
- Static method in class com.feedhenry.sdk.
FH
Similar to
getDefaultParams
, but return HTTP headers instead
getError()
- Method in class com.feedhenry.sdk.
FHResponse
Get the error
getErrorMessage()
- Method in class com.feedhenry.sdk.
FHResponse
Get the error message
getInstance()
- Static method in class com.feedhenry.sdk.sync.
FHSyncClient
Get the singleton instance of the sync client.
getJson()
- Method in class com.feedhenry.sdk.
FHResponse
Get the response data as JSONObject
getJSON()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
JSON representation of the configuration object
getLogLevel()
- Static method in class com.feedhenry.sdk.
FH
Get the current log level for the FH library
getMessage()
- Method in class com.feedhenry.sdk.sync.
NotificationMessage
Extra message associated with the event
getMessage(String, String, int, String)
- Static method in class com.feedhenry.sdk.sync.
NotificationMessage
getPath()
- Method in class com.feedhenry.sdk.api.
FHActRequest
getPath()
- Method in class com.feedhenry.sdk.api.
FHAuthRequest
getPath()
- Method in class com.feedhenry.sdk.api.
FHCloudRequest
getPath()
- Method in class com.feedhenry.sdk.
FHRemote
getRawResponse()
- Method in class com.feedhenry.sdk.
FHResponse
Get the raw response content
getRequestArgs()
- Method in class com.feedhenry.sdk.api.
FHActRequest
getRequestArgs()
- Method in class com.feedhenry.sdk.api.
FHAuthRequest
getRequestArgs()
- Method in class com.feedhenry.sdk.api.
FHCloudRequest
getRequestArgs()
- Method in class com.feedhenry.sdk.
FHRemote
getSyncFrequency()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Get the current sync interval
getUID()
- Method in class com.feedhenry.sdk.sync.
NotificationMessage
The id of the data record associated with the event
getUserAgent()
- Static method in class com.feedhenry.sdk.
FH
Get the customized user-agent string for the SDK
getView()
- Method in class com.feedhenry.sdk.oauth.
FHOAuthWebView
I
init(Context, FHActCallback)
- Static method in class com.feedhenry.sdk.
FH
Initialize the application.
init(Context, FHSyncConfig, FHSyncListener)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Initialize the sync client.
isAutoSyncLocalUpdates()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client automatically update local changes
isNotifyClientStorageFailed()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify client storage failed event
isNotifyDeltaReceived()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify delta received event
isNotifyLocalUpdateApplied()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify local updates applied event
isNotifyOfflineUpdate()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify offline update event
isNotifyRemoteUpdateApplied()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify remote updates applied event
isNotifySyncCollisions()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify sync collision event
isNotifySyncComplete()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify sync complete event
isNotifySyncFailed()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify sync failed event
isNotifySyncStarted()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify sync start event
isNotifyUpdateFailed()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Does the sync client notify update failed event
isOnline()
- Static method in class com.feedhenry.sdk.
FH
isReady()
- Static method in class com.feedhenry.sdk.
FH
Check if FH is ready
isResendCrashedUpdates()
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
If the crash limit is reached, should the changes be re-submitted or abandoned.
L
list(String)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
List all the data in the dataset with pDataId.
listCollisions(String, FHActCallback)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
List sync collisions in dataset with id pDataId
LOCAL_UPDATE_APPLIED_CODE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
LOCAL_UPDATE_APPLIED_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
LOG_LEVEL_DEBUG
- Static variable in class com.feedhenry.sdk.
FH
LOG_LEVEL_ERROR
- Static variable in class com.feedhenry.sdk.
FH
LOG_LEVEL_INFO
- Static variable in class com.feedhenry.sdk.
FH
LOG_LEVEL_NONE
- Static variable in class com.feedhenry.sdk.
FH
LOG_LEVEL_VERBOSE
- Static variable in class com.feedhenry.sdk.
FH
LOG_LEVEL_WARNING
- Static variable in class com.feedhenry.sdk.
FH
LOG_TAG
- Static variable in class com.feedhenry.sdk.api.
FHActRequest
LOG_TAG
- Static variable in class com.feedhenry.sdk.api.
FHAuthRequest
LOG_TAG
- Static variable in class com.feedhenry.sdk.api.
FHCloudRequest
LOG_TAG
- Static variable in class com.feedhenry.sdk.
FHRemote
LOG_TAG
- Static variable in class com.feedhenry.sdk.sync.
FHSyncClient
M
manage(String, FHSyncConfig, JSONObject)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Use the sync client to manage a dataset.
mArgs
- Variable in class com.feedhenry.sdk.api.
FHActRequest
mCallback
- Variable in class com.feedhenry.sdk.
FHRemote
mContext
- Variable in class com.feedhenry.sdk.
FHRemote
mProperties
- Variable in class com.feedhenry.sdk.
FHRemote
mUDID
- Variable in class com.feedhenry.sdk.
FHRemote
N
NotificationMessage
- Class in
com.feedhenry.sdk.sync
The message object sent to the listener when an event happened.
NotificationMessage(String, String, String, String)
- Constructor for class com.feedhenry.sdk.sync.
NotificationMessage
O
OFFLINE_UPDATE_CODE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
OFFLINE_UPDATE_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
onClientStorageFailed(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a client storage failed event is emitted.
onCollisionDetected(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a collision event is emitted.
onCreate(Bundle)
- Method in class com.feedhenry.sdk.oauth.
FHOAuthIntent
onCreate()
- Method in class com.feedhenry.sdk.oauth.
FHOAuthWebView
onDeltaReceived(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a delta received event is emitted.
onKeyDown(int, KeyEvent)
- Method in class com.feedhenry.sdk.oauth.
FHOAuthIntent
onLocalUpdateApplied(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a local update applied event is emitted.
onRemoteUpdateApplied(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a remote update event is emitted.
onRemoteUpdateFailed(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a remote update failed event is emitted.
onSyncCompleted(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a sync loop complete event is emitted
onSyncFailed(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a sync failed event is emitted.
onSyncStarted(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a sync loop start event is emitted
onUpdateOffline(NotificationMessage)
- Method in interface com.feedhenry.sdk.sync.
FHSyncListener
Invoked when a offline update event is emitted.
P
parse(String)
- Static method in enum com.feedhenry.sdk.api.
FHCloudRequest.Methods
PATH_PREFIX
- Static variable in class com.feedhenry.sdk.
FHRemote
R
read(String, String)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Read a data record with pUID in dataset with pDataId
REMOTE_UPDATE_APPLIED_CODE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
REMOTE_UPDATE_APPLIED_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
REMOTE_UPDATE_FAILED_CDOE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
REMOTE_UPDATE_FAILED_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
removeCollision(String, String, FHActCallback)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Remove a sync collision record in the dataset with id pDataId
S
setArgs(JSONObject)
- Method in class com.feedhenry.sdk.api.
FHActRequest
Set the parameters for the cloud side function
setAuthPolicyId(String)
- Method in class com.feedhenry.sdk.api.
FHAuthRequest
Set the policy id for this auth request
setAuthUser(String, String, String)
- Method in class com.feedhenry.sdk.api.
FHAuthRequest
Set the user name for the auth request.
setAutoSyncLocalUpdates(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should automatically update local changes
setCallback(FHActCallback)
- Method in interface com.feedhenry.sdk.
FHAct
Set the callback function to be executed when the action is finished.
setCallback(FHActCallback)
- Method in class com.feedhenry.sdk.
FHRemote
setCrashCountWait(int)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set the maximum crash count number.
setHeaders(Header[])
- Method in class com.feedhenry.sdk.api.
FHCloudRequest
setListener(FHSyncListener)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Re-set the sync listener
setLogLevel(int)
- Static method in class com.feedhenry.sdk.
FH
Set the log level for the library.
setMethod(FHCloudRequest.Methods)
- Method in class com.feedhenry.sdk.api.
FHCloudRequest
setNotifyClientStorageFailed(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify client storage failed event
setNotifyDeltaReceived(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify delta received event
setNotifyLocalUpdateApplied(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify local updates applied event
setNotifyOfflineUpdate(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client notify offline update event.
setNotifyRemoteUpdateApplied(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify remote updates applied event
setNotifySyncCollisions(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify sync collision event
setNotifySyncComplete(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify complete event
setNotifySyncFailed(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify sync failed event
setNotifySyncStarted(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify start event
setNotifyUpdateFailed(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set if the sync client should notify update failed event
setPath(String)
- Method in class com.feedhenry.sdk.api.
FHCloudRequest
setPresentingActivity(Context)
- Method in class com.feedhenry.sdk.api.
FHAuthRequest
If the auth policy type is OAuth, user need to enter their username and password for the OAuth provider.
setRemoteAction(String)
- Method in class com.feedhenry.sdk.api.
FHActRequest
The name of the cloud side function
setRequestArgs(JSONObject)
- Method in class com.feedhenry.sdk.api.
FHCloudRequest
setResendCrashedUpdates(boolean)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
If this is set to true, crashed changes will be re-submitted if crash count limit is reached, otherwise they will be abandoned.
setSyncFrequency(int)
- Method in class com.feedhenry.sdk.sync.
FHSyncConfig
Set the sync interval.
setUDID(String)
- Method in interface com.feedhenry.sdk.
FHAct
Set the client unique id (device id) for the request
setUDID(String)
- Method in class com.feedhenry.sdk.
FHRemote
stop()
- Static method in class com.feedhenry.sdk.
FH
stop(String)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Stop the sync process for dataset with id pDataId
success(FHResponse)
- Method in interface com.feedhenry.sdk.
FHActCallback
Will be run if the action call is successful
SYNC_COMPLETE_CODE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
SYNC_COMPLETE_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
SYNC_FAILED_CODE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
SYNC_FAILED_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
SYNC_STARTED_CODE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
SYNC_STARTED_MESSAGE
- Static variable in class com.feedhenry.sdk.sync.
NotificationMessage
T
toString()
- Method in class com.feedhenry.sdk.sync.
NotificationMessage
U
update(String, String, JSONObject)
- Method in class com.feedhenry.sdk.sync.
FHSyncClient
Update an existing data record in dataset with pDataId
USER_AGENT_TEMP
- Static variable in class com.feedhenry.sdk.
FH
V
valueOf(String)
- Static method in enum com.feedhenry.sdk.api.
FHCloudRequest.Methods
Returns the enum constant of this type with the specified name.
values()
- Static method in enum com.feedhenry.sdk.api.
FHCloudRequest.Methods
Returns an array containing the constants of this enum type, in the order they are declared.
VERSION
- Static variable in class com.feedhenry.sdk.
FH
A
B
C
D
E
F
G
I
L
M
N
O
P
R
S
T
U
V
Overview
Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes