chrome.bladwijzers

Beschrijving

Gebruik de chrome.bookmarks API om bladwijzers te maken, ordenen en anderszins te manipuleren. Zie ook Pagina's overschrijven , waarmee u een aangepaste pagina Bladwijzerbeheer kunt maken.

Als u op de ster klikt, wordt een bladwijzer toegevoegd.

Machtigingen

bookmarks

U moet de machtiging 'bladwijzers' opgeven in het extensiemanifest om de bladwijzers-API te kunnen gebruiken. Bijvoorbeeld:

{
  "name": "My extension",
  ...
  "permissions": [
    "bookmarks"
  ],
  ...
}

Concepten en gebruik

Objecten en eigenschappen

Bladwijzers zijn georganiseerd in een boom, waarbij elk knooppunt in de boom een ​​bladwijzer of een map is (ook wel een groep genoemd). Elk knooppunt in de boom wordt vertegenwoordigd door een bookmarks.BookmarkTreeNode -object.

BookmarkTreeNode eigenschappen worden gebruikt in de chrome.bookmarks API. Als u bijvoorbeeld bookmarks.create aanroept, geeft u het bovenliggende knooppunt ( parentId ) en eventueel de eigenschappen index , title en url van het knooppunt door. Zie bookmarks.BookmarkTreeNode voor informatie over de eigenschappen die een knooppunt kan hebben.

Opmerking: u kunt deze API niet gebruiken om vermeldingen in de hoofdmap toe te voegen of te verwijderen. U kunt de speciale mappen "Bladwijzerbalk" en "Overige bladwijzers" ook niet hernoemen, verplaatsen of verwijderen.

Voorbeelden

Met de volgende code wordt een map gemaakt met de titel 'Extensiebladwijzers'. Het eerste argument voor create() specificeert eigenschappen voor de nieuwe map. Het tweede argument definieert een functie die moet worden uitgevoerd nadat de map is gemaakt.

chrome.bookmarks.create(
  {'parentId': bookmarkBar.id, 'title': 'Extension bookmarks'},
  function(newFolder) {
    console.log("added folder: " + newFolder.title);
  },
);

Met het volgende fragment wordt een bladwijzer gemaakt die verwijst naar de ontwikkelaarsdocumentatie voor extensies. Omdat er niets ergs zal gebeuren als het maken van de bladwijzer mislukt, neemt deze code niet de moeite om een ​​callback-functie te definiëren.

chrome.bookmarks.create({
  'parentId': extensionsFolderId,
  'title': 'Extensions doc',
  'url': 'https://developer.chrome.com/docs/extensions',
});

Om deze API te proberen, installeert u het Bookmarks API-voorbeeld uit de chrome-extension-samples- repository.

Soorten

BookmarkTreeNode

Een knooppunt (een bladwijzer of een map) in de bladwijzerboom. Onderliggende knooppunten worden geordend in hun bovenliggende map.

Eigenschappen

• kinderen

  BookmarkTreeNode [] optioneel

  Een geordende lijst met kinderen van dit knooppunt.

• datumToegevoegd

  nummer optioneel

  Toen dit knooppunt werd gemaakt, in milliseconden sinds het tijdperk ( new Date(dateAdded) ).

• dateGroupGewijzigd

  nummer optioneel

  Wanneer de inhoud van deze map voor het laatst is gewijzigd, in milliseconden sinds het tijdperk.

• datumLaatstGebruikt

  nummer optioneel

  Chroom 114+

  Wanneer dit knooppunt voor het laatst werd geopend, in milliseconden sinds het tijdperk. Niet ingesteld voor mappen.

• Identiteitskaart

  snaar

  De unieke ID voor het knooppunt. ID's zijn uniek binnen het huidige profiel en blijven geldig, zelfs nadat de browser opnieuw is opgestart.

• index

  nummer optioneel

  De op 0 gebaseerde positie van dit knooppunt binnen de bovenliggende map.

• ouderId

  tekenreeks optioneel

  De id van de bovenliggende map. Weggelaten voor het hoofdknooppunt.

• titel

  snaar

  De tekst die wordt weergegeven voor het knooppunt.

• onveranderbaar

  "beheerd"
  optioneel

  Geeft de reden aan waarom dit knooppunt niet kan worden gewijzigd. De managed waarde geeft aan dat dit knooppunt is geconfigureerd door de systeembeheerder of door de beheerder van een bewaakte gebruiker. Weggelaten als het knooppunt kan worden gewijzigd door de gebruiker en de extensie (standaard).

• URL

  tekenreeks optioneel

  De URL waarnaar wordt genavigeerd wanneer een gebruiker op de bladwijzer klikt. Weggelaten voor mappen.

BookmarkTreeNodeUnmodifiable

Chroom 44+

Geeft de reden aan waarom dit knooppunt niet kan worden gewijzigd. De managed waarde geeft aan dat dit knooppunt is geconfigureerd door de systeembeheerder. Weggelaten als het knooppunt kan worden gewijzigd door de gebruiker en de extensie (standaard).

Waarde

"beheerd"

CreateDetails

Object doorgegeven aan de create() functie.

Eigenschappen

• index

  nummer optioneel

• ouderId

  tekenreeks optioneel

  Standaard ingesteld op de map Overige bladwijzers.

• titel

  tekenreeks optioneel

• URL

  tekenreeks optioneel

Eigenschappen

MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

Afgekeurd

Het schrijven van bladwijzers wordt niet langer beperkt door Chrome.

Waarde

1000000

MAX_WRITE_OPERATIONS_PER_HOUR

Afgekeurd

Het schrijven van bladwijzers wordt niet langer beperkt door Chrome.

Waarde

1000000

Methoden

create()

Belofte

chrome.bookmarks.create(
  bookmark: CreateDetails,
  callback?: function,
)

Creëert een bladwijzer of map onder de opgegeven parentId. Als de URL NULL is of ontbreekt, is het een map.

Parameters

• bladwijzer

  Details maken

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (result: BookmarkTreeNode) => void

  • resultaat

    BladwijzerTreeNode

Retouren

• Belofte <BookmarkTreeNode>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

get()

Belofte

chrome.bookmarks.get(
  idOrIdList: string | [string, ...string[]],
  callback?: function,
)

Haalt de opgegeven BookmarkTreeNode(s) op.

Parameters

• idOrIdLijst

  tekenreeks | [tekenreeks, ...tekenreeks[]]

  Eén ID met tekenreekswaarde of een reeks ID's met tekenreekswaarde

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (results: BookmarkTreeNode[]) => void

  • resultaten

    BladwijzerBoomNode []

Retouren

• Belofte< BookmarkTreeNode []>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getChildren()

Belofte

chrome.bookmarks.getChildren(
  id: string,
  callback?: function,
)

Haalt de onderliggende elementen van de opgegeven BookmarkTreeNode-id op.

Parameters

• Identiteitskaart

  snaar

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (results: BookmarkTreeNode[]) => void

  • resultaten

    BladwijzerBoomNode []

Retouren

• Belofte< BookmarkTreeNode []>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getRecent()

Belofte

chrome.bookmarks.getRecent(
  numberOfItems: number,
  callback?: function,
)

Haalt de recent toegevoegde bladwijzers op.

Parameters

• aantalItems

  nummer

  Het maximale aantal te retourneren artikelen.

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (results: BookmarkTreeNode[]) => void

  • resultaten

    BladwijzerBoomNode []

Retouren

• Belofte< BookmarkTreeNode []>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getSubTree()

Belofte

chrome.bookmarks.getSubTree(
  id: string,
  callback?: function,
)

Haalt een deel van de bladwijzerhiërarchie op, beginnend bij het opgegeven knooppunt.

Parameters

• Identiteitskaart

  snaar

  De ID van de hoofdmap van de subboom die moet worden opgehaald.

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (results: BookmarkTreeNode[]) => void

  • resultaten

    BladwijzerBoomNode []

Retouren

• Belofte< BookmarkTreeNode []>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getTree()

Belofte

chrome.bookmarks.getTree(
  callback?: function,
)

Haalt de volledige bladwijzerhiërarchie op.

Parameters

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (results: BookmarkTreeNode[]) => void

  • resultaten

    BladwijzerBoomNode []

Retouren

• Belofte< BookmarkTreeNode []>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

move()

Belofte

chrome.bookmarks.move(
  id: string,
  destination: object,
  callback?: function,
)

Verplaatst de opgegeven BookmarkTreeNode naar de opgegeven locatie.

Parameters

• Identiteitskaart

  snaar

• bestemming

  voorwerp

  • index

    nummer optioneel

  • ouderId

    tekenreeks optioneel

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (result: BookmarkTreeNode) => void

  • resultaat

    BladwijzerTreeNode

Retouren

• Belofte <BookmarkTreeNode>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

remove()

Belofte

chrome.bookmarks.remove(
  id: string,
  callback?: function,
)

Verwijdert een bladwijzer of een lege bladwijzermap.

Parameters

• Identiteitskaart

  snaar

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  () => void

Retouren

• Beloof <nietig>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

removeTree()

Belofte

chrome.bookmarks.removeTree(
  id: string,
  callback?: function,
)

Verwijdert recursief een bladwijzermap.

Parameters

• Identiteitskaart

  snaar

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  () => void

Retouren

• Beloof <nietig>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

search()

Belofte

chrome.bookmarks.search(
  query: string | object,
  callback?: function,
)

Zoekt naar BookmarkTreeNodes die overeenkomen met de opgegeven zoekopdracht. Query's die bij een object zijn opgegeven, produceren BookmarkTreeNodes die overeenkomen met alle opgegeven eigenschappen.

Parameters

• vraag

  tekenreeks | voorwerp

  Ofwel een reeks woorden en geciteerde zinnen die worden vergeleken met bladwijzer-URL's en titels, of een object. Als een object de eigenschappen query , url en title kan specificeren, zullen er bladwijzers worden geproduceerd die overeenkomen met alle gespecificeerde eigenschappen.

  • vraag

    tekenreeks optioneel

    Een reeks woorden en geciteerde zinnen die worden vergeleken met bladwijzer-URL's en titels.

  • titel

    tekenreeks optioneel

    De titel van de bladwijzer; komt woordelijk overeen.

  • URL

    tekenreeks optioneel

    De URL van de bladwijzer; komt woordelijk overeen. Houd er rekening mee dat mappen geen URL hebben.

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (results: BookmarkTreeNode[]) => void

  • resultaten

    BladwijzerBoomNode []

Retouren

• Belofte< BookmarkTreeNode []>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

update()

Belofte

chrome.bookmarks.update(
  id: string,
  changes: object,
  callback?: function,
)

Werkt de eigenschappen van een bladwijzer of map bij. Geef alleen de eigenschappen op die u wilt wijzigen; niet-gespecificeerde eigenschappen blijven ongewijzigd. Let op: Momenteel worden alleen 'title' en 'url' ondersteund.

Parameters

• Identiteitskaart

  snaar

• veranderingen

  voorwerp

  • titel

    tekenreeks optioneel

  • URL

    tekenreeks optioneel

• terugbellen

  functie optioneel

  De callback parameter ziet er als volgt uit:

  (result: BookmarkTreeNode) => void

  • resultaat

    BladwijzerTreeNode

Retouren

• Belofte <BookmarkTreeNode>

  Chroom 90+

  Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Evenementen

onChanged

chrome.bookmarks.onChanged.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een bladwijzer of map verandert. Opmerking: momenteel activeren alleen titel- en URL-wijzigingen dit.

Parameters

• terugbellen

  functie

  De callback parameter ziet er als volgt uit:

  (id: string, changeInfo: object) => void

  • Identiteitskaart

    snaar

  • wijzigInfo

    voorwerp

    • titel

      snaar

    • URL

      tekenreeks optioneel

onChildrenReordered

chrome.bookmarks.onChildrenReordered.addListener(
  callback: function,
)

Wordt geactiveerd wanneer de onderliggende mappen van een map hun volgorde hebben gewijzigd omdat de volgorde in de gebruikersinterface is gesorteerd. Dit wordt niet aangeroepen als resultaat van een move().

Parameters

• terugbellen

  functie

  De callback parameter ziet er als volgt uit:

  (id: string, reorderInfo: object) => void

  • Identiteitskaart

    snaar

  • opnieuw bestellenInfo

    voorwerp

    • kinderIds

      snaar[]

onCreated

chrome.bookmarks.onCreated.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een bladwijzer of map wordt gemaakt.

Parameters

• terugbellen

  functie

  De callback parameter ziet er als volgt uit:

  (id: string, bookmark: BookmarkTreeNode) => void

  • Identiteitskaart

    snaar

  • bladwijzer

    BladwijzerTreeNode

onImportBegan

chrome.bookmarks.onImportBegan.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een bladwijzerimportsessie wordt gestart. Dure waarnemers moeten onCreated-updates negeren totdat onImportEnded wordt geactiveerd. Waarnemers moeten andere meldingen nog steeds onmiddellijk afhandelen.

Parameters

• terugbellen

  functie

  De callback parameter ziet er als volgt uit:

  () => void

onImportEnded

chrome.bookmarks.onImportEnded.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een bladwijzerimportsessie wordt beëindigd.

Parameters

• terugbellen

  functie

  De callback parameter ziet er als volgt uit:

  () => void

onMoved

chrome.bookmarks.onMoved.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een bladwijzer of map naar een andere bovenliggende map wordt verplaatst.

Parameters

• terugbellen

  functie

  De callback parameter ziet er als volgt uit:

  (id: string, moveInfo: object) => void

  • Identiteitskaart

    snaar

  • verplaatsInfo

    voorwerp

    • index

      nummer

    • oudeIndex

      nummer

    • oudOuderId

      snaar

    • ouderId

      snaar

onRemoved

chrome.bookmarks.onRemoved.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een bladwijzer of map wordt verwijderd. Wanneer een map recursief wordt verwijderd, wordt er één melding afgegeven voor de map en geen melding voor de inhoud ervan.

Parameters

• terugbellen

  functie

  De callback parameter ziet er als volgt uit:

  (id: string, removeInfo: object) => void

  • Identiteitskaart

    snaar

  • verwijderInfo

    voorwerp

    • index

      nummer

    • knooppunt

      BladwijzerTreeNode

      Chroom 48+
    • ouderId

      snaar