chrome.bookmarks

Açıklama

Yer işaretlerini oluşturmak, düzenlemek ve başka şekillerde değiştirmek için chrome.bookmarks API'yi kullanın. Özel bir Yer İşareti Yöneticisi sayfası oluşturmak için kullanabileceğiniz Override Pages'e de bakın.

Yıldızı tıkladığınızda yer işareti eklenir.
Yıldızı tıkladığınızda yer işareti eklenir.

İzinler

bookmarks

Yer işaretleri API'sini kullanmak için uzantı manifestinde "bookmarks" iznini beyan etmeniz gerekir. Örneğin:

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

Kavramlar ve kullanım

Nesneler ve özellikler

Yer işaretleri, ağaç yapısında düzenlenir. Ağaçtaki her düğüm bir yer işareti veya klasördür (bazen grup olarak da adlandırılır). Ağaçtaki her düğüm bir bookmarks.BookmarkTreeNode nesnesiyle temsil edilir.

BookmarkTreeNode özellikleri, chrome.bookmarks API'sinde kullanılır. Örneğin, bookmarks.create işlevini çağırdığınızda yeni düğümün üst öğesini (parentId) ve isteğe bağlı olarak düğümün index, title ve url özelliklerini iletirsiniz. Bir düğümün sahip olabileceği özellikler hakkında bilgi edinmek için bookmarks.BookmarkTreeNode konusuna bakın.

Örnekler

Aşağıdaki kod, "Uzantı yer işaretleri" başlıklı bir klasör oluşturur. create() işlevinin 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);
  },
);

Aşağıdaki snippet, uzantılarla ilgili geliştirici belgelerine yönlendiren bir yer işareti oluşturur. Yer işareti oluşturma işlemi başarısız olursa herhangi bir sorun yaşanmayacağından bu kod, 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örlerinde sıralanır.

Özellikler

  • çocuklar

    BookmarkTreeNode[] isteğe bağlı

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

  • dateAdded

    number isteğe bağlı

    Bu düğümün oluşturulduğu zaman (epoch'tan beri geçen milisaniye cinsinden) (new Date(dateAdded)).

  • dateGroupModified

    number isteğe bağlı

    Bu klasörün içeriğinin en son ne zaman değiştiği (dönem başlangıcından bu yana geçen milisaniye cinsinden).

  • dateLastUsed

    number isteğe bağlı

    Chrome 114 veya daha yeni bir sürüm

    Bu düğümün en son açıldığı zaman (sıfır zamanından bu yana geçen milisaniye cinsinden süre). Klasörler için ayarlanamaz.

  • folderType

    FolderType isteğe bağlı

    Chrome 134 veya daha yeni bir sürüm

    Bu klasör, tarayıcı tarafından eklenir ve kullanıcı veya uzantı tarafından değiştirilemez. Bu düğümde unmodifiable özelliği ayarlanmamışsa alt düğümler değiştirilebilir. Düğüm kullanıcı ve uzantı tarafından değiştirilebiliyorsa atlanır (varsayılan).

    Her klasör türünde sıfır, bir veya birden fazla düğüm olabilir. Klasörler tarayıcı tarafından eklenebilir veya kaldırılabilir ancak uzantılar API'si üzerinden eklenemez ya da kaldırılamaz.

  • id

    dize

    Düğümün benzersiz tanımlayıcısı. Kimlikler, mevcut profilde benzersizdir ve tarayıcı yeniden başlatıldıktan sonra bile geçerliliğini korur.

  • indeks

    number isteğe bağlı

    Bu düğümün üst klasöründeki 0 tabanlı konumu.

  • parentId

    dize isteğe bağlı

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

  • senkronize ediliyor

    boolean

    Chrome 134 veya daha yeni bir sürüm

    Bu düğümün, tarayıcı tarafından kullanıcının uzaktan hesap depolama alanıyla senkronize edilip edilmediği. Bu, aynı FolderType öğesinin hesap ve yalnızca yerel sürümleri arasında ayrım yapmak için kullanılabilir. Bu özelliğin değeri, mevcut bir düğüm için değişebilir (ör. kullanıcı işlemi sonucunda).

    Not: Bu, düğümün tarayıcının yerleşik hesap sağlayıcısına kaydedilip kaydedilmediğini gösterir. Bu değer false olsa bile bir düğümün üçüncü taraf üzerinden senkronize edilmesi mümkündür.

    Yönetilen düğümlerde (unmodifiable değerinin true olarak ayarlandığı düğümler) bu özellik her zaman false olur.

  • 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ştirilemediğini gösterir. managed değeri, bu düğümün sistem yöneticisi veya gözetimli kullanıcının velisi 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

    dize isteğe bağlı

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

BookmarkTreeNodeUnmodifiable

Chrome 44 veya daha yeni bir sürüm

Bu düğümün neden değiştirilemediğini gösterir. 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

"managed"

CreateDetails

create() işlevine iletilen nesne.

Özellikler

  • indeks

    number isteğe bağlı

  • parentId

    dize isteğe bağlı

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

  • title

    dize isteğe bağlı

  • url

    dize isteğe bağlı

FolderType

Chrome 134 veya daha yeni bir sürüm

Klasörün türünü belirtir.

Enum

"bookmarks-bar"
İçeriği tarayıcı penceresinin en üstünde görüntülenen klasör.

"diğer"
Tüm platformlardaki yer işaretlerinin tam listesinde gösterilen yer işaretleri.

"mobile"
Yer işaretleri genellikle kullanıcının mobil cihazlarında kullanılabilir ancak uzantı veya yer işaretleri yöneticisi tarafından değiştirilebilir.

"managed"
Sistem yöneticisi veya gözetimli kullanıcıların velisi yer işaretlerini yapılandırdıysa bulunabilecek üst düzey bir klasör.

Ö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ırlanmıyor.

Değer

1000000

MAX_WRITE_OPERATIONS_PER_HOUR

Kullanımdan kaldırıldı

Yer işareti yazma işlemleri artık Chrome tarafından sınırlanmıyor.

Değer

1000000

Yöntemler

create()

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

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

Parametreler

İadeler

get()

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

Belirtilen BookmarkTreeNode'ları alır.

Parametreler

  • idOrIdList

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

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

İadeler

getChildren()

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

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

Parametreler

  • id

    dize

İadeler

getRecent()

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

Yakın zamanda eklenen yer işaretlerini alır.

Parametreler

  • numberOfItems

    sayı

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

İadeler

getSubTree()

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

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.

İadeler

getTree()

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

Tüm yer işareti hiyerarşisini alır.

İadeler

move()

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

Belirtilen BookmarkTreeNode'u sağlanan konuma taşır.

Parametreler

  • id

    dize

  • hedef

    nesne

    • indeks

      number isteğe bağlı

    • parentId

      dize isteğe bağlı

İadeler

remove()

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

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

Parametreler

  • id

    dize

İadeler

  • Promise<void>

    Chrome 90 veya daha yeni bir sürüm

removeTree()

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

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

Parametreler

  • id

    dize

İadeler

  • Promise<void>

    Chrome 90 veya daha yeni bir sürüm 
chrome.bookmarks.search(
  query: string | object,
): Promise<BookmarkTreeNode[]>

Belirtilen sorguyla eşleşen BookmarkTreeNode'ları arar. Bir nesneyle belirtilen sorgular, belirtilen tüm özelliklerle eşleşen BookmarkTreeNodes oluşturur.

Parametreler

  • sorgu

    dize | nesne

    Yer işareti URL'leri ve başlıklarıyla eşleşen kelime dizisi ve alıntılanan ifadeler ya da bir nesne. Nesne ise 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ıklarıyla eşleştirilen kelime dizisi ve alıntılanmış ifadeler.

    • title

      dize isteğe bağlı

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

    • url

      dize isteğe bağlı

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

İadeler

update()

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

Bir yer işaretinin veya klasörün özelliklerini günceller. Yalnızca değiştirmek istediğiniz özellikleri belirtin. Belirtilmeyen özellikler değiştirilmeden kalır. Not: Şu anda yalnızca "title" (başlık) ve "url" (URL) desteklenmektedir.

Parametreler

  • id

    dize

  • değişiklikler

    nesne

    • title

      dize isteğe bağlı

    • url

      dize isteğe bağlı

İadeler

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 durumu tetiklemektedir.

Parametreler

  • callback

    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 öğelerinin sırası, kullanıcı arayüzünde sıralama yapılması nedeniyle değiştiğinde tetiklenir. Bu, move() işlevi sonucunda çağrılmaz.

Parametreler

  • callback

    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

onImportBegan

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

Yer işareti içe aktarma oturumu başlatıldığında tetiklenir. Maliyetli gözlemciler, onImportEnded tetiklenene kadar onCreated güncellemelerini yoksaymalıdır. Gözlemciler diğer bildirimleri yine de hemen ele almalıdır.

Parametreler

  • callback

    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

  • callback

    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

  • callback

    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 yinelemeli olarak kaldırıldığında klasör için tek bir bildirim gönderilir ve içeriği için bildirim gönderilmez.

Parametreler

  • callback

    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 veya daha yeni bir sürüm
      • parentId

        dize