new mw.widgets.APIResultsProvider(apiurl, configopt)
#
API Results Provider object.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiurl |
string | The URL to the api |
||||||||||||||||||||||
config |
Object |
<optional> |
Configuration options Properties
|
- Mixes In:
- Source:
Methods
getAPIurl() → {string}
#
Get API URL.
Returns:
API URL
- Type
- string
getAjaxSettings() → {Object}
#
Get the default ajax settings.
Returns:
Ajax settings
- Type
- Object
getDefaultFetchLimit() → {number}
#
Get fetch limit or 'page' size. This is the number of results per request.
Returns:
limit
- Type
- number
getLang() → {string}
#
Get provider API language.
Returns:
Provider API language
- Type
- string
getOffset() → {number}
#
Get result offset.
Returns:
Offset Results offset for the upcoming request
- Type
- number
getResults(howMany) → {jQuery.Promise}
#
Get results from the source.
Parameters:
Name | Type | Description |
---|---|---|
howMany |
number | Number of results to ask for |
Returns:
Promise that is resolved into an array of available results, or is rejected if no results are available.
- Type
- jQuery.Promise
getStaticParams() → {Object}
#
Get the static, non-changing data parameters sent to the API.
Returns:
Data parameters
- Type
- Object
getUserParams() → {Object}
#
Get the user-inputted dynamic data parameters sent to the API.
Returns:
Data parameters
- Type
- Object
isDepleted() → {boolean}
#
Check whether the provider is depleted and has no more results to hand off.
Returns:
The provider is depleted
- Type
- boolean
Check whether the provider is depleted and has no more results to hand off.
reset()
#
Reset the provider.
setAPIurl(apiurl)
#
Set API URL.
Parameters:
Name | Type | Description |
---|---|---|
apiurl |
string | API URL |
setAjaxSettings(settings)
#
Set the default ajax settings.
Parameters:
Name | Type | Description |
---|---|---|
settings |
Object | Ajax settings |
setDefaultFetchLimit(limit)
#
Set limit.
Parameters:
Name | Type | Description |
---|---|---|
limit |
number | Default number of results to fetch from the API |
setLang(lang)
#
Set provider API language.
Parameters:
Name | Type | Description |
---|---|---|
lang |
string | Provider API language |
setOffset(offset)
#
Set result offset.
Parameters:
Name | Type | Description |
---|---|---|
offset |
number | Results offset for the upcoming request |
setUserParams(params)
#
Set the data parameters sent to the API.
Parameters:
Name | Type | Description |
---|---|---|
params |
Object | User defined data parameters |
toggleDepleted(isDepleted)
#
Toggle depleted state.
Parameters:
Name | Type | Description |
---|---|---|
isDepleted |
boolean | The provider is depleted |