Class ContentUpdater

Provides functionality to update content in the GEM SDK content store.

This class should not be instantiated directly. Instead, use ContentStore.createContentUpdater to obtain an instance.

An object used for applying updates to downloaded content packages. It represents a single update session (created by the ContentStore) and is used to start or resume an update, report progress and status changes, and complete the update flow.

Index

Constructors

constructor

new ContentUpdater(id: number, mapId: number): ContentUpdater
Creates a new ContentUpdater instance. Should not be called directly; use ContentStore.createContentUpdater.
Parameters
- id: number
  The pointer ID for the updater.
- mapId: number
  The map ID for the updater.
Returns ContentUpdater
- Defined in contentstore/contentupdater.ts:40

Accessors

canApply

get canApply(): boolean
Checks if the content update can be applied.

Returns boolean
True if the content update can be applied, false otherwise.
- Defined in contentstore/contentupdater.ts:172

contentType

get contentType(): ContentType
Gets the content type being updated.

Returns ContentType
The ContentType being updated.
- Defined in contentstore/contentupdater.ts:143

isStarted

get isStarted(): boolean
Checks if the content updater has started.

Returns boolean
True if the content update process has started, false otherwise.
- Defined in contentstore/contentupdater.ts:201

items

get items(): ContentStoreItem[]
Gets the list of content items involved in the update process.

Returns ContentStoreItem[]
List of ContentStoreItems in the update process.
- Defined in contentstore/contentupdater.ts:134

mapId

get mapId(): number
Gets the map ID for this updater.

Returns number
- Defined in contentstore/contentupdater.ts:66

pointerId

get pointerId(): number
Gets the pointer ID for this updater.

Returns number
- Defined in contentstore/contentupdater.ts:59

progress

get progress(): number
Gets the progress value of the update operation.

Progress values are calculated with respect to ProgressListener.progressMultiplier.

Returns number
The progress value.
- Defined in contentstore/contentupdater.ts:163

status

get status(): ContentUpdaterStatus
Gets the current status of the update operation.

Returns ContentUpdaterStatus
The ContentUpdaterStatus of the update operation.
- Defined in contentstore/contentupdater.ts:152

Methods

apply

apply(): GemError
Applies the content update.

Returns GemError
- GemError.success on success
  - GemError.upToDate if content has already been updated
  - GemError.invalidated if the update operation hasn't been started
  - GemError.io if the update cannot be applied or an error related to files has occurred
- Defined in contentstore/contentupdater.ts:185

cancel

cancel(): void
Cancels the content update operation.

Returns void
- Defined in contentstore/contentupdater.ts:193

dispose

dispose(): void
Disposes the updater and releases associated resources.

Returns void
- Defined in contentstore/contentupdater.ts:209

update

update(
    allowChargeNetwork: boolean,
    callbacks?: {
        onCompleteCallback?: (error: GemError) => void;
        onProgressUpdated?: (progress: number) => void;
        onStatusUpdated?: (status: ContentUpdaterStatus) => void;
    },
): EventDrivenProgressListener
| null
Starts or resumes the update process.
Parameters
- allowChargeNetwork: boolean
  Whether to allow use of a metered/charged network for updates.
- callbacks: {
      onCompleteCallback?: (error: GemError) => void;
      onProgressUpdated?: (progress: number) => void;
      onStatusUpdated?: (status: ContentUpdaterStatus) => void;
  } = {}
  Optional callbacks:
  
  onStatusUpdated: Triggered when the updater status changes. Receives the associated ContentUpdaterStatus.
  
  onProgressUpdated: Triggered when the updater progress changes. Receives the progress value.
  
  onCompleteCallback: Triggered when the update process is completed. Receives the associated GemError:
  
  GemError.success on success
  
  GemError.inUse if the update is already running
  
  GemError.notSupported if the update is not supported for the given ContentType
  
  GemError.noDiskSpace if there is not enough disk space on the device
  
  GemError.io if a file system error occurs
  
  Other GemError values for other errors
Returns EventDrivenProgressListener | null
The associated ProgressListener for this operation if the update can be started, otherwise null.
- Defined in contentstore/contentupdater.ts:86

`Static`init

init(id: number, mapId: number): ContentUpdater
Initializes a new ContentUpdater instance. Should not be called directly; use ContentStore.createContentUpdater.
Parameters
- id: number
  The pointer ID for the updater.
- mapId: number
  The map ID for the updater.
Returns ContentUpdater
A new ContentUpdater instance.
- Defined in contentstore/contentupdater.ts:52

Class ContentUpdater

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ContentUpdater

Accessors

canApply

Returns boolean

contentType

Returns ContentType

isStarted

Returns boolean

items

Returns ContentStoreItem[]

mapId

Returns number

pointerId

Returns number

progress

Returns number

status

Returns ContentUpdaterStatus

Methods

apply

Returns GemError

cancel

Returns void

dispose

Returns void

update

Parameters

Returns EventDrivenProgressListener | null

Staticinit

Parameters

Returns ContentUpdater

Settings

On This Page

`Static`init