Index
A
acquirePosition | Acquires a geographical position. |
acquireVisibleAccessPoints | Acquires the currently visible access points. |
add | Stores data as documents inside a collection. |
addActionReceiver | Registers an action receiver. |
addCachedAuthorizationHeader | Adds a cached authorization header to the request. |
addGlobalHeader | Adds an HTTP header to be used in server requests issued by an IBM MobileFirst framework. |
addHeader | Adds a new header. |
addItem | Add an item to the tab bar. |
addItem | Adds an item to the options menu or application bar. |
advancedFind | Locates a document inside a collection by using query parts. |
B
backgroundJobDone | Complete the background job after receving the silent notification. |
base64Decode | Decodes input base64 string to a non base64 encoded string. |
base64Encode | Encodes input as base64 string. |
between | Add a between clause to a query for advanced find. |
C
change | Used to load data when existing data exists in the store. |
changePassword | Changes the password for the internal storage. |
checkForDirectUpdate | Checks whether direct update is available. |
clear | Clears a collection for reuse. |
clearPassword | Removes the password from memory. |
clearSharedToken | Clears a previously saved value associated with key from applications participating in simple shared data who are in the same application family, defined by the same family name and same application signing key. |
close | Closes a widget on Adobe AIR. |
close | Quits the application. |
close | Close encrypted cache. |
closeAll | Locks access to all the collections until WL.JSONStore.init is called. |
commitTransaction | Commit a transaction. |
config | Configures the logger globally. |
connect | Establishes a connection to the MobileFirst Server. |
copyToClipboard | This method is applicable to iOS and Android. |
count | Returns the number of documents inside a collection. |
countAllDirty | Returns the number of documents with local-only changes (that is, dirty documents). |
create | Creates an instance of a logger with its own context (also called status or state). |
createChallengeHandler | Creates a challenge handler object.A realm name must be supplied as a parameter. |
createProvisioningChallengeHandler | Creates a new challenge handler instance responsible for a specified realm. |
createWLChallengeHandler | Creates a challenge handler object to handle challenges that are sent by the MobileFirst Server. |
ctx | Updates the state (also called context or status) of the logger. |
D
debug | Prints arguments to the console. |
debug | Prints arguments to the console. |
decrypt | Decryption function. |
deleteCertificate | Removes the user certificate installed by the user certificate authentication realm. |
deleteCookie | Deletes a cookie from the native HTTP client cookie storage. |
deleteUserPref | Delete a user preference key. |
destroy | Deletes encrypted cache. |
destroy | Completely wipes data for all users, destroys the internal storage, and clears security artifacts. |
disable | Turns off the capture of analytics data. |
DISABLED | Error code returned when attempting WIFI acquisition if WIFI is disabled |
documentify | Takes an _id and a JSON object and creates a JSONStore document. |
E
enable | Turns on the capture of analytics data. |
encrypt | Encrypts text with a key. |
enhance | The enhance function allows developers to extend the core API to better fit their needs. |
equal | Add an equal to clause to a query for advanced find. |
erase | Deletes a document from the collection. |
error | Prints arguments to the console. |
error | Prints arguments to the console. |
F
FAILED_START_SCAN | Error code returned when failing to initiate WIFI scan due to OS reasons |
fatal | Prints arguments to the console. |
fatal | Prints arguments to the console. |
fileInfo | Returns information about the file that is used to persist data in the store. |
find | Locates a document inside a collection using a query. |
findAll | Returns all of the documents stored in a collection. |
findById | Returns one or more documents that match the _id that is supplied to the function. |
G
get | Provides an accessor to the collection if the collection exists, otherwise it returns undefined. |
getAllDirty | Returns all documents that are marked dirty. |
getAppIdentity | Obtains application identity. |
getAppProperty | Returns the value of the specified property. |
getAuthorizationScope | Parses the authentication header and retrieves the authorization scope. |
getCachedAuthorizationHeader | Returns cached authorization header. |
getConnectedAccessPoint | Acquires the currently connected WiFi access point information. |
getContext | Get the current device context. |
getCookies | Retrieves cookies from the native HTTP client. |
getDeviceIdentity | Obtains device identity. |
getDeviceLanguage | Returns the language code. |
getDeviceLocale | Returns the locale code (or device language on BlackBerry). |
getDistanceBetweenCoordinates | Calculates the distance between two coordinates. |
getDistanceToCircle | Calculates the distance of a coordinate from a circle. |
getDistanceToPolygon | Calculates the distance of a coordinate from a polygon. |
getEnvironment | Identifies the type of environment in which the application is running. |
getErrorMessage | Extracts a string that contains an error message. |
getErrorMessage | Returns the message that is associated with a JSONStore error code. |
getFriendlyName | Supported environments: Android, iOS, WindowsPhone8, Blackberry, Blackberry10. |
getHeader | Returns a first header value stored with the specified header name. |
getHeaderNames | Returns array of header names. |
getHeaders | Returns array of header values. |
getID | Supported environments: Android, iOS, WindowsPhone8, Blackberry, Blackberry10. |
getInteractivePushCategories | A function to return the iOS8 Interactive push notification categories. |
getItem | Returns an item. |
getLanguage | Return the language code of the language being used. |
getLastAccessToken | Gets the last obtained access token for a given scope, or the last access token for any scope, of none is provided. |
getLoginName | Returns the login name of the user who is currently logged in. |
getMethod | Returns current request method. |
getNetworkInfo | Get network information from the device Fetches network information from the device and returns it to the specified callback function. |
getQueryParameters | Returns query parameters as a JSON object with key-value pairs. |
getRequiredAccessTokenScope | Determines whether an access token is requested by the server, and returns the required scope. |
getRiskAssessment | Returns Trusteer risk-assessment data. |
getServerUrl | Gets Worklight server URL. |
getSharedToken | Retrieves a previously saved value associated with key from application participating in simple shared data who are in the same application family, defined by the same family name and same application signing key. |
getTimeout | Returns request timeout, in milliseconds. |
getUrl | Returns request URL. |
getUserIdentity | Obtains user identity. |
getUserInfo | Returns a user property. |
getUserName | Returns the user name of the user who is currently logged in. |
getUserPref | Returns the local value of a specified user preference. |
greaterOrEqualThan | Add a greater or equal thanclause to a query for advanced find. |
greaterThan | Add a greater than clause to a query for advanced find. |
H
handleChallenge | If isCustomResponse returns TRUE, the MobileFirst framework calls handleChallenge() . |
hasUserPref | Checks whether a user preference is defined locally in the application. |
hide | To hide the busy indicator: |
hideSplashScreen | Hides the default IBM Worklight splash screen if it is shown, and does nothing if the default Worklight splash screen is already hidden |
I
info | Prints arguments to the console. |
info | Prints arguments to the console. |
init | Initializes and enables the options menu or application bar. |
init | Initialize the tab bar. |
init | Initializes the WL.Client object. |
init | Starts one or more collections. |
init | Optional. |
initCollection | Returns an accessor (also known a JSONStoreInstance) to a single collection. |
inside | Add an in clause to a query for advanced find. |
invokeProcedure | Invokes a procedure that is exposed by an IBM MobileFirst adapter. |
IOS_BEST_ACCURACY | This constant should be used to configure best accuracy on iOS. |
IOS_BEST_ACCURACY_FOR_NAVIGATION | This constant should be used to configure best accuracy for navigation on iOS (which is even more accurate than IOS_BEST_ACCURACY). |
isAuthorizationRequired | Determines whether authorization is required or not. |
isConnected | This method is deprecated. |
isCustomResponse | Called each time that a response is received from the server. |
isDirty | Returns a boolean that is true if the document is dirty, false otherwise. |
isEnabled | Check whether the options menu or application bar is enabled. |
isInsideCircle | Returns a Boolean value based on whether a coordinate lies within a circle, based on a given level of confidence. |
isInsidePolygon | Returns a Boolean value based on whether a coordinate lies within a polygon, based on a given level of confidence. |
isOutsideCircle | Returns a Boolean value based on whether a coordinate lies outside of a circle, based on a given level of confidence. |
isOutsidePolygon | Returns a Boolean value based on whether a coordinate lies outside a polygon, based on a given level of confidence. |
isPushSMSSupported | Checks whether SMS push notifications are supported. |
isPushSupported | Checks whether push notification is supported. |
isSMSSubscribed | Checks whether current user is subscribed to an SMS event source. |
isSubscribed | Checks whether current user is subscribed to an event source. |
isTagSubscribed | Checks whether the device is subscribed to a tag. |
isUserAuthenticated | Checks whether the user is authenticated. |
isVisible | Returns whether the Android tab bar is visible. |
K
keygen | Generates a key by using the PBKDF2 algorithm. |
L
leftLike | Add a left clause to a query for advanced find. |
lessOrEqualThan | Add a less or equal than clause to a query for advanced find. |
lessThan | Add a less than clause to a query for advanced find. |
like | Add a like clause to a query for advanced find. |
LiveTracking | Returns a profile to use for accurately tracking devices. |
load | Gets data that is defined in the load portion of the adapter. |
localRandomString | Generates a random hex string locally. |
log | Prints arguments to the console. |
log | Logs a message with additional contextual information. |
logActivity | Reports user activity. |
login | Logs in to a specific realm. |
LogInstance | Logger with its own context (also called status or state). |
logout | Logs out to a specific realm. |
M
markClean | Marks an array of documents as clean. |
metadata | Attach additional metadata to the next logger instance call. |
minimize | Minimizes a widget in Adobe Air. |
N
notBetween | Add a not between clause to a query for advanced find. |
notEqual | Add a not equal to clause to a query for advanced find. |
notInside | Add a not in clause to a query for advanced find. |
notLeftLike | Add a not left clause to a query for advanced find. |
notLike | Add a not like clause to a query for advanced find. |
notRightLike | Add a not right clause to a query for advanced find. |
O
obtainAccessToken | Obtains an OAuth 2.0 access token from the MobileFirst server. |
obtainAuthorizationHeader | Obtains the authorization header for the specified scope. |
off | |
on | |
onMessage | A callback function to notify that push notification is arrived. |
onReadyToSubscribe | A callback function to notify that a device is ready to subscribe to push notifications. |
open | Open an existing cache, or create a cache. |
openURL | Open a URL. |
overrideBackButton | Overrides the default behavior of the Back button on Android, and Windows Phone 8. |
P
PERMISSION | Error code returned when trying to acquire WIFI position due to application's lack of permissions |
pinTrustedCertificatePublicKey | Pins the host X509 certificate public key to the client application. |
PowerSaving | Returns a profile to use for accurately tracking devices. |
purgeEventTransmissionBuffer | Purges the internal event transmission buffer. |
push | Pushes documents inside the collection that have local-only changes to an IBM® MobileFirst® adapter that is linked during the init function. |
pushSelected | Pushes only the selected documents. |
Q
QueryPart | Creates a query for advanced find. |
R
read | Decrypts the value that is associated with the specified key. |
refresh | Replaces a document with another document. |
registerEventSourceCallback | Registers a callback method that is called whenever a notification arrives from the specified event source. |
reloadApp | Reloads the application It can be used to recover an application from errors. |
remoteRandomString | Generates a random hex string by contacting a random generator on the IBM Worklight Server. |
remove | Removes a key-value pair from the cache. |
remove | Marks a document as deleted inside a collection. |
removeActionReceiver | Removes a previously added receiver. |
RemoveAllItems | Remove all items from a tab bar Removes all the previously added items from the tab bar. |
removeCollection | Deletes all the documents that are stored inside a collection. |
removeGlobalHeader | Removes the global HTTP header added by the WL.Client.addGlobalHeader API call |
removeItem | Remove an item from the options menu or application bar. |
removeItems | Removes all items from the options menu or application bar. |
replace | Overwrites a document with a given document. |
resetBackButton | Resets the original Back button behavior. |
restart | |
rightLike | Add a right clause to a query for advanced find. |
rollbackTransaction | Roll back a transaction. |
RoughTracking | Returns a profile which roughly tracks devices, representing. |
S
send | Send any logs collected up to this point to the IBM Worklight server. |
send | Send any analytics data collected up to this point to the IBM Worklight server. |
send | Sends the request to a server. |
sendActionToNative | Sends an action and optional data object to native action receivers. |
sendFormParameters | Sends the request to a server with URL encoded form parameters. |
setAuthorizationPersistencePolicy | Sets the authorization persistence policy, which defines how the authorization information is persisted on the device. |
setCookie | Adds a cookie to the native HTTP client. |
setEnabled | Enable or disable the options menu or application bar. |
setEnabled | Enable of Disable item. |
setEnabled | Enables or disables a tab bar item. |
setEnabled | Enables or disables the tab bar. |
setEventTransmissionPolicy | Configures the transmission of events from the client to the server, according to the provided transmission policy. |
setFriendlyName | Supported environments: Android, iOS, WindowsPhone8, Blackberry, Blackberry10. |
setHeader | Sets a new header or replaces an existing header with the same name. |
setHeaders | Sets request headers. |
setHeartBeatInterval | Sets the interval of the heartbeat signal. |
setImagePath | Set path to the icon. |
setNativeOptions | |
setNumber | Sets the application badge to the number provided. |
setOnAppEnteringBackground | Defines the behavior of the application before it enters the background. |
setOnAppEnteringForeground | Defines the behavior of the application just before it enters the foreground. |
setOpacity | Sets the opacity of the Windows Phone 8 application bar. |
setParentDivId | Place the tab bar within another element. |
setQueryParameter | Sets a new query parameter. |
setQueryParameters | Sets query parameters. |
setSelectedItem | Selects an item in the tab bar. |
setServerUrl | This method is applicable to iOS, Android and WP8. |
setSharedToken | Saves a key/value pair such that it is available to other applications participating in simple shared data who are in the same application family, defined by the same family name and same application signing key. |
setTimeout | Sets request timeout. |
setTitle | Set title of Item. |
setUserPref | Creates a user preference, or updates the value of an existing user preference. |
setUserPrefs | Creates or updates one or more user preferences. |
setVisible | Make the options menu or application bar visible or invisible. |
setVisible | Makes the tab bar visible or invisible. |
show | Displays a dialog box. |
show | Switches the currently displayed, web-based screen with a natively written page |
show | To show the busy indicator. |
show | Displays an Android toast box with the specified string. |
showSplashScreen | Shows the default IBM Worklight splash screen on the activity that was passed as a parameter |
startAcquisition | Starts ongoing acquisition for sensors that are provided in the policy. |
startTransaction | Initiates a transaction. |
state | Get the current state of |
status | Shows the status (current configuration) of the logger. |
stopAcquisition | Stops the ongoing acquisition, and clears all trigger states. |
store | Writes data to a collection. |
submitAdapterAuthentication | Used to send collected credentials to a specific adapter procedure. |
submitFailure | Notifies the MobileFirst framework that the authentication process completed with failure. |
submitLoginForm | Used to send collected credentials to a specific URL. |
submitSuccess | Used to notify the MobileFirst framework that the authentication successfully finished. |
subscribe | Subscribe to an event source. |
subscribeSMS | Subscribe to an SMS event source. |
subscribeTag | Subscribe to a tag. |
T
toString | Prints the contents of the collection by using WL.Logger.debug asynchronously. |
trace | Prints arguments to the console. |
trace | Prints arguments to the console. |
transmitEvent | Transmits a provided event object to the server. |
U
unsubscribe | Unsubscribe from an event source. |
unsubscribeSMS | Unsubscribe from an SMS event source. |
unsubscribeTag | Unsubscribe from a tag. |
updateBadge | On iOS only, updates the badge value on a tab bar item. |
updateConfigFromServer | Retrieves and applies any matching configuration profile from the IBM Worklight Server. |
updateUserInfo | Refreshes user data after an exception. |
usePassword | Sets the password that is used to generate keys to encrypt data that is stored locally on the device. |
W
warn | Prints arguments to the console. |
warn | Prints arguments to the console. |
WL.Analytics | The IBM® Worklight® Analytics API provides the ability to enable, disable, and log analytics data. |
WL.App | |
WL.App.BackgroundHandler | When an app moves to the background, iOS keeps a snapshot of the app window, to facilitate a smoother transition back to the foreground. |
WL.Badge | |
WL.BusyIndicator | Display an indication that the application is busy. |
WL.Client | This collection of topics lists the public methods of the IBM® MobileFirst® runtime client API for mobile apps, desktop, and web. |
WL.Client.AbstractChallengeHandler | Creates challengeHandler object using WL.Client.createChallengeHandler(realmName) to call methods of this class. |
WL.Client.Push | IBM® Worklight® provides a number of methods for supported push notification mechanisms. |
WL.Device | |
WL.Device.Geo | |
WL.Device.Geo.Profiles | Each method returns a geo policy. |
WL.Device.Wifi | |
WL.EncryptedCache | Encrypted offline cache is a mechanism for storing sensitive data on the client application. |
WL.Geo | |
WL.Item | Change an item’s title, or icon, or enables or disables an item. |
WL.JSONStore | Descriptions and reference information for the JSONStore API functions. |
WL.JSONStore.JSONStoreInstance | |
WL.JSONStore.QueryPart | Descriptions and reference information for the WL.JSONStore.QueryPart API functions. |
WL.Logger | Module that wraps various loggers in order to provide a unified interface for logging that works in every environment. |
WL.NativePage | |
WL.OptionsMenu | IBM® Worklight® supplies a number of methods for manipulating the Android options menu and the Windows Phone 8, and Windows 8 apps application bar. |
WL.SecurityUtils | Security Utilities |
WL.SimpleDialog | The simple dialog box object. |
WL.TabBar | IBM® Worklight® provides an API for managing the tab bar on Android and iPhone. |
WL.TabBarItem | Do not create a TabBarItem manually. |
WL.Toast | |
WL.Trusteer | This class allows access to risk-assessment data that is generated by Trusteer. |
WL.UserAuth | The IBM® Worklight® User Certificate Authentication API provides the ability to remove user certificates provisioned on the client device during the enrollment process. |
WLAuthorizationManager | The WLAuthorizationManager class is instantiated as a singleton and can be used anywhere in the application
to obtain the client ID and authorization header. |
WLResourceRequest | The WLResourceRequest object is used to send a request to any protected or unprotected resource using an absolute or relative URL. |
write | Store a key-value pair in the cache. |