Namespace: example.
The example. namespace contains all of the Web SDK's functionality, and includes the following JavaScript Class 
:
Namespace methods
Methods
(static) method_1
This method initializes the Web SDK with information that will be applicable to every subsequent search.
| Parameter | Type | Description |
|---|---|---|
| params | Object | An object containing initialization parameters as described in the following list. |
| Source: namespace.js, line 341 | ||
Generic initialization param options:
- locale
- The name of the locale intended for the Web SDK. Use either "en_US" (US) or "zh_CN" (China). Defaults to "en_US".
- env
- The name of an environment hosting the API and related resources like bindings. One of "prod", "canary", or "stage." Defaults to prod.
- credentials
- An object
{ partnerId: 'your-id', partnerSecret: 'your-secret' }containing your Example credentials. These will be used when communicating with the Example API. - internalTrackers
- An
{id: config}mapping containing configuration for built-in analytics trackers. See the individual tracker documentation for more details.
Param options that control default integration behavior:
- layout
- Specifies the default layout for rendered search cards; use either "vertical-list" or "carousel".
- searchbox
- A DOM element or selector pointing to a form element that can contain a query. When the element's parent form is submitted, the value of the form element will be used as the search query sent to the Example API.
- queryParam
- The name of a URL parameter that may be passed to the hosting page. When initSDK is called, if this parameter is present, a search will run immediately with the value of this parameter as the query.
- container
- A DOM element or selector specifying the default container for search results. This container will be used when rendering results after e.g. run run is called.
- searchCallback
- A callback that will fire whenever a search has successfully been automatically performed (either on load or on form submit.)
(static) method_2(furl, format, apiParams, delay, maxTries)
Looks up content by FURL (Functional URL) from the Example API and returns a promised SearchResult containing that content (or null if the FURL was not found).
Note: Due to backend limitations this API currently only works with static states and app search states.
| Parameter | Type | Description |
|---|---|---|
| furl | String | Required. A single furl string for static or dynamic dvcs. |
| format | String | One of our DVC formats. 'info', 'place', etc... Defaults to 'info'. |
| apiParams | Object | Optional. Overrides the default api params when hitting /dvcs. |
| delay | Integer | Delay in ms between queries to v4/dvcs. Defaults to 1000. |
| maxTries | Integer | The max number of attempts to query v4/dvcs. Defaults to 3. |
| Source: namespace.js, line 221 | ||
(static) method_3(furl, format, apiParams)
A convenience function that looks up furls and then renders them in the container provided in Example.init().
| Parameter | Type | Description |
|---|---|---|
| furl | String | Required. A single furl string for static or dynamic dvcs. |
| format | String | One of our DVC formats. 'info', 'place', etc... Defaults to 'info'. |
| apiParams | Object | Optional. Overrides the default api params when hitting /dvcs. |
| Source: namespace.js, line 240 | ||