chrome.bladwijzers

Deze toestemming activeert een waarschuwing .

Beschrijving

Gebruik de chrome.bookmarks API om bladwijzers te maken, te organiseren en te beheren. Zie ook Pagina's overschrijven , waarmee je een aangepaste pagina voor bladwijzerbeheer kunt maken.

Toestemmingen

bookmarks

Door op de ster te klikken, wordt een bladwijzer toegevoegd.

Manifest

Om de bladwijzer-API te kunnen gebruiken, moet u de machtiging "bookmarks" in het extensiemanifest declareren. Bijvoorbeeld:

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

Objecten en eigenschappen

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

De eigenschappen BookmarkTreeNode worden gebruikt in de gehele chrome.bookmarks API. Wanneer je bijvoorbeeld bookmarks.create aanroept, geef je de ouder van het nieuwe knooppunt ( parentId ) door, en optioneel de eigenschappen index , title en url van het knooppunt. Zie bookmarks.BookmarkTreeNode voor informatie over de eigenschappen die een knooppunt kan hebben.

Voorbeelden

De volgende code maakt een map aan met de titel "Extension bookmarks". Het eerste argument van create() specificeert eigenschappen voor de nieuwe map. Het tweede argument definieert een functie die wordt uitgevoerd nadat de map is aangemaakt.

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

Het volgende codefragment maakt een bladwijzer aan die verwijst naar de ontwikkelaarsdocumentatie voor extensies. Omdat er niets ergs gebeurt als het aanmaken van de bladwijzer mislukt, wordt er in deze code geen callback-functie gedefinieerd.

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

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

Soorten

BookmarkTreeNode

Een knooppunt (een bladwijzer of een map) in de bladwijzerstructuur. Subknooppunten worden binnen hun bovenliggende map geordend.

Eigenschappen

  • kinderen

    BookmarkTreeNode [] optioneel

    Een geordende lijst van de kinderen van dit knooppunt.

  • datum toegevoegd

    nummer optioneel

    Wanneer dit knooppunt is aangemaakt, in milliseconden sinds de epoch ( new Date(dateAdded) ).

  • datumGroepGewijzigd

    nummer optioneel

    Het tijdstip waarop de inhoud van deze map voor het laatst is gewijzigd, in milliseconden sinds het begin van het tijdperk.

  • datumLaatstGebruikt

    nummer optioneel

    Chrome 114+

    Wanneer dit knooppunt voor het laatst is geopend, in milliseconden sinds de epoch. Niet ingesteld voor mappen.

  • mapType

    Maptype (optioneel)

    Chrome 134+

    Indien aanwezig, is dit een map die door de browser wordt toegevoegd en die niet door de gebruiker of de extensie kan worden gewijzigd. Submappen kunnen wel worden gewijzigd als deze map niet de eigenschap ' unmodifiable heeft. Deze map wordt weggelaten als de map door de gebruiker en de extensie kan worden gewijzigd (standaard).

    Er kunnen nul, één of meerdere knooppunten van elk maptype zijn. Een map kan door de browser worden toegevoegd of verwijderd, maar niet via de extensie-API.

  • id

    snaar

    De unieke identificatiecode voor het knooppunt. ID's zijn uniek binnen het huidige profiel en blijven geldig, zelfs na het opnieuw opstarten van de browser.

  • index

    nummer optioneel

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

  • ouder-ID

    string optioneel

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

  • synchroniseren

    booleaans

    Chrome 134+

    Of dit knooppunt door de browser is gesynchroniseerd met de externe accountopslag van de gebruiker. Dit kan worden gebruikt om onderscheid te maken tussen accountversies en lokale versies van hetzelfde FolderType . De waarde van deze eigenschap kan voor een bestaand knooppunt veranderen, bijvoorbeeld als gevolg van een gebruikersactie.

    Let op: dit geeft aan of het knooppunt is opgeslagen bij de ingebouwde accountprovider van de browser. Het is mogelijk dat een knooppunt via een derde partij wordt gesynchroniseerd, zelfs als deze waarde onwaar is.

    Voor beheerde knooppunten (knooppunten waar unmodifiable is ingesteld op true ) zal deze eigenschap altijd false zijn.

  • titel

    snaar

    De tekst die voor het knooppunt wordt weergegeven.

  • onwijzigbaar

    "beheerd"
    optioneel

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

  • URL

    string optioneel

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

BookmarkTreeNodeUnmodifiable

Chrome 44+

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

Waarde

"beheerd"

CreateDetails

Object doorgegeven aan de create()-functie.

Eigenschappen

  • index

    nummer optioneel

  • ouder-ID

    string optioneel

    Standaard wordt de map 'Overige bladwijzers' gebruikt.

  • titel

    string optioneel

  • URL

    string optioneel

FolderType

Chrome 134+

Geeft het type map aan.

Enum

"bladwijzerbalk"
De map waarvan de inhoud bovenaan het browservenster wordt weergegeven.

"ander"
Bladwijzers die worden weergegeven in de volledige lijst met bladwijzers op alle platforms.

"mobiel"
Bladwijzers zijn doorgaans beschikbaar op de mobiele apparaten van de gebruiker, maar kunnen worden gewijzigd via een extensie of in de bladwijzerbeheerder.

"beheerd"
Een map op het hoogste niveau die aanwezig kan zijn als de systeembeheerder of de beheerder van een gebruiker met toezicht bladwijzers heeft geconfigureerd.

Eigenschappen

MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

Verouderd

Het schrijven van bladwijzers is niet langer beperkt door Chrome.

Waarde

1.000.000

MAX_WRITE_OPERATIONS_PER_HOUR

Verouderd

Het schrijven van bladwijzers is niet langer beperkt door Chrome.

Waarde

1.000.000

ROOT_NODE_ID

In behandeling

De id die is gekoppeld aan het knooppunt op het hoogste niveau.

Waarde

"0"

Methoden

create()

Belofte
chrome.bookmarks.create(
  bookmark: CreateDetails,
  callback?: function,
): Promise<BookmarkTreeNode>

Hiermee wordt een bladwijzer of map aangemaakt onder de opgegeven parentId. Als de URL NULL is of ontbreekt, wordt er een map aangemaakt.

Parameters

Retourneert

  • Promise< BookmarkTreeNode >

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

get()

Belofte
chrome.bookmarks.get(
  idOrIdList: string | [string, ...string[]],
  callback?: function,
): Promise<BookmarkTreeNode[]>

Haalt de opgegeven BookmarkTreeNode(s) op.

Parameters

  • idOrIdList

    string | [string, ...string[]]

    Een enkele tekenreeks-ID, of een array van tekenreeks-ID's.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (results: BookmarkTreeNode[]) => void

Retourneert

  • Promise< BookmarkTreeNode []>

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getChildren()

Belofte
chrome.bookmarks.getChildren(
  id: string,
  callback?: function,
): Promise<BookmarkTreeNode[]>

Haalt de kinderen op van de opgegeven BookmarkTreeNode-ID.

Parameters

  • id

    snaar

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (results: BookmarkTreeNode[]) => void

Retourneert

  • Promise< BookmarkTreeNode []>

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getRecent()

Belofte
chrome.bookmarks.getRecent(
  numberOfItems: number,
  callback?: function,
): Promise<BookmarkTreeNode[]>

Haalt de recent toegevoegde bladwijzers op.

Parameters

  • aantal items

    nummer

    Het maximale aantal artikelen dat u kunt retourneren.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (results: BookmarkTreeNode[]) => void

Retourneert

  • Promise< BookmarkTreeNode []>

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getSubTree()

Belofte
chrome.bookmarks.getSubTree(
  id: string,
  callback?: function,
): Promise<BookmarkTreeNode[]>

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

Parameters

  • id

    snaar

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

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (results: BookmarkTreeNode[]) => void

Retourneert

  • Promise< BookmarkTreeNode []>

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getTree()

Belofte
chrome.bookmarks.getTree(
  callback?: function,
): Promise<BookmarkTreeNode[]>

Haalt de volledige bladwijzerhiërarchie op.

Parameters

Retourneert

  • Promise< BookmarkTreeNode []>

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

move()

Belofte
chrome.bookmarks.move(
  id: string,
  destination: object,
  callback?: function,
): Promise<BookmarkTreeNode>

Verplaatst het opgegeven BookmarkTreeNode naar de opgegeven locatie.

Parameters

  • id

    snaar

  • bestemming

    voorwerp

    • index

      nummer optioneel

    • ouder-ID

      string optioneel

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: BookmarkTreeNode) => void

Retourneert

  • Promise< BookmarkTreeNode >

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

remove()

Belofte
chrome.bookmarks.remove(
  id: string,
  callback?: function,
): Promise<void>

Verwijdert een bladwijzer of een lege bladwijzermap.

Parameters

  • id

    snaar

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

removeTree()

Belofte
chrome.bookmarks.removeTree(
  id: string,
  callback?: function,
): Promise<void>

Verwijdert recursief een bladwijzermap.

Parameters

  • id

    snaar

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

Belofte
chrome.bookmarks.search(
  query: string | object,
  callback?: function,
): Promise<BookmarkTreeNode[]>

Zoekt naar BookmarkTreeNodes die overeenkomen met de opgegeven query. Query's die met een object worden gespecificeerd, leveren BookmarkTreeNodes op die aan alle opgegeven eigenschappen voldoen.

Parameters

  • vraag

    tekenreeks | object

    Ofwel een reeks woorden en geciteerde zinnen die worden vergeleken met URL's en titels van bladwijzers, ofwel een object. Indien het een object betreft, kunnen de eigenschappen query , url en title worden gespecificeerd en worden bladwijzers gegenereerd die aan alle gespecificeerde eigenschappen voldoen.

    • vraag

      string optioneel

      Een reeks woorden en geciteerde zinnen die worden vergeleken met URL's en titels van bladwijzers.

    • titel

      string optioneel

      De titel van de bladwijzer; komt letterlijk overeen.

    • URL

      string optioneel

      De URL van de bladwijzer; komt exact overeen. Mappen hebben geen URL.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (results: BookmarkTreeNode[]) => void

Retourneert

  • Promise< BookmarkTreeNode []>

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

update()

Belofte
chrome.bookmarks.update(
  id: string,
  changes: object,
  callback?: function,
): Promise<BookmarkTreeNode>

Hiermee kunt u de eigenschappen van een bladwijzer of map bijwerken. Geef alleen de eigenschappen op die u wilt wijzigen; niet-opgegeven eigenschappen blijven ongewijzigd. Opmerking: Momenteel worden alleen 'titel' en 'url' ondersteund.

Parameters

  • id

    snaar

  • veranderingen

    voorwerp

    • titel

      string optioneel

    • URL

      string optioneel

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: BookmarkTreeNode) => void

Retourneert

  • Promise< BookmarkTreeNode >

    Chrome 90+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

Evenementen

onChanged

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

Wordt geactiveerd wanneer een bladwijzer of map wordt gewijzigd. Let op: Momenteel wordt dit alleen geactiveerd door wijzigingen in de titel en de URL.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

    • id

      snaar

    • changeInfo

      voorwerp

      • titel

        snaar

      • URL

        string optioneel

onChildrenReordered

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

Deze functie wordt aangeroepen wanneer de volgorde van de submappen in een map verandert doordat de sorteervolgorde in de gebruikersinterface is aangepast. Deze functie wordt niet aangeroepen als gevolg van een `move()`-bewerking.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

    • id

      snaar

    • herbestelinfo

      voorwerp

      • kindID's

        snaar[]

onCreated

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

Wordt geactiveerd wanneer een bladwijzer of map wordt aangemaakt.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

onImportBegan

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

Wordt geactiveerd wanneer een sessie voor het importeren van bladwijzers wordt gestart. Dure observers moeten updates van onCreated negeren totdat onImportEnded wordt geactiveerd. Observers moeten andere meldingen wel direct afhandelen.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onImportEnded

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

Wordt geactiveerd wanneer een sessie voor het importeren van bladwijzers wordt beëindigd.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onMoved

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

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

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

    • id

      snaar

    • moveInfo

      voorwerp

      • index

        nummer

      • oudeIndex

        nummer

      • oudeOuderID

        snaar

      • ouder-ID

        snaar

onRemoved

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

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

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

    • id

      snaar

    • removeInfo

      voorwerp