Spaces:
Paused
Paused
File size: 2,143 Bytes
95f4e64 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
## defineResourceHandler
This method currently handles addon catalog requests. As opposed to `defineCatalogHandler()` which handles meta catalogs, this method handles catalogs of addon manifests. This means that an addon can be used to just pass a list of other addons that can be installed in Stremio.
### Arguments:
`args` - request object; parameters described below
### Returns:
A promise that resolves to an object containing `{ addons: [] }` with an array of [Catalog Addon Object](../responses/addon_catalog.md)
The resolving object can also include the following cache related properties:
- `{ cacheMaxAge: int }` (in seconds) which sets the `Cache-Control` header to `max-age=$cacheMaxAge` and overwrites the global cache time set in `serveHTTP` [options](../../README.md#servehttpaddoninterface-options)
- `{ staleRevalidate: int }` (in seconds) which sets the `Cache-Control` header to `stale-while-revalidate=$staleRevalidate`
- `{ staleError: int }` (in seconds) which sets the `Cache-Control` header to `stale-if-error=$staleError`
## Request Parameters
``type`` - type of the catalog's content; e.g. `movie`, `series`, `channel`, `tv` (see [Content Types](../responses/content.types.md))
``id`` - string id of the catalog that is requested; these are set in the [Manifest Object](../responses/manifest.md)
``config`` - object with user settings, see [Manifest - User Data](../responses/manifest.md#user-data)
## Basic Example
```javascript
builder.defineResourceHandler('addon_catalog', function(args) {
return Promise.resolve({
addons: [
{
transportName: 'http',
transportUrl: 'https://example.addon.org/manifest.json',
manifest: {
id: 'org.myexampleaddon',
version: '1.0.0',
name: 'simple example',
catalogs: [],
resources: ['stream'],
types: ['movie'],
idPrefixes: ['tt']
}
}
]
})
})
```
[Catalog Addon Object Definition](../responses/addon_catalog.md)
|