browser.bookmarks

תיאור

אפשר להשתמש ב-chrome.bookmarks API כדי ליצור סימניות, לארגן אותן ולבצע פעולות אחרות. אפשר גם לעיין במאמר בנושא Override Pages, שמתאר איך ליצור דף מותאם אישית של ניהול הסימניות.

בלחיצה על סימן הכוכב אפשר להוסיף סימנייה
בלחיצה על הכוכב אפשר להוסיף סימנייה.

הרשאות

bookmarks

כדי להשתמש ב-Bookmarks API, צריך להצהיר על ההרשאה 'bookmarks' במניפסט התוסף. לדוגמה:

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

מושגים ושימוש

אובייקטים ומאפיינים

הסימניות מאורגנות במבנה היררכי, שבו כל צומת הוא סימנייה או תיקייה (לפעמים נקראת קבוצה). כל צומת בעץ מיוצג על ידי אובייקט bookmarks.BookmarkTreeNode.

המאפיינים של BookmarkTreeNode נמצאים בשימוש בכל browser.bookmarks API. לדוגמה, כשמבצעים קריאה ל-bookmarks.create, מעבירים את ההורה של הצומת החדש (parentId), ואפשר גם את המאפיינים index, title ו-url של הצומת. במאמר bookmarks.BookmarkTreeNode מפורטות התכונות שיכולות להיות לצומת.

דוגמאות

הקוד הבא יוצר תיקייה עם הכותרת 'סימניות של תוספים'. הארגומנט הראשון של create() מציין את המאפיינים של התיקייה החדשה. הארגומנט השני מגדיר פונקציה שתופעל אחרי יצירת התיקייה.

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

בקטע הקוד הבא נוצרת סימנייה שמפנה לתיעוד למפתחים בנושא תוספים. מכיוון שלא יקרה שום דבר רע אם יצירת הסימנייה תיכשל, הקוד הזה לא טורח להגדיר פונקציית קריאה חוזרת.

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

כדי לנסות את API הסימניות, מתקינים את הדוגמה ל-Bookmarks API ממאגר chrome-extension-samples.

סוגים

BookmarkTreeNode

צומת (סימנייה או תיקייה) בעץ הסימניות. הצמתים הצאצאים מסודרים בתוך התיקייה הראשית שלהם.

מאפיינים

  • ילדים

    ‫BookmarkTreeNode[] optional

    רשימה מסודרת של צמתים משניים של הצומת הזה.

  • dateAdded

    מספר אופציונלי

    הזמן שבו הצומת הזה נוצר, באלפיות השנייה מאז תחילת התקופה של זמן מערכת (new Date(dateAdded)).

  • dateGroupModified

    מספר אופציונלי

    מתי התוכן של התיקייה הזו השתנה בפעם האחרונה, באלפיות השנייה מאז תקופת ה-epoch.

  • dateLastUsed

    מספר אופציונלי

    ‫Chrome 114 ואילך

    המועד האחרון שבו הצומת הזה נפתח, באלפיות השנייה מאז ראשית הזמן. לא מוגדר לתיקיות.

  • folderType

    ‫FolderType אופציונלי

    ‫Chrome 134 ואילך

    אם היא קיימת, זו תיקייה שנוספת על ידי הדפדפן והמשתמש או התוסף לא יכולים לשנות אותה. יכול להיות שצמתים משניים ישונו, אם לא מוגדר המאפיין unmodifiable בצומת הזה. ההגדרה מושמטת אם המשתמש והתוסף יכולים לשנות את הצומת (ברירת מחדל).

    יכולים להיות אפס, צומת אחד או כמה צמתים מכל סוג תיקייה. הדפדפן יכול להוסיף או להסיר תיקייה, אבל לא באמצעות ה-API של התוספים.

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של הצומת. המזהים ייחודיים בפרופיל הנוכחי, והם נשארים בתוקף גם אחרי הפעלה מחדש של הדפדפן.

  • אינדקס

    מספר אופציונלי

    המיקום של הצומת הזה בתיקיית האב שלו, על בסיס 0.

  • parentId

    מחרוזת אופציונלי

    ה-id של התיקייה הראשית. הערך מושמט בצומת הבסיסי (root).

  • התוכן מסתנכרן

    בוליאני

    ‫Chrome 134 ואילך

    האם הצומת הזה מסונכרן עם נפח האחסון בחשבון המרוחק של המשתמש על ידי הדפדפן. אפשר להשתמש בזה כדי להבחין בין גרסאות של אותו FolderType שמוצגות בחשבון לבין גרסאות שמוצגות רק באופן מקומי. הערך של המאפיין הזה עשוי להשתנות עבור צומת קיים, למשל כתוצאה מפעולת משתמש.

    הערה: הערך הזה משקף אם הצומת נשמר בספק החשבונות המובנה של הדפדפן. יכול להיות שצומת מסוים יסונכרן דרך צד שלישי, גם אם הערך הזה הוא false.

    בצמתים מנוהלים (צמתים שבהם unmodifiable מוגדר כ-true), המאפיין הזה תמיד יהיה false.

  • title

    מחרוזת

    הטקסט שמוצג עבור הצומת.

  • אי אפשר לשנות

    ‫"managed"
     אופציונלי

    מציין את הסיבה לכך שלא ניתן לשנות את הצומת הזה. הערך managed מציין שהצומת הזה הוגדר על ידי אדמין המערכת או על ידי האפוטרופוס של משתמש בפיקוח. ההגדרה מושמטת אם המשתמש והתוסף יכולים לשנות את הצומת (ברירת מחדל).

  • url

    מחרוזת אופציונלי

    כתובת ה-URL שאליה המשתמש מועבר כשהוא לוחץ על הסימנייה. לא רלוונטי לתיקיות.

BookmarkTreeNodeUnmodifiable

‫Chrome 44 ואילך

מציין את הסיבה לכך שלא ניתן לשנות את הצומת הזה. הערך managed מציין שהצומת הזה הוגדר על ידי האדמין של המערכת. ההגדרה מושמטת אם המשתמש והתוסף יכולים לשנות את הצומת (ברירת מחדל).

ערך

‫"managed"

CreateDetails

האובייקט שמועבר לפונקציה create().

מאפיינים

  • אינדקס

    מספר אופציונלי

  • parentId

    מחרוזת אופציונלי

    ברירת המחדל היא התיקייה 'סימניות אחרות'.

  • title

    מחרוזת אופציונלי

  • url

    מחרוזת אופציונלי

FolderType

‫Chrome 134 ואילך

מציין את סוג התיקייה.

ספירה

‫bookmarks-bar
התיקייה שהתוכן שלה מוצג בחלק העליון של חלון הדפדפן.

'אחר'
סימניות שמוצגות ברשימה המלאה של הסימניות בכל הפלטפורמות.

‫mobile
הסימניות זמינות בדרך כלל במכשירים הניידים של המשתמש, אבל אפשר לשנות אותן באמצעות תוסף או במנהל הסימניות.

'מנוהל'
תיקייה ברמה העליונה שעשויה להופיע אם אדמין המערכת או האפוטרופוס של משתמש בפיקוח הגדירו סימניות.

מאפיינים

MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

הוצא משימוש

פעולות כתיבה של סימניות כבר לא מוגבלות על ידי Chrome.

ערך

‫1000000

MAX_WRITE_OPERATIONS_PER_HOUR

הוצא משימוש

פעולות כתיבה של סימניות כבר לא מוגבלות על ידי Chrome.

ערך

‫1000000

ROOT_NODE_ID

‫Chrome 145 ואילך

ה-id שמשויך לצומת ברמת הבסיס.

ערך

‫"0"

Methods

create()

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

יוצר סימנייה או תיקייה מתחת ל-parentId שצוין. אם כתובת ה-URL היא NULL או חסרה, מדובר בתיקייה.

פרמטרים

החזרות

get()

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

מאחזר את הצמתים שצוינו בעץ הסימניות.

פרמטרים

  • idOrIdList

    מחרוזת | [מחרוזת, ...מחרוזת[]]

    מזהה יחיד מסוג מחרוזת, או מערך של מזהים מסוג מחרוזת

החזרות

getChildren()

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

מאחזר את הצאצאים של מזהה BookmarkTreeNode שצוין.

פרמטרים

  • id [מזהה]

    מחרוזת

החזרות

getRecent()

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

מאחזר את הסימניות שנוספו לאחרונה.

פרמטרים

  • numberOfItems

    number

    מספר הפריטים המקסימלי שיוחזרו.

החזרות

getSubTree()

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

הפונקציה מאחזרת חלק מההיררכיה של הסימניות, החל מהצומת שצוין.

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה של שורש עץ המשנה שרוצים לאחזר.

החזרות

getTree()

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

מאחזר את כל ההיררכיה של הסימניות.

החזרות

move()

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

מעביר את BookmarkTreeNode שצוין למיקום שסופק.

פרמטרים

  • id [מזהה]

    מחרוזת

  • destination

    אובייקט

    • אינדקס

      מספר אופציונלי

    • parentId

      מחרוזת אופציונלי

החזרות

remove()

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

מסיר סימנייה או תיקיית סימניות ריקה.

פרמטרים

  • id [מזהה]

    מחרוזת

החזרות

  • Promise<void>

    ‫Chrome 90 ואילך

removeTree()

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

מסיר תיקיית סימניות באופן רקורסיבי.

פרמטרים

  • id [מזהה]

    מחרוזת

החזרות

  • Promise<void>

    ‫Chrome 90 ואילך 
chrome.bookmarks.search(
  query: string | object,
): Promise<BookmarkTreeNode[]>

חיפוש של BookmarkTreeNodes שתואמים לשאילתה הנתונה. שאילתות שמצוינות באמצעות אובייקט יוצרות BookmarkTreeNodes שתואמים לכל המאפיינים שצוינו.

פרמטרים

  • שאילתה

    מחרוזת | אובייקט

    מחרוזת של מילים וביטויים במירכאות שמושוות לכתובות URL ולשמות של סימניות, או אובייקט. אם מדובר באובייקט, אפשר לציין את המאפיינים query, url ו-title, ויוצרו סימניות שתואמות לכל המאפיינים שצוינו.

    • שאילתה

      מחרוזת אופציונלי

      מחרוזת של מילים וביטויים במירכאות שמושוות לכתובות URL ולכותרות של סימניות.

    • title

      מחרוזת אופציונלי

      השם של הסימנייה. צריך להיות זהה בדיוק.

    • url

      מחרוזת אופציונלי

      כתובת ה-URL של הסימנייה. חייבת להיות התאמה מדויקת. שימו לב: לתיקיות אין כתובת URL.

החזרות

update()

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

עדכון המאפיינים של סימנייה או תיקייה. מציינים רק את המאפיינים שרוצים לשנות. מאפיינים שלא צוינו יישארו ללא שינוי. הערה: בשלב הזה, המערכת תומכת רק בערכים title ו-url.

פרמטרים

  • id [מזהה]

    מחרוזת

  • שינויים

    אובייקט

    • title

      מחרוזת אופציונלי

    • url

      מחרוזת אופציונלי

החזרות

אירועים

onChanged

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

מופעל כשסימנייה או תיקייה משתנות. הערה: בשלב הזה, רק שינויים בשם ובכתובת ה-URL מפעילים את התהליך הזה.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

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

    • id [מזהה]

      מחרוזת

    • changeInfo

      אובייקט

      • title

        מחרוזת

      • url

        מחרוזת אופציונלי

onChildrenReordered

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

מופעל כשהסדר של הצאצאים של תיקייה משתנה בגלל מיון הסדר בממשק המשתמש. הקריאה הזו לא מתבצעת כתוצאה של move().

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

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

    • id [מזהה]

      מחרוזת

    • reorderInfo

      אובייקט

      • childIds

        string[]

onCreated

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

מופעל כשנוצרת סימנייה או תיקייה.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

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

onImportBegan

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

מופעל כשמתחיל סשן ייבוא של סימניות. משקיפים יקרים צריכים להתעלם מעדכונים של onCreated עד שמופעל onImportEnded. המשקיפים צריכים להמשיך לטפל בהתראות אחרות באופן מיידי.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    () => void

onImportEnded

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

מופעל כשסשן ייבוא של סימניות מסתיים.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    () => void

onMoved

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

מופעל כשסימנייה או תיקייה מועברות לתיקיית הורה אחרת.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

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

    • id [מזהה]

      מחרוזת

    • moveInfo

      אובייקט

      • אינדקס

        number

      • oldIndex

        number

      • oldParentId

        מחרוזת

      • parentId

        מחרוזת

onRemoved

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

האירוע מופעל כשמסירים סימנייה או תיקייה. כשמסירים תיקייה באופן רקורסיבי, נשלחת התראה אחת לגבי התיקייה, ולא לגבי התוכן שלה.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

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

    • id [מזהה]

      מחרוזת

    • removeInfo

      אובייקט

      • אינדקס

        number

      • צומת

        BookmarkTreeNode

        ‫Chrome 48 ואילך
      • parentId

        מחרוזת