chrome.bookmarks

Açıklama

Yer işaretleri oluşturmak, düzenlemek ve başka şekillerde değiştirmek için chrome.bookmarks API'yi 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ıkladığınızda bir yer işareti eklenir.

İzinler

bookmarks

Yer İşaretleri API'sini kullanmak için uzantı manifestinde "yer işaretleri" iznini beyan etmeniz gerekir. Ö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 (bazen grup olarak adlandırılır) olduğu bir ağaçta düzenlenir. Ağaçtaki her düğüm bir bookmarks.BookmarkTreeNode nesnesiyle temsil edilir.

chrome.bookmarks API'sinin tamamında BookmarkTreeNode özellikleri kullanılır. Örneğin, bookmarks.create çağrısı yaptığınızda, yeni düğümün üst öğesini (parentId) ve isteğe bağlı olarak düğümün index, title ve url özelliklerini geçirirsiniz. Bir düğümün sahip olabileceği özellikler hakkında bilgi edinmek için bookmarks.BookmarkTreeNode bölümüne bakın.

Not: Kök klasöre giriş eklemek veya kök klasöre giriş kaldırmak için bu API'yi kullanamazsınız. Ayrıca, özel "Yer İşaretleri Çubuğu" ve "Diğer Yer İşaretleri" klasörlerini yeniden adlandıramaz, taşıyamaz veya kaldıramazsınız.

Örnekler

Aşağıdaki kod "Uzantı yer işaretleri" başlıklı bir klasör oluşturur. create() öğesinin ilk bağımsız değişkeni, yeni klasörün özelliklerini belirtir. İkinci bağımsız değişken, klasör oluşturulduktan sonra yürütülecek bir işlevi tanımlar.

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

Bir sonraki snippet, uzantılarla ilgili geliştirici dokümanlarına işaret eden bir yer işareti oluşturur. Yer işareti oluşturma işlemi başarısız olursa hiçbir sorun olmayacağından, bu kod bir geri çağırma işlevi tanımlamaz.

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

Bu API'yi denemek için chrome-extension-samples deposundan Bookmarks API örneğini yükleyin.

Türler

BookmarkTreeNode

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

Özellikler

• çocuklar

  BookmarkTreeNode[] isteğe bağlı

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

• dateAdded

  numara isteğe bağlı

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

• dateGroupModified

  numara isteğe bağlı

  Bu klasörün içeriğinin en son değiştirildiği tarih (sıfır zamandan bu yana milisaniye cinsinden).

• dateLastUsed

  numara isteğe bağlı

  Chrome 114 ve sonraki sürümler

  Bu düğümün son açıldığı zaman (sıfır zamandan bu yana 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

  numara isteğe bağlı

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

• parentId

  string 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

  isteğe bağlı

  Bu düğümün neden değiştirilemez olduğunu 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ştirilebiliyorsa atlanır (varsayılan).

• url

  string isteğe bağlı

  Bir kullanıcı, yer işaretini tıkladığında yönlendirildiği URL. Klasörler için yoksayılır.

BookmarkTreeNodeUnmodifiable

Chrome 44 ve sonraki sürümler

Bu düğümün neden değiştirilemez olduğunu 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ştirilebiliyorsa atlanır (varsayılan).

Değer

CreateDetails

create() işlevine nesne iletildi.

Özellikler

• indeks

  numara isteğe bağlı

• parentId

  string isteğe bağlı

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

• title

  string isteğe bağlı

• url

  string isteğe bağlı

Özellikler

MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

Kullanımdan kaldı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

Kullanımdan kaldı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

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

Belirtilen parentId altında bir yer işareti veya klasör oluşturur. URL NULL ise veya eksikse bir klasör olur.

Parametreler

• yer işareti koymak

  CreateDetails

• geri çağırma

  Functions (isteğe bağlı)

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

  (result: BookmarkTreeNode)=>void

  • sonuç

    BookmarkTreeNode

İlerlemeler

• Promise<BookmarkTreeNode>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

get()

Söz

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

Belirtilen FavoriTreeNode'ları alır.

Parametreler

• idOrIdList

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

  Dize değerli tek bir kimlik veya dize değerli kimlikler dizisi

• geri çağırma

  Functions (isteğe bağlı)

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

  (results: BookmarkTreeNode[])=>void

  • sonuç

    BookmarkTreeNode[]

İlerlemeler

• Promise<BookmarkTreeNode[]>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

getChildren()

Söz

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

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

Parametreler

• id

  dize

• geri çağırma

  Functions (isteğe bağlı)

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

  (results: BookmarkTreeNode[])=>void

  • sonuç

    BookmarkTreeNode[]

İlerlemeler

• Promise<BookmarkTreeNode[]>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

getRecent()

Söz

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

  Functions (isteğe bağlı)

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

  (results: BookmarkTreeNode[])=>void

  • sonuç

    BookmarkTreeNode[]

İlerlemeler

• Promise<BookmarkTreeNode[]>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

getSubTree()

Söz

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

Belirtilen düğümden başlayarak Yer İş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

  Functions (isteğe bağlı)

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

  (results: BookmarkTreeNode[])=>void

  • sonuç

    BookmarkTreeNode[]

İlerlemeler

• Promise<BookmarkTreeNode[]>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

getTree()

Söz

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

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

Parametreler

• geri çağırma

  Functions (isteğe bağlı)

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

  (results: BookmarkTreeNode[])=>void

  • sonuç

    BookmarkTreeNode[]

İlerlemeler

• Promise<BookmarkTreeNode[]>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

move()

Söz

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

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

Parametreler

• id

  dize

• hedef

  nesne

  • indeks

    numara isteğe bağlı

  • parentId

    string isteğe bağlı

• geri çağırma

  Functions (isteğe bağlı)

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

  (result: BookmarkTreeNode)=>void

  • sonuç

    BookmarkTreeNode

İlerlemeler

• Promise<BookmarkTreeNode>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

remove()

Söz

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

  Functions (isteğe bağlı)

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

  ()=>void

İlerlemeler

• Promise<void>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

removeTree()

Söz

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

Bir yer işareti klasörünü yinelenen bir şekilde kaldırır.

Parametreler

• id

  dize

• geri çağırma

  Functions (isteğe bağlı)

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

  ()=>void

İlerlemeler

• Promise<void>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

search()

Söz

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

Belirtilen sorguyla eşleşen FavoriTreeNodes aramaları. Bir nesneyle belirtilen sorgular, belirtilen tüm özelliklerle eşleşen FavoriTreeNodes oluşturur.

Parametreler

• sorgu

  dize|nesne

  Yer işareti URL'leri ve başlıklarıyla eşleşen bir kelime ve alıntılanan kelime öbeği dizisi veya bir nesne. Bir nesneyse query, url ve title özellikleri belirtilebilir ve belirtilen tüm özelliklerle eşleşen yer işaretleri oluşturulur.

  • sorgu

    string isteğe bağlı

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

  • title

    string isteğe bağlı

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

  • url

    string isteğe bağlı

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

• geri çağırma

  Functions (isteğe bağlı)

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

  (results: BookmarkTreeNode[])=>void

  • sonuç

    BookmarkTreeNode[]

İlerlemeler

• Promise<BookmarkTreeNode[]>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

update()

Söz

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. Belirtilmeyen özellikler değiştirilmez. Not: Şu anda yalnızca "başlık" ve "url" desteklenmektedir.

Parametreler

• id

  dize

• değişiklikler

  nesne

  • title

    string isteğe bağlı

  • url

    string isteğe bağlı

• geri çağırma

  Functions (isteğe bağlı)

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

  (result: BookmarkTreeNode)=>void

  • sonuç

    BookmarkTreeNode

İlerlemeler

• Promise<BookmarkTreeNode>

  Chrome 90 ve sonraki sürümler

  Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, 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 bunu yalnızca başlık ve URL değişiklikleri tetikler.

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

      string isteğe bağlı

onChildrenReordered

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

Bir klasörün alt öğeleri, kullanıcı arayüzündeki sıralanmaları nedeniyle sıralarını değiştirdiğinde tetiklenir. Bu, taşıma() işleminin 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

  • id

    dize

  • yer işareti koymak

    BookmarkTreeNode

onImportBegan

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

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

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 yinelenen bir şekilde kaldırıldığında, klasör için tek bir bildirim tetiklenir ve klasörün içeriği 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
    • parentId

      dize