Interface OfflineContentConfig

Object used to configure a new OfflineContentManager instance.

Platform

Android, iOS

interface OfflineContentConfig {
    identifier: string;
    nativeId?: string;
    sourceConfig: SourceConfig;
}

Hierarchy

  • NativeInstanceConfig
    • OfflineContentConfig

Properties

identifier nativeId? sourceConfig

Properties

identifier

identifier: string

An identifier for this source that is unique within the location and must never change. The root folder will contain a folder based on this id.

Optional nativeId

nativeId?: string

Optionally user-defined string id for the native instance. Used to access a certain native instance from any point in the source code then call methods/properties on it.

When left empty, a random UUIDv4 is generated for it.

Example

Accessing or creating the Player with nativeId equal to my-player:

const player = new Player({ nativeId: 'my-player' })
player.play(); // call methods and properties...

sourceConfig

sourceConfig: SourceConfig

The SourceConfig used to download the offline resources.

Settings

Member Visibility

Theme

On This Page

identifiernativeIdsourceConfig