Content Index API
The getAll() method of the
ContentIndex interface returns a Promise that resolves with
an iterable list of content index entries.
Syntax
getAll()
Parameters
None.
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- : 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- : A String defining the category of content.
Can be:
''An empty String, this is the default.homepagearticlevideoaudio
- : A String defining the category of content.
Can be:
-
icons- : An Array of image resources, defined as an Object with the following data:
src- : A URL String of the source image.
sizes- : A String representation of the image size.
type- : The MIME type of the image.
label- : A string representing the accessible name of the icon.
- : An Array of image resources, defined as an Object with the following data:
-
- : Each item returned is an Object containing the following data:
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 (entries.length === 0) {
// 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
Browser compatibility
See also
- An introductory article on the Content Index API
- Service Worker API, along with information about Cache and CacheStorage
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
