chrome.bookmarks

Açıklama

Yer işaretlerini oluşturmak, düzenlemek ve diğer amaçlarla değiştirmek için chrome.bookmarks API'sini kullanın. Ayrıca, özel bir Yer İşareti Yöneticisi sayfası oluşturmak için kullanabileceğiniz Sayfaları Geçersiz Kılma konusuna da bakın.

Yıldız tıklandığında bir yer işareti eklenir
Yıldız tıklandığında bir yer işareti eklenir.

İzinler

bookmarks

"Yer işaretlerini" bildirmeniz gerekir uzantı manifestinde yer işaretleri API'sini kullanma izni olduğundan emin olun. Örneğin:

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

Kavramlar ve kullanım

Nesneler ve özellikler

Yer işaretleri, ağaçtaki her düğümün bir yer işareti veya klasör olduğu bir ağaçta düzenlenir (bazen grup olarak da adlandırılır). Ağaçtaki her düğüm bir bookmarks.BookmarkTreeNode nesnesi olarak değiştirin.

BookmarkTreeNode mülkleri, chrome.bookmarks API'si genelinde kullanılır. Örneğin, bookmarks.create yöntemini çağırırsanız yeni düğümün üst öğesini (parentId) ve isteğe bağlı olarak düğümün index, title ve url özellikleri. Bilgi için bookmarks.BookmarkTreeNode sayfasına göz atın özellikler hakkında daha fazla bilgi edineceksiniz.

Örnekler

Aşağıdaki kod, "Uzantı yer işaretleri" başlıklı bir klasör oluşturur. İlk bağımsız değişken create(), yeni klasörün özelliklerini belirtir. İkinci bağımsız değişken, yürütülebilir.

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

Sonraki snippet, uzantılarla ilgili geliştirici dokümanlarını işaret eden bir yer işareti oluşturur. Başlangıç yer imi oluşturma başarısız olursa kötü bir şey olmaz; bu kod, geri çağırma işlevinden yararlanırız.

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

Bu API'yi denemek için chrome-extension-samples bölümünden Bookmarks API örneğini yükleyin. depodur.

Türler

BookmarkTreeNode

Yer işareti ağacındaki bir düğüm (yer işareti veya klasör). Alt düğümler üst klasörlerin içinde sıralanır.

Özellikler

  • çocuklar

    BookmarkTreeNode[] isteğe bağlı

    Bu düğümün alt öğelerinin sıralı bir listesi.

  • dateAdded

    sayı isteğe bağlı

    Dönemden (new Date(dateAdded)) bu yana geçen milisaniye cinsinden bu düğümün oluşturulma zamanı.

  • dateGroupModified

    sayı isteğe bağlı

    Bu klasörün içeriğinin en son ne zaman değiştiği (dönemden bu yana milisaniye cinsinden).

  • dateLastUsed

    sayı isteğe bağlı

    Chrome 114 ve sonraki sürümler 'nı inceleyin.

    Bu düğümün en son açıldığı zaman (dönemden bu yana geçen milisaniye cinsinden). Klasörler için ayarlanmadı.

  • id

    dize

    Düğümün benzersiz tanımlayıcısı. Kimlikler, mevcut profil içinde benzersizdir ve tarayıcı yeniden başlatıldıktan sonra bile geçerli kalır.

  • indeks

    sayı isteğe bağlı

    Bu düğümün, üst klasörü içindeki 0 tabanlı konumu.

  • parentId

    dize isteğe bağlı

    Üst klasörün id öğesi. Kök düğüm için atlanır.

  • title

    dize

    Düğüm için görüntülenen metin.

  • değiştirilemez

    "managed"
     isteğe bağlı

    Bu düğümün neden değiştirilemeyeceğini belirtir. managed değeri, bu düğümün sistem yöneticisi veya denetlenen bir kullanıcının koruyucusu tarafından yapılandırıldığını gösterir. Düğüm, kullanıcı ve uzantı tarafından değiştirilebilirse atlanır (varsayılan).

  • url

    dize isteğe bağlı

    Kullanıcı yer işaretini tıkladığında gidilen URL. Klasörler için dahil edilmez.

BookmarkTreeNodeUnmodifiable

Chrome 44 ve sonraki sürümler 'nı inceleyin.

Bu düğümün neden değiştirilemeyeceğini belirtir. managed değeri bu düğümün sistem yöneticisi tarafından yapılandırıldığını gösterir. Düğüm, kullanıcı ve uzantı tarafından değiştirilebilirse atlanır (varsayılan).

Değer

"yönetilen"

CreateDetails

create() işlevine iletilen nesne.

Özellikler

  • indeks

    sayı isteğe bağlı

  • parentId

    dize isteğe bağlı

    Varsayılan olarak Diğer Yer İşaretleri klasörü kullanılır.

  • title

    dize isteğe bağlı

  • url

    dize isteğe bağlı

Özellikler

MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

Desteği sonlandırıldı

Yer işareti yazma işlemleri artık Chrome tarafından sınırlanmamaktadır.

Değer

1.000.000

MAX_WRITE_OPERATIONS_PER_HOUR

Desteği sonlandırıldı

Yer işareti yazma işlemleri artık Chrome tarafından sınırlanmamaktadır.

Değer

1.000.000

Yöntemler

create()

Söz 'nı inceleyin.
chrome.bookmarks.create(
  bookmark: CreateDetails,
  callback?: function,
)

Belirtilen üst öğe kimliği altında bir yer işareti veya klasör oluşturur. URL NULL veya eksikse klasör olarak gösterilir.

Parametreler

İadeler

  • Promise<BookmarkTreeNode>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

get()

Söz 'nı inceleyin.
chrome.bookmarks.get(
  idOrIdList: string | [string, ...string[]],
  callback?: function,
)

Belirtilen bookmarkTreeNode'ları alır.

Parametreler

  • idOrIdList

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

    Tek bir dize değerli kimlik veya dize değerli kimlikler dizisi

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (results: BookmarkTreeNode[]) => void

İadeler

  • Promise<BookmarkTreeNode[]>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

getChildren()

Söz 'nı inceleyin.
chrome.bookmarks.getChildren(
  id: string,
  callback?: function,
)

Belirtilen bookmarkTreeNode kimliğinin alt öğelerini alır.

Parametreler

  • id

    dize

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (results: BookmarkTreeNode[]) => void

İadeler

  • Promise<BookmarkTreeNode[]>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

getRecent()

Söz 'nı inceleyin.
chrome.bookmarks.getRecent(
  numberOfItems: number,
  callback?: function,
)

Son eklenen yer işaretlerini alır.

Parametreler

  • numberOfItems

    sayı

    Döndürülecek maksimum öğe sayısı.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (results: BookmarkTreeNode[]) => void

İadeler

  • Promise<BookmarkTreeNode[]>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

getSubTree()

Söz 'nı inceleyin.
chrome.bookmarks.getSubTree(
  id: string,
  callback?: function,
)

Belirtilen düğümden başlayarak Yer işaretleri hiyerarşisinin bir bölümünü alır.

Parametreler

  • id

    dize

    Alınacak alt ağacın kökünün kimliği.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (results: BookmarkTreeNode[]) => void

İadeler

  • Promise<BookmarkTreeNode[]>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

getTree()

Söz 'nı inceleyin.
chrome.bookmarks.getTree(
  callback?: function,
)

Yer işaretleri hiyerarşisinin tamamını alır.

Parametreler

İadeler

  • Promise<BookmarkTreeNode[]>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

move()

Söz 'nı inceleyin.
chrome.bookmarks.move(
  id: string,
  destination: object,
  callback?: function,
)

Belirtilen FavoriTreeNode öğesini sağlanan konuma taşır.

Parametreler

  • id

    dize

  • hedef

    nesne

    • indeks

      sayı isteğe bağlı

    • parentId

      dize isteğe bağlı

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: BookmarkTreeNode) => void

İadeler

  • Promise<BookmarkTreeNode>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

remove()

Söz 'nı inceleyin.
chrome.bookmarks.remove(
  id: string,
  callback?: function,
)

Bir yer işaretini veya boş bir yer işareti klasörünü kaldırır.

Parametreler

  • id

    dize

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    () => void

İadeler

  • Taahhüt<void>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

removeTree()

Söz 'nı inceleyin.
chrome.bookmarks.removeTree(
  id: string,
  callback?: function,
)

Bir yer işareti klasörünü yinelemeli olarak kaldırır.

Parametreler

  • id

    dize

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    () => void

İadeler

  • Taahhüt<void>

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

Söz 'nı inceleyin.
chrome.bookmarks.search(
  query: string | object,
  callback?: function,
)

Belirtilen sorguyla eşleşen bookmarkTreeNodes için arama yapar. Bir nesneyle belirtilen sorgular, belirtilen tüm özelliklerle eşleşen bookmarkTreeNode'lar oluşturur.

Parametreler

  • sorgu

    string | nesne

    Yer işareti URL'leri ve başlıklarla eşleşen kelime ve alıntılanmış kelime öbekleri veya bir nesne ile eşleşen dize. Bir nesne olursa query, url ve title özellikleri belirtilebilir ve belirtilen tüm özelliklerle eşleşen yer işaretleri oluşturulur.

    • sorgu

      dize isteğe bağlı

      Yer işareti URL'leri ve başlıklarla eşleşen kelime ve alıntılanmış kelime öbeklerinden oluşan bir dize.

    • title

      dize isteğe bağlı

      Yer işaretinin başlığı; aynen eşleşir.

    • url

      dize isteğe bağlı

      Yer işaretinin URL'si; aynen eşleşir. Klasörlerin URL'si olmadığını unutmayın.

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (results: BookmarkTreeNode[]) => void

İadeler

  • Promise&lt;BookmarkTreeNode[]&gt;

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

update()

Söz 'nı inceleyin.
chrome.bookmarks.update(
  id: string,
  changes: object,
  callback?: function,
)

Bir yer işaretinin veya klasörün özelliklerini günceller. Yalnızca değiştirmek istediğiniz özellikleri belirtin; belirtilmemiş özellikler değiştirilmez. Not: Şu anda yalnızca "başlık" ve "url" desteklenir.

Parametreler

  • id

    dize

  • değişiklikler

    nesne

    • title

      dize isteğe bağlı

    • url

      dize isteğe bağlı

  • geri çağırma

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (result: BookmarkTreeNode) => void

İadeler

  • Promise&lt;BookmarkTreeNode&gt;

    Chrome 90 ve sonraki sürümler 'nı inceleyin.

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

Etkinlikler

onChanged

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

Bir yer işareti veya klasör değiştiğinde tetiklenir. Not: Şu anda yalnızca başlık ve URL değişiklikleri bu işlemi tetiklemektedir.

Parametreler

  • geri çağırma

    işlev

    callback parametresi şu şekilde görünür: 

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

    • id

      dize

    • changeInfo

      nesne

      • title

        dize

      • url

        dize isteğe bağlı

onChildrenReordered

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

Bir klasörün alt öğeleri, kullanıcı arayüzünde sıralanmaları nedeniyle sıralarını değiştirdiğinde tetiklenir. Bu,move() işleminin bir sonucu olarak çağrılmaz.

Parametreler

  • geri çağırma

    işlev

    callback parametresi şu şekilde görünür: 

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

    • id

      dize

    • reorderInfo

      nesne

      • childIds

        dize[]

onCreated

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

Bir yer işareti veya klasör oluşturulduğunda tetiklenir.

Parametreler

  • geri çağırma

    işlev

    callback parametresi şu şekilde görünür: 

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

onImportBegan

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

Yer işareti içe aktarma oturumu başlatıldığında tetiklenir. Pahalı gözlemciler, onImportEnded tetiklenene kadar onCreated güncellemelerini yoksaymalıdır. Gözlemciler diğer bildirimleri hemen işlemeye devam etmelidir.

Parametreler

  • geri çağırma

    işlev

    callback parametresi şu şekilde görünür: 

    () => void

onImportEnded

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

Yer işareti içe aktarma oturumu sona erdiğinde tetiklenir.

Parametreler

  • geri çağırma

    işlev

    callback parametresi şu şekilde görünür: 

    () => void

onMoved

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

Bir yer işareti veya klasör farklı bir üst klasöre taşındığında tetiklenir.

Parametreler

  • geri çağırma

    işlev

    callback parametresi şu şekilde görünür: 

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

    • id

      dize

    • moveInfo

      nesne

      • indeks

        sayı

      • oldIndex

        sayı

      • oldParentId

        dize

      • parentId

        dize

onRemoved

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

Bir yer işareti veya klasör kaldırıldığında tetiklenir. Bir klasör tekrar tekrar kaldırıldığında klasör için tek bir bildirim tetiklenir ve içindekiler için herhangi bir bildirim tetiklenmez.

Parametreler

  • geri çağırma

    işlev

    callback parametresi şu şekilde görünür: 

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

    • id

      dize

    • removeInfo

      nesne

      • indeks

        sayı

      • düğüm

        BookmarkTreeNode

        Chrome 48 ve sonraki sürümler 'nı inceleyin.
      • parentId

        dize