Class ContentStore`Abstract`

Content store object

This behaves like a singleton, i.e. all instances are sharing behind the same API interface

Index

Accessors

Methods

asyncGetStoreContentList asyncGetStoreFilteredList cancel checkForUpdate createContentUpdater getItemById getLocalContentList getStoreContentList getStoreFilteredList refresh refreshContentStore setParallelDownloadsLimit

Accessors

`Static`transferStatistics

get transferStatistics(): TransferStatistics
Get the transfer statistics

Returns TransferStatistics
- Defined in contentstore/contentstore.ts:239

Methods

`Static`asyncGetStoreContentList

asyncGetStoreContentList(
    type: ContentType,
    onCompleteCallback: (
        err: GemError,
        items: ContentStoreItem[] | null,
        isCached: boolean | null,
    ) => void,
): EventDrivenProgressListener | null
Asynchronously gets an online store content list.
Parameters
- type: ContentType
- onCompleteCallback: (
      err: GemError,
      items: ContentStoreItem[] | null,
      isCached: boolean | null,
  ) => void
Returns EventDrivenProgressListener | null
- Defined in contentstore/contentstore.ts:88

`Static`asyncGetStoreFilteredList

asyncGetStoreFilteredList(
    type: ContentType,
    countries: string[] | null,
    area: GeographicArea | null,
    onCompleteCallback: (
        err: GemError,
        items: ContentStoreItem[] | null,
    ) => void,
): EventDrivenProgressListener | null
Asynchronously search the online store content with given filters.
Parameters
- type: ContentType
  Content list type (see ContentType).
- countries: string[] | null
  Optional list of ISO 3166 country codes to restrict the search.
- area: GeographicArea | null
  Optional geographic area to search in.
- onCompleteCallback: (err: GemError, items: ContentStoreItem[] | null) => void
  Callback invoked when the operation completes.
Returns EventDrivenProgressListener | null
The associated ProgressListener if the request can be started, null otherwise.
- Defined in contentstore/contentstore.ts:142

`Static`cancel

cancel(listener: EventDrivenProgressListener): void
Cancels an asynchronous operation.
Parameters
- listener: EventDrivenProgressListener
Returns void
- Defined in contentstore/contentstore.ts:182

`Static`checkForUpdate

checkForUpdate(type: ContentType): GemError
Check for update on the given content type.
Parameters
- type: ContentType
Returns GemError
- Defined in contentstore/contentstore.ts:205

`Static`createContentUpdater

createContentUpdater(type: ContentType): Pair<ContentUpdater, GemError>
Creates a content updater for the given content type.
Parameters
- type: ContentType
Returns Pair<ContentUpdater, GemError>
- Defined in contentstore/contentstore.ts:189

`Static`getItemById

getItemById(id: number): ContentStoreItem | null
Gets the extras item having the specified ID.
Parameters
- id: number
Returns ContentStoreItem | null
- Defined in contentstore/contentstore.ts:213

`Static`getLocalContentList

getLocalContentList(type: ContentType): ContentStoreItem[]
Gets access to the installed content list.
Parameters
- type: ContentType
Returns ContentStoreItem[]
- Defined in contentstore/contentstore.ts:46

`Static`getStoreContentList

getStoreContentList(type: ContentType): Pair<ContentStoreItem[], boolean>
Gets access to the store cached content list. Returns a Pair of <Content list, locally cached flag>.
Parameters
- type: ContentType
Returns Pair<ContentStoreItem[], boolean>
- Defined in contentstore/contentstore.ts:60

`Static`getStoreFilteredList

getStoreFilteredList(): ContentStoreItem[]
Gets access to the last requested filtered list.

Filtered list should be requested via a call to asyncGetStoreFilteredList.

Returns ContentStoreItem[]
List of ContentStoreItem representing the last filtered list.
- Defined in contentstore/contentstore.ts:79

`Static`refresh

refresh(): void
Refresh the content store by loading external changes from disk.

Returns void
- Defined in contentstore/contentstore.ts:225

`Static`refreshContentStore

refreshContentStore(): void
Deprecated alias for refresh kept for backward compatibility.

Returns void
Deprecated
Use refresh() instead.
- Defined in contentstore/contentstore.ts:248

`Static`setParallelDownloadsLimit

setParallelDownloadsLimit(count: number): void
Set parallel downloads count.
Parameters
- count: number
Returns void
- Defined in contentstore/contentstore.ts:232

Class ContentStoreAbstract

Index

Accessors

Methods

Accessors

StatictransferStatistics

Returns TransferStatistics

Methods

StaticasyncGetStoreContentList

Parameters

Returns EventDrivenProgressListener | null

StaticasyncGetStoreFilteredList

Parameters

Returns EventDrivenProgressListener | null

Staticcancel

Parameters

Returns void

StaticcheckForUpdate

Parameters

Returns GemError

StaticcreateContentUpdater

Parameters

Returns Pair<ContentUpdater, GemError>

StaticgetItemById

Parameters

Returns ContentStoreItem | null

StaticgetLocalContentList

Parameters

Returns ContentStoreItem[]

StaticgetStoreContentList

Parameters

Returns Pair<ContentStoreItem[], boolean>

StaticgetStoreFilteredList

Returns ContentStoreItem[]

Staticrefresh

Returns void

StaticrefreshContentStore

Returns void

Deprecated

StaticsetParallelDownloadsLimit

Parameters

Returns void

Settings

On This Page

Class ContentStore`Abstract`

`Static`transferStatistics

`Static`asyncGetStoreContentList

`Static`asyncGetStoreFilteredList

`Static`cancel

`Static`checkForUpdate

`Static`createContentUpdater

`Static`getItemById

`Static`getLocalContentList

`Static`getStoreContentList

`Static`getStoreFilteredList

`Static`refresh

`Static`refreshContentStore

`Static`setParallelDownloadsLimit