Maps SDK for Android/com.magiclane.sdk.content/ContentStoreItem

ContentStoreItem

class ContentStoreItem : GemNativeObj

ContentStoreItem object.

Constructors

ContentStoreItem

constructor()

constructor(address: Long)

constructor(address: Long, isRef: Boolean)

Properties

val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

val availableSize: Long

Available size of the content in bytes.

val chapterName: String?

Product chapter name translated to interface language Items with same chapter name are considered to be part of the same group

val clientVersion: Version?

Client version of the content. Requires the content available size greater than zero.

contentParameters

val contentParameters: ParameterList?

Additional parameters for the content. This is not available for all content types.

val countryCodes: ArrayList<String>?

Country code (ISO 3166-1 alpha-3 ) list of the product as text.

downloadProgress

val downloadProgress: Int

Current download progress.

val filename: String?

Full path to the content data file when available.

val id: Long

Unique id of the item in content store.

val imagePreview: Image?

Image preview if available. Available only if isImagePreviewAvailable() returns true.

val language: Language?

Full language code for the product.

val name: String?

Name of the associated product.

val status: EContentStoreItemStatus

Current item status.

val totalSize: Long

Size of the content in bytes.

val type: EContentType

Type of the product as a EContentType value.

val updateItem: ContentStoreItem?

Corresponding update item function will return an valid item only if an update is in progress for that item

val updateSize: Long

Update size ( if an update is available for this item ) function will return a valid size ( != 0 ) only if item has a newer version in store this function doesn't request an update to be started for the item

val updateVersion: Version?

Update version ( if an update is available for this item ) function will return a valid version ( != 0 ) only if item has a newer version in store this function doesn't request an update to be started for the item

Functions

fun asyncDownload(listener: ProgressListener, savePolicy: GemSdk.EDataSavePolicy = GemSdk.EDataSavePolicy.UseDefault, allowChargedNetworks: Boolean = true): Int

fun asyncDownload(savePolicy: GemSdk.EDataSavePolicy = GemSdk.EDataSavePolicy.UseDefault, allowChargedNetworks: Boolean = true, onStarted: OnStarted? = null, onProgress: OnProgress? = null, onCompleted: OnCompleted? = null, onStatusChanged: OnStatusChanged? = null): Int

Asynchronous start/resume the download of the content store product content.

external fun cancelDownload(): Int

Cancel a previous download operation. The partially downloaded content is deleted.

canDeleteContent

external fun canDeleteContent(): Boolean

Check if associated content can be deleted Note: Content can be deleted if has partially or complete local data and is not marked as SDK resource

external fun deleteContent(): Int

Delete the associated content.

Overrides finalize that garbage collector will call when needed.

external fun isCompleted(): Boolean

Check if the item is completed downloaded.

isImagePreviewAvailable

external fun isImagePreviewAvailable(): Boolean

Check if there is an image preview available on the client.

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

external fun isUpdatable(): Boolean

Check if item is updatable, i.e. it has a newer version available.

operator fun not(): Boolean

Checks if this object is valid.

external fun pauseDownload(): Int

Pause a previous download operation.

Releases the native referenced value of this object if:

setProgressListener

external fun setProgressListener(listener: ProgressListener)

Sets the item progress listener