new Source()
Represents source of items for storage
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
apiVersion |
number | Version of API to use for pulling items from source | ||
clientId |
string |
<optional> |
OAuth 2.0 client ID | |
clientSecret |
string |
<optional> |
OAuth 2.0 client secret | |
contentTypes |
Array.<module:models/contentType~ContentType> | ContentTypes supported by source | ||
itemStorageEnabled |
boolean |
<optional> |
false | Whether source is enabled for storing items in storage |
host |
string |
<optional> |
Host URL for source (e.g. "api.foursquare.com") | |
itemsLimit |
number |
<optional> |
25 | Maximum number of items to pull from source in a single page request |
logoGlyphPath |
string |
<optional> |
URL path to logo glyph image file on host (e.g. "/images/logos/foursquare-glyph.svg") | |
name |
string | Name of source (e.g. "foursquare") | ||
passportStrategy |
string |
<optional> |
Strategy for Passport module (e.g. "passport-foursquare") | |
itemsGetUrlTemplate |
string |
<optional> |
https://${host}/${contentTypePluralCamelName}?access_token=${accessToken}&limit=${limit}&offset=${offset} | String template used to generate URLs for GET requests for items on source |
itemDataObjectsFromPagePathTemplate |
string |
<optional> |
data | String template used to generate object paths to itemDataObjects found within pages returned from source |
totalItemsAvailableFromPagePathTemplate |
string |
<optional> |
response.${contentTypePluralCamelName}.count | String template used to generate object paths to value representing total items available for contentType within pages returned from source |
- Source: