The getAll()
method of the ContentIndex
interface returns a Promise
that resolves with an iterable list of content index entries.
This method receives no parameters.
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
-
A String
title of the item. Used in user-visible lists of content.
description
-
A String
description of the item. Used in user-visible lists of content.
url
-
A String
containing the URL of the corresponding HTML document. Needs to be under the scope of the current service worker
.
-
category
Optional
-
A String
defining the category of content. Can be:
-
''
An empty String
, this is the default. homepage
article
video
audio
-
icons
Optional
-
An Array
of image resources, defined as an Object
with the following data:
src
-
A URL String
of the source image.
-
sizes
Optional
-
A String
representation of the image size.
-
type
Optional
-
The MIME type of the image.
No exceptions are thrown. If there are no items in the Content Index, an empty Array
is returned.
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() {
const registration = await navigator.serviceWorker.ready;
const entries = await registration.index.getAll();
const readingListElem = document.createElement("div");
if (!Array.length) {
const message = document.createElement("p");
message.innerText =
"You currently have no articles saved for offline reading.";
readingListElem.append(message);
} else {
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);
}
}