Draft This page is not complete.
The getAll()
method of the ContentIndex
interface returns a Promise
that resolves with an iterable list of content index entries.
Syntax
var indexedContent = ContentIndex.getAll();
Parameters
This method receives no parameters.
Return value
Returns a Promise
that resolves with an Array
of ContentDescription
items.
- ContentDescription
- Each item returned is an
Object
containing the following data:
id
- A unique
String
identifier. title
: AString
title for the item. Used in user-visible lists of content.title
: AString
title of the item. Used in user-visible lists of content.description
: AString
description of the item. Used in user-visible lists of content.url
: AString
containing the url of the corresponding HTML document. Needs to be under the scope of the currentservice worker
.category
: Optional AString
defining the category of content. Can be:
- A unique
An empty
String
, this is the default.homepage
article
video
audio
Exceptions
No exceptions are thrown. If there are no items in the Content Index, an empty Array
is returned.
Examples
The below example shows an asynchronous function that retrieves items within the content index
and iterates over each entry, building a list for the interface.
async function createReadingList() {
// access our service worker registration
const registration = await navigator.serviceWorker.ready;
// get our index entries
const entries = await registration.index.getAll();
// create a containing element
const readingListElem = document.createElement('div');
// test for entries
if (!Array.length) {
// if there are no entries, display a message
const message = document.createElement('p');
message.innerText = 'You currently have no articles saved for offline reading.'
readingListElem.append(message);
} else {
// if entries are present, display in a list of links to the content
const listElem = document.createElement('ul');
for (const entry of entries) {
const listItem = document.createElement('li');
const anchorElem = document.createElement('a');
anchorElem.innerText = entry.title;
anchorElem.setAttribute('href', entry.url);
listElem.append(listItem);
}
readingListElem.append(listElem);
}
}
Specifications
Specification | Status | Comment |
Content Index APIThe definition of 'getAll' in that specification. | Editor's Draft | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
No support No |
Edge
Full support 84 |
Firefox
No support No |
IE
No support No |
Opera
No support No |
Safari
No support No |
WebView Android
Full support 84 |
Chrome Android
Full support 84 |
Firefox Android
No support No |
Opera Android
No support No |
Safari iOS
No support No |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
See also:
- An introductory article on the Content Index API
- An app which uses the Content Index API to list and remove 'save for later' content
- Service Worker API, along with information about Cache and CacheStorage
ContentIndex.getAll() by Mozilla Contributors is licensed under CC-BY-SA 2.5.