chrome.tabGroups

תיאור

שימוש ב-API ‏chrome.tabGroups כדי לקיים אינטראקציה עם מערכת קיבוץ הכרטיסיות של הדפדפן. אפשר להשתמש ב-API הזה כדי לשנות ולסדר מחדש קבוצות של כרטיסיות בדפדפן. כדי לקבץ כרטיסיות ולבטל את הקיבוץ שלהן, או כדי לשלוח שאילתה לגבי הכרטיסיות שנמצאות בקבוצות, משתמשים ב-API של chrome.tabs.

הרשאות

tabGroups

זמינות

Chrome מגרסה 89 ואילך MV3 ואילך

סוגים

Color

הצבע של הקבוצה.

טיפוסים בני מנייה (enum)

"grey"

"blue"

"red"

"yellow"

"green"

"pink"

"purple"

"cyan"

"orange"

TabGroup

מאפיינים

  • מכווץ

    בוליאני

    אם הקבוצה מכווצת. קבוצה מכוונת היא קבוצה שהכרטיסיות שלה מוסתרות.

  • color [צבע]

    צבע

    הצבע של הקבוצה.

  • id [מזהה]

    number

    המזהה של הקבוצה. מזהי הקבוצות הם ייחודיים בכל סשן בדפדפן.

  • משותף

    בוליאני

    בהמתנה

    אם הקבוצה משותפת.

  • title

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

    השם של הקבוצה.

  • windowId

    number

    המזהה של החלון שמכיל את הקבוצה.

מאפיינים

TAB_GROUP_ID_NONE

מזהה שמייצג את היעדר הקבוצה.

ערך

-1

Methods

get()

Promise 
chrome.tabGroups.get(
  groupId: number,
  callback?: function,
)

אחזור פרטים על הקבוצה שצוינה.

פרמטרים

  • groupId

    number

  • callback

    פונקציה אופציונלי

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

    (group: TabGroup) => void

החזרות

  • Promise<TabGroup>

    גרסה 90 ואילך של Chrome

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ה-promise ייפתר עם אותו סוג שמוענק ל-callback.

move()

Promise 
chrome.tabGroups.move(
  groupId: number,
  moveProperties: object,
  callback?: function,
)

העברת הקבוצה וכל הכרטיסיות שלה בתוך החלון שלה, או לחלון חדש.

פרמטרים

  • groupId

    number

    המזהה של הקבוצה שרוצים להעביר.

  • moveProperties

    אובייקט

    • אינדקס

      number

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

    • windowId

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

      החלון שאליו רוצים להעביר את הקבוצה. ברירת המחדל היא החלון שבו הקבוצה נמצאת כרגע. הערה: אפשר להעביר קבוצות רק אל חלונות ומחלונות עם windows.WindowType מסוג "normal".

  • callback

    פונקציה אופציונלי

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

    (group?: TabGroup) => void

    • קבוצה

      TabGroup אופציונלי

      פרטים על הקבוצה שהועברה.

החזרות

  • Promise<TabGroup | undefined>

    גרסה 90 ואילך של Chrome

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ה-promise ייפתר עם אותו סוג שמוענק ל-callback.

query()

Promise 
chrome.tabGroups.query(
  queryInfo: object,
  callback?: function,
)

הפונקציה מקבלת את כל הקבוצות שיש להן את המאפיינים שצוינו, או את כל הקבוצות אם לא צוינו מאפיינים.

פרמטרים

  • queryInfo

    אובייקט

    • מכווץ

      boolean אופציונלי

      אם הקבוצות מכווצות.

    • color [צבע]

      צבע אופציונלי

      הצבע של הקבוצות.

    • משותף

      boolean אופציונלי

      בהמתנה

      אם הקבוצה משותפת.

    • title

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

      התאמת שמות הקבוצות לדפוס.

    • windowId

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

      המזהה של חלון ההורה, או windows.WINDOW_ID_CURRENT לחלון הנוכחי.

  • callback

    פונקציה אופציונלי

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

    (result: TabGroup[]) => void

החזרות

  • Promise<TabGroup[]>

    גרסה 90 ואילך של Chrome

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ה-promise ייפתר עם אותו סוג שמוענק ל-callback.

update()

Promise 
chrome.tabGroups.update(
  groupId: number,
  updateProperties: object,
  callback?: function,
)

שינוי המאפיינים של קבוצה. מאפיינים שלא צוינו ב-updateProperties לא ישתנו.

פרמטרים

  • groupId

    number

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

  • updateProperties

    אובייקט

    • מכווץ

      boolean אופציונלי

      האם הקבוצה צריכה להיות מכווצת.

    • color [צבע]

      צבע אופציונלי

      הצבע של הקבוצה.

    • title

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

      השם של הקבוצה.

  • callback

    פונקציה אופציונלי

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

    (group?: TabGroup) => void

    • קבוצה

      TabGroup אופציונלי

      פרטים על הקבוצה המעודכנת.

החזרות

  • Promise<TabGroup | undefined>

    גרסה 90 ואילך של Chrome

    יש תמיכה ב-Promises ב-Manifest V3 ואילך, אבל פונקציות קריאה חוזרת (callbacks) ניתנות לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

אירועים

onCreated

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

האירוע מופעל כשיוצרים קבוצה.

פרמטרים

  • callback

    פונקציה

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

    (group: TabGroup) => void

onMoved

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

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

פרמטרים

  • callback

    פונקציה

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

    (group: TabGroup) => void

onRemoved

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

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

פרמטרים

  • callback

    פונקציה

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

    (group: TabGroup) => void

onUpdated

chrome.tabGroups.onUpdated.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (group: TabGroup) => void