chrome.readingList

Description

Utilisez l'API chrome.readingList pour lire et modifier les éléments de la liste de lecture.

Autorisations

readingList

Pour utiliser l'API Reading List, ajoutez l'autorisation "readingList" dans le fichier manifest de l'extension:

manifest.json:

{
  "name": "My reading list extension",
  ...
  "permissions": [
    "readingList"
  ]
}

Garantie de disponibilité

Chrome 120 et versions ultérieures MV3 et versions ultérieures

Une liste de lecture s'affiche dans le panneau latéral de Chrome. Elle permet aux utilisateurs d'enregistrer des pages Web pour les lire plus tard ou hors connexion. Utilisez l'API Reading List pour récupérer des éléments existants, et en ajouter ou en supprimer.

Liste de lecture affichant plusieurs articles
Liste de lecture affichant plusieurs articles

Concepts et utilisation

Ordre des articles

L'ordre des éléments de la liste de lecture n'est pas garanti.

Unicité de l'article

Les éléments sont associés par URL. Cela inclut le hachage et la chaîne de requête.

Cas d'utilisation

Les sections suivantes illustrent certains cas d'utilisation courants de l'API Reading List. Consultez des exemples d'extensions pour voir des exemples complets.

Ajouter un élément

Pour ajouter un élément à la liste de lecture, utilisez chrome.readingList.addEntry():

chrome.readingList.addEntry({
  title: "New to the web platform in September | web.dev",
  url: "https://developer.chrome.com/",
  hasBeenRead: false
});

Afficher les éléments

Pour afficher les éléments de la liste de lecture, récupérez-les à l'aide de la méthode chrome.readingList.query().

const items = await chrome.readingList.query({});

for (const item of items) {
  // Do something do display the item
}

Marquer un élément comme lu

Vous pouvez utiliser chrome.readingList.updateEntry() pour modifier le titre, l'URL et l'état de lecture. Le code suivant marque un élément comme lu:

chrome.readingList.updateEntry({
  url: "https://developer.chrome.com/",
  hasBeenRead: true
});

Supprimer un élément

Pour supprimer un élément, utilisez chrome.readingList.removeEntry():

chrome.readingList.removeEntry({
  url: "https://developer.chrome.com/"
});

Exemples d'extensions

Pour plus de démos sur les extensions de l'API Reading List, consultez l'exemple d'API de la liste de lecture.

Types

AddEntryOptions

Propriétés

  • hasBeenRead

    boolean

    Elle est true si l'entrée a été lue.

  • title

    chaîne

    Titre de l'entrée.

  • url

    chaîne

    URL de l'entrée.

QueryInfo

Propriétés

  • hasBeenRead

    Booléen facultatif

    Indique s'il faut rechercher des éléments lus (true) ou non lus (false).

  • title

    string facultatif

    Un titre à rechercher.

  • url

    string facultatif

    URL à rechercher.

ReadingListEntry

Propriétés

  • creationTime

    Nombre

    Heure de création de l'entrée. Enregistré en millisecondes depuis le 1er janvier 1970.

  • hasBeenRead

    boolean

    Elle est true si l'entrée a été lue.

  • lastUpdateTime

    Nombre

    Date de la dernière mise à jour de l'entrée. Cette valeur est exprimée en millisecondes depuis le 1er janvier 1970.

  • title

    chaîne

    Titre de l'entrée.

  • url

    chaîne

    URL de l'entrée.

RemoveOptions

Propriétés

  • url

    chaîne

    URL à supprimer.

UpdateEntryOptions

Propriétés

  • hasBeenRead

    Booléen facultatif

    État de lecture mis à jour. L'état existant reste affiché si aucune valeur n'est fournie.

  • title

    string facultatif

    Nouveau titre. La tuile existante est conservée si aucune valeur n'est spécifiée.

  • url

    chaîne

    URL qui sera mise à jour.

Méthodes

addEntry()

Promesse 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

Ajoute une entrée à la liste de lecture si elle n'existe pas.

Paramètres

  • entrée

    AddEntryOptions

    Entrée à ajouter à la liste de lecture.

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit : 

    ()=>void

Renvoie

  • Promise<void>

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

query()

Promesse 
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

Récupère toutes les entrées correspondant aux propriétés QueryInfo. Les établissements non fournis ne seront pas mis en correspondance.

Paramètres

Renvoie

  • Promise<ReadingListEntry[]>

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

removeEntry()

Promesse 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

Supprime une entrée de la liste de lecture, le cas échéant.

Paramètres

  • Entrée à supprimer de la liste de lecture.

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit : 

    ()=>void

Renvoie

  • Promise<void>

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

updateEntry()

Promesse 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

Met à jour une entrée de liste de lecture, le cas échéant.

Paramètres

  • Entrée à mettre à jour.

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit : 

    ()=>void

Renvoie

  • Promise<void>

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

Événements

onEntryAdded

chrome.readingList.onEntryAdded.addListener(
  callback: function,
)

Déclenché lorsqu'un ReadingListEntry est ajouté à la liste de lecture.

Paramètres

onEntryRemoved

chrome.readingList.onEntryRemoved.addListener(
  callback: function,
)

Déclenché lorsqu'un ReadingListEntry est supprimé de la liste de lecture.

Paramètres

onEntryUpdated

chrome.readingList.onEntryUpdated.addListener(
  callback: function,
)

Déclenché lorsqu'un ReadingListEntry est mis à jour dans la liste de lecture.

Paramètres