ContentStoreItem class Content
Content store item class
This class should not be instantiated directly. Instead, use the methods provided by the ContentStore class
Constructors
- ContentStoreItem.init(int id, int mapId)
Properties
- availableSize → int
-
Get the available size of the content in bytes.
no setter
- canDeleteContent → bool
-
Check if associated content can be deleted.
no setter
- chapterName → String
-
Get the product chapter name translated to interface language.
no setter
- clientVersion → Version
-
Get the client version of the content.
no setter
- contentParameters → SearchableParameterList
-
Get additional parameters for the content.
no setter
-
countryCodes
→ List<
String> -
Get the country code (ISO 3166-1 alpha-3) list of the product as text.
no setter
- downloadProgress → int
-
Get current download progress.
no setter
- fileName → String
-
Get the full path to the content data file when available.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → int
-
Get the unique id of the item in the content store.
no setter
- imgPreview → Img
-
Get the item image
no setter
- isCompleted → bool
-
Check if the item is completely downloaded.
no setter
- isImagePreviewAvailable → bool
-
Check if there is an image preview available on the client.
no setter
- isUpdatable → bool
-
Check if item is updatable, i.e. it has a newer version available.
no setter
- language → Language
-
Get the full language code for the product.
no setter
- mapId → int
-
no setter
- name → String
-
Get the name of the associated product.
no setter
- pointerId → int
-
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → ContentStoreItemStatus
-
Gets current item status.
no setter
- totalSize → int
-
Get the size of the content in bytes.
no setter
- type → ContentType
-
Get the type of the product as a ContentType value.
no setter
- updateItem → ContentStoreItem?
-
Get corresponding update item.
no setter
- updateSize → int
-
Get update size (if an update is available for this item).
no setter
- updateVersion → Version
-
Get update version (if an update is available for this item).
no setter
Methods
-
asyncDownload(
void onCompleteCallback(GemError err), {void onProgressCallback(int progress)?, bool allowChargedNetworks = false, DataSavePolicy savePolicy = DataSavePolicy.useDefault, ContentDownloadThreadPriority priority = ContentDownloadThreadPriority.defaultPriority}) → ProgressListener - Asynchronous start/resume the download of the content store product content.
-
cancelDownload(
) → GemError - Cancel a previous download operation.
-
deleteContent(
) → GemError - Delete the associated content.
-
dispose(
) → void -
getImagePreview(
{Size? size, ImageFileFormat? format}) → Uint8List? - Get the preview if available.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pauseDownload(
{void onComplete(GemError)?}) → GemError - Pause a previous download operation.
-
registerAutoReleaseObject(
int pointerId) → void -
Registers an object for auto release.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited