CacheOptions
Constructor
constructor(parameters: object): Options
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| parameters | object | Yes | - | |
| parameters.endpoint | string | Yes | - | The api endpoint without api version (i.e. https://api.adsum.io ) |
| parameters.username | string | Yes | - | he username in format {id}-user and {id}-device for respectively an user and a device with {id} it's actual id |
| parameters.key | string | Yes | - | The username's specific api key |
| parameters.additionalLocales | string[] | null | No | - | If null it will load all locales, otherwise only the specified ones |
| parameters.state | enum(STATES) | No | STATES.PUBLISHED | |
| parameters.binDownloadPolicy | object | No | See default properties below | The binary download policy which will decide which file to download |
| parameters.binDownloadPolicy.ignoredContexts | string[] | No | [ FILE_CONTEXTS.TEXTURE_LOW, FILE_CONTEXTS.TEXTURE_HELPER, FILE_CONTEXTS.TEXTURE_MODEL ] | The file contexts to ignore |
| parameters.binDownloadPolicy.ignoredIds | int[] | No | [] | The file ids to ignore |
| parameters.binDownloadPolicy.ignoredFileType | string[] | No | [] | The file types to ignore |