Module: IndexDBStore

Methods

---

createFragmentStore(storeName)

Creates an instance of localforage to store fragments in indexed db

Parameters:

Name	Type	Description
storeName	string

Source:

• offline/storage/IndexDBStore.js, line 76

---

deleteDownloadById(manifestId)

Remove download given its id (fragmentStore + manifest entry in manifest array)

Parameters:

Name	Type	Description
manifestId	number

Source:

• offline/storage/IndexDBStore.js, line 387

Returns:

promise asynchronously resolved

Type

Promise

---

deleteFragmentStore(storeName)

Remove fragment store

Parameters:

Name	Type	Description
storeName	string

Source:

• offline/storage/IndexDBStore.js, line 417

Returns:

promise asynchronously resolved

Type

Promise

---

dropAll()

Remove all manifest and fragment store

Source:

• offline/storage/IndexDBStore.js, line 352

Returns:

promise asynchronously resolved

Type

Promise

---

dropFragmentStore(storeName)

Remove framgent store given its name

Parameters:

Name	Type	Description
storeName	string

Source:

• offline/storage/IndexDBStore.js, line 366

---

getAllManifests()

Returns all offline manifests

Source:

• offline/storage/IndexDBStore.js, line 222

Returns:

{Object[]} manifests

Type

Promise

---

getCurrentHigherManifestId()

Return higher manifest id

Source:

• offline/storage/IndexDBStore.js, line 238

Returns:

number

Type

Promise

---

getFragmentByKey(manifestId, key)

Returns a fragment from its key

Parameters:

Name	Type	Description
manifestId	number
key	number

Source:

• offline/storage/IndexDBStore.js, line 171

Returns:

fragment

Type

Promise

---

getManifestById(id)

Returns a manifest from its identifier

Parameters:

Name	Type	Description
id	number

Source:

• offline/storage/IndexDBStore.js, line 193

Returns:

{Object[]} manifests

Type

Promise

---

getRepresentationCurrentState(manifestId, representationId)

Returns current downloaded segment index for representation

Parameters:

Name	Type	Description
manifestId	number	manifest id
representationId	string	representation

Source:

• offline/storage/IndexDBStore.js, line 148

Returns:

promise

Type

Promise

---

saveSelectedRepresentations(manifest, selected)

save selected representation by user

Parameters:

Name	Type	Description
manifest	Object	updated manifest
selected	Object	selected representations

Source:

• offline/storage/IndexDBStore.js, line 286

Returns:

promise asynchronously resolved

Type

Promise

---

setDownloadingStatus(manifestId, newStatus)

Update download status

Parameters:

Name	Type	Description
manifestId	number
newStatus	string

Source:

• offline/storage/IndexDBStore.js, line 98

Returns:

promise

Type

Promise

---

setRepresentationCurrentState(manifestId, representationId, state)

Updat last downloaded fragment index for representationId

Parameters:

Name	Type	Description
manifestId	number	manifest id
representationId	string	representation
state	number	representation state

Source:

• offline/storage/IndexDBStore.js, line 118

Returns:

promise

Type

Promise

---

storeFragment(manifestId, fragmentId, fragmentData)

Store a fragment in fragment store

Parameters:

Name	Type	Description
manifestId	number
fragmentId	number
fragmentData	Object

Source:

• offline/storage/IndexDBStore.js, line 326

Returns:

promise asynchronously resolved

Type

Promise

---

storeManifest(manifest)

Store a manifest in manifest array

Parameters:

Name	Type	Description
manifest	Object

Source:

• offline/storage/IndexDBStore.js, line 307

---

updateManifest(manifest)

Update manifest

Parameters:

Name	Type	Description
manifest	Object	updated manifest

Source:

• offline/storage/IndexDBStore.js, line 263

Returns:

promise asynchronously resolved

Type

Promise