| __copyToClipboard | This method is applicable to iOS and Android. |
| add | Stores data as documents inside a collection. |
| addActionReceiver | Registers an action receiver. |
| addGlobalHeader | The HTTP header is used in all requests until removed by the WL.Client.removeGlobalHeader API call. |
| addHeader | Adds a new header. |
| addItem | Adds an item to the options menu or application bar. |
| advancedFind | Locates a document inside a collection by using query parts. |
| 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. |
| cancel | Notifies the MobileFirst framework that the authentication process needs to be canceled. |
| change | Used to load data when existing data exists in the store. |
| changePassword | Changes the password for the internal storage. |
| clear | Clears a collection for reuse. |
| clearAccessToken | Clears the provided access token. |
| clearCookieSession | Clear all the session cookies while maintaining the persisted ones. |
| clearCookieSession | Clear all the cookies from persistence and from the cache. |
| clearPassword | Removes the password from memory. |
| clearSharedToken | Clears a previously saved value associated with key. |
| closeAll | Locks access to all the collections until WL.JSONStore.init is called. |
| commitTransaction | Commit a transaction. |
| config | Configures the logger globally. |
| 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). |
| createGatewayChallengeHandler | Creates a challenge handler responsible for handling responses from a third party gateway. |
| createSecurityCheckChallengeHandler | 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. |
| debug | Prints arguments to the console. |
| debug | Prints arguments to the console. |
| decrypt | Decryption function. |
| deleteCookie | Deletes a cookie from the native HTTP client cookie storage. |
| destroy | Completely wipes data for all users, destroys the internal storage, and clears security artifacts. |
| disable | Turns off the capture of analytics data. |
| documentify | Takes an _id and a JSON object and creates a JSONStore document. |
| enable | Turns on the capture of analytics data. |
| enableOSNativeEncryption | ONLY FOR IOS. |
| 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. |
| 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. |
| get | Provides an accessor to the collection if the collection exists, otherwise it returns undefined. |
| getAllDirty | Returns all documents that are marked dirty. |
| getAuthorizationServerUrl | Retrieves the URL of the authorization server. |
| getCookies | Retrieves cookies from the native HTTP client. |
| getDeviceDisplayName | Gets the display name of the device. |
| getDeviceLanguage | Returns the language code. |
| getDeviceLocale | Returns the locale code. |
| getEnvironment | |
| getErrorMessage | Returns the message that is associated with a JSONStore error code. |
| getErrorMessage | Extracts a string that contains an error message. |
| getHeader | Returns a first header value stored with the specified header name. |
| getHeaderNames | Returns array of header names. |
| getHeaders | Returns array of header values. |
| getItem | Returns an item. |
| getLanguage | This method returns the language or dialect code of the language currently being used for the application. |
| getMethod | Returns current request method. |
| getQueryParameters | Returns query parameters as a JSON object with key-value pairs. |
| getResourceScope | Returns the scope of the protected resource for the provided response headers. |
| getServerUrl | Gets MobileFirst server URL. |
| getSharedToken | Returns the previously saved value associated with key. |
| getTimeout | Returns request timeout, in milliseconds. |
| getUrl | Returns request URL. |
| 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. |
| handleChallenge | The MobileFirst framework calls this method only for the relevant challenge. |
| hideSplashScreen | Hides the default IBM MobileFirst splash screen if it is shown, and does nothing if the default MobileFirst splash screen is already hidden |
| info | Prints arguments to the console. |
| info | Prints arguments to the console. |
| init | Initializes the WL.Client object. |
| init | Initializes and enables the options menu or application bar. |
| init | Starts one or more collections. |
| initCollection | Returns an accessor (also known a JSONStoreInstance) to a single collection. |
| inside | Add an in clause to a query for advanced find. |
| invokeProcedure | |
| isAuthorizationRequired | Checks whether the provided response status and headers represent a protected resource that requires authorization. |
| 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. |
| keygen | Generates a key by using the PBKDF2 algorithm. |
| 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. |
| load | Gets data that is defined in the load portion of the adapter. |
| localRandomString | Generates a random hex string locally. |
| log | Logs a message with additional contextual information. |
| log | Prints arguments to the console. |
| login | Logs into the specified security check. |
| LogInstance | Logger with its own context (also called status or state). |
| logout | Logs out of the specified security check. |
| markClean | Marks an array of documents as clean. |
| metadata | Attach additional metadata to the next logger instance call. |
| 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. |
| obtainAccessToken | Obtains an access token for the specified resource scope from the MobileFirst authorization server. |
| off | |
| on | |
| openURL | Open a URL. |
| pinTrustedCertificatePublicKey | Pins the host X509 certificate public key to the client application. |
| 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. |
| QueryPart | Creates a query for advanced find. |
| refresh | Replaces a document with another document. |
| reloadApp | Reloads the application It can be used to recover an application from errors. |
| remove | Marks a document as deleted inside a collection. |
| removeActionReceiver | Removes a previously added receiver. |
| removeCollection | Deletes all the documents that are stored inside a collection. |
| removeGlobalHeader | |
| 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. |
| resetDeviceID | Resets Stored Device ID. |
| restart | |
| rightLike | Add a right clause to a query for advanced find. |
| rollbackTransaction | Roll back a transaction. |
| send | Send any analytics data collected up to this point to the IBM Worklight server. |
| send | Sends the request to a server. |
| send | Send any logs collected up to this point to the IBM Worklight 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. |
| setAuthorizationServerUrl | Sets the URL of the authorization server. |
| setCookie | Adds a cookie to the native HTTP client. |
| setDeviceDisplayName | Sets the display name of the device. |
| setDeviceID | sets Stored Device ID. |
| setEnabled | Enable or disable the options menu or application bar. |
| 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. |
| setNativeOptions | |
| setNumber | Sets the application badge to the number provided. |
| setOpacity | Sets the opacity of the Windows Phone 8 application bar. |
| setQueryParameter | Sets a new query parameter. |
| setQueryParameters | Sets query parameters. |
| setServerUrl | This method is applicable to iOS, Android and WP8. |
| setSharedToken | Saves a key/value pair such that it is available to other applications. |
| setTimeout | Sets request timeout. |
| setVisible | Make the options menu or application bar visible or invisible. |
| show | |
| showSplashScreen | Shows the default IBM MobileFirst splash screen on the activity that was passed as a parameter |
| startTransaction | Initiates a transaction. |
| state | Get the current state of |
| status | Shows the status (current configuration) of the logger. |
| store | Writes data to a collection. |
| 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. |
| updateConfigFromServer | Retrieves and applies any matching configuration profile from the IBM Worklight Server. |
| usePassword | Sets the password that is used to generate keys to encrypt data that is stored locally on the device. |
| 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.Badge | |
| 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 | This should not be used directly. |
| 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 |
| 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. |