chrome.bladwijzers

Beschrijving

Gebruik de chrome.bookmarks API om bladwijzers te maken, te ordenen en anderszins te bewerken. Zie ook 'Override Pages' , waarmee u een aangepaste Bookmark Manager-pagina kunt maken.

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

Machtigingen

bookmarks

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

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

Begrippen en gebruik

Objecten en eigenschappen

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

BookmarkTreeNode eigenschappen worden gebruikt in de chrome.bookmarks API. Wanneer u bijvoorbeeld bookmarks.create aanroept, geeft u de bovenliggende node ( parentId ) en optioneel de index , title en url eigenschappen van de node door. Zie bookmarks.BookmarkTreeNode voor informatie over de eigenschappen die een node 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 moet worden 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 fragment creëert een bladwijzer die verwijst naar de ontwikkelaarsdocumentatie voor extensies. Omdat er niets misgaat als het aanmaken van de bladwijzer mislukt, neemt deze code niet de moeite om een callbackfunctie te definiëren.

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

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

Typen

BookmarkTreeNode

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

Eigenschappen

  • kinderen

    BookmarkTreeNode [] optioneel

    Een geordende lijst van kinderen van dit knooppunt.

  • datum toegevoegd

    nummer optioneel

    Wanneer dit knooppunt is gemaakt, in milliseconden sinds het tijdperk ( new Date(dateAdded) ).

  • datumGroepGewijzigd

    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 is geopend, in milliseconden sinds het tijdperk. Niet ingesteld voor mappen.

  • mapType

    FolderType optioneel

    Chroom 134+

    Indien aanwezig, is dit een map die door de browser wordt toegevoegd en die niet kan worden gewijzigd door de gebruiker of de extensie. Onderliggende knooppunten kunnen worden gewijzigd als dit knooppunt niet de eigenschap unmodifiable heeft. Weggelaten als het knooppunt 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 nadat de browser opnieuw is opgestart.

  • 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

    Booleaanse

    Chroom 134+

    Of dit knooppunt door de browser wordt 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 in de ingebouwde accountprovider van de browser. Het is mogelijk dat een knooppunt via een derde partij wordt gesynchroniseerd, zelfs als deze waarde false is.

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

  • titel

    snaar

    De tekst die voor het knooppunt wordt weergegeven.

  • onveranderlijk

    "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 gesuperviseerde gebruiker. Wordt weggelaten als het knooppunt kan worden gewijzigd door de gebruiker en de extensie (standaard).

  • url

    string optioneel

    De URL waarheen genavigeerd wordt 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. Wordt 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

  • ouder-ID

    string optioneel

    Standaard staat deze map in de map Overige bladwijzers.

  • titel

    string optioneel

  • url

    string optioneel

FolderType

Chroom 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 bewaakte gebruiker bladwijzers heeft geconfigureerd.

Eigenschappen

MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

Verouderd

De schrijfbewerkingen voor bladwijzers worden niet langer beperkt door Chrome.

Waarde

1000000

MAX_WRITE_OPERATIONS_PER_HOUR

Verouderd

De schrijfbewerkingen voor bladwijzers worden niet langer beperkt door Chrome.

Waarde

1000000

Methoden

create()

chrome.bookmarks.create(
  bookmark: CreateDetails,
): Promise<BookmarkTreeNode>

Maakt een bladwijzer of map aan onder de opgegeven parent-ID. Als url NULL is of ontbreekt, wordt het een map.

Parameters

Retourneren

get()

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

Haalt de opgegeven BookmarkTreeNode(s) op.

Parameters

  • idOfIdLijst

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

    Een enkele tekenreeks-id, of een reeks tekenreeks-id's

Retourneren

getChildren()

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

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

Parameters

  • id

    snaar

Retourneren

getRecent()

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

Haalt de recent toegevoegde bladwijzers op.

Parameters

  • aantal items

    nummer

    Het maximale aantal te retourneren artikelen.

Retourneren

getSubTree()

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

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

Parameters

  • id

    snaar

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

Retourneren

getTree()

chrome.bookmarks.getTree(): Promise<BookmarkTreeNode[]>

Haalt de volledige bladwijzerhiërarchie op.

Retourneren

move()

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

Verplaatst de opgegeven BookmarkTreeNode naar de opgegeven locatie.

Parameters

  • id

    snaar

  • bestemming

    voorwerp

    • index

      nummer optioneel

    • ouder-ID

      string optioneel

Retourneren

remove()

chrome.bookmarks.remove(
  id: string,
): Promise<void>

Verwijdert een bladwijzer of een lege bladwijzermap.

Parameters

  • id

    snaar

Retourneren

  • Belofte<leegte>

    Chroom 90+

removeTree()

chrome.bookmarks.removeTree(
  id: string,
): Promise<void>

Verwijdert recursief een bladwijzermap.

Parameters

  • id

    snaar

Retourneren

  • Belofte<leegte>

    Chroom 90+
chrome.bookmarks.search(
  query: string | object,
): Promise<BookmarkTreeNode[]>

Zoekt naar BookmarkTreeNodes die voldoen aan de opgegeven query. Query's die met een object zijn opgegeven, genereren BookmarkTreeNodes die voldoen aan alle opgegeven eigenschappen.

Parameters

  • vraag

    tekenreeks | object

    Ofwel een reeks woorden en aanhalingstekens die worden vergeleken met bladwijzer-URL's en titels, ofwel een object. Bij een object kunnen de eigenschappen query , url en title worden opgegeven. Bladwijzers die aan alle opgegeven eigenschappen voldoen, worden gegenereerd.

    • vraag

      string optioneel

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

    • titel

      string optioneel

      De titel van de bladwijzer komt letterlijk overeen.

    • url

      string optioneel

      De URL van de bladwijzer komt letterlijk overeen. Merk op dat mappen geen URL hebben.

Retourneren

update()

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

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

Parameters

  • id

    snaar

  • veranderingen

    voorwerp

    • titel

      string optioneel

    • url

      string optioneel

Retourneren

Evenementen

onChanged

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

Wordt geactiveerd wanneer een bladwijzer of map verandert. Let op: momenteel worden deze acties alleen uitgevoerd bij wijzigingen in de titel en URL.

Parameters

  • terugbellen

    functie

    De callback 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,
)

Wordt geactiveerd wanneer de volgorde van de onderliggende mappen van een map is gewijzigd vanwege de sortering in de gebruikersinterface. Dit wordt niet aangeroepen als gevolg van een move().

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

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

    • id

      snaar

    • herbestellingsinfo

      voorwerp

      • kinder-ID's

        snaar[]

onCreated

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

Wordt geactiveerd wanneer een bladwijzer of map wordt aangemaakt.

Parameters

onImportBegan

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

Wordt geactiveerd wanneer een bladwijzerimportsessie wordt gestart. Dure waarnemers dienen onCreated-updates te negeren totdat onImportEnded wordt geactiveerd. Waarnemers dienen andere meldingen nog steeds direct te verwerken.

Parameters

  • terugbellen

    functie

    De callback 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 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 ziet er als volgt uit: 

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

    • id

      snaar

    • moveInfo

      voorwerp

      • index

        nummer

      • oudeIndex

        nummer

      • oudeParentId

        snaar

      • ouder-ID

        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 voor de map gegenereerd en geen enkele melding voor de inhoud ervan.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

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

    • id

      snaar

    • verwijderInfo

      voorwerp