chrome.tabGroups

תיאור

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

הרשאות

tabGroups

זמינות

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

סוגים

Color

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

Enum

"אפור"

"כחול"

"אדום"

"צהוב"

"ירוק"

"ורוד"

"סגול"

"ציאן"

"כתום"

TabGroup

מאפיינים

  • מכווץ

    בוליאני

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

  • color [צבע]

    צבע

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

  • id [מזהה]

    number

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

  • title

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

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

  • windowId

    number

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

מאפיינים

TAB_GROUP_ID_NONE

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

ערך

-1

שיטות

get()

הבטחה 
chrome.tabGroups.get(
  groupId: number,
  callback?: function,
)

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

פרמטרים

  • groupId

    number

  • קריאה חוזרת (callback)

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

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

    (group: TabGroup) => void

החזרות

  • התחייבות<TabGroup>

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

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

move()

הבטחה 
chrome.tabGroups.move(
  groupId: number,
  moveProperties: object,
  callback?: function,
)

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

פרמטרים

  • groupId

    number

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

  • moveProperties

    אובייקט

    • index

      number

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

    • windowId

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

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

  • קריאה חוזרת (callback)

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

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

    (group?: TabGroup) => void

    • קבוצה

      TabGroup אופציונלי

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

החזרות

  • Promise<TabGroup | לא מוגדר>

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

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

query()

הבטחה 
chrome.tabGroups.query(
  queryInfo: object,
  callback?: function,
)

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

פרמטרים

  • queryInfo

    אובייקט

    • מכווץ

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

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

    • color [צבע]

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

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

    • title

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

      התאמת שמות של קבוצות לפי דוגמת עיצוב.

    • windowId

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

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

  • קריאה חוזרת (callback)

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

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

    (result: TabGroup[]) => void

החזרות

  • התחייבות<TabGroup[]>

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

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

update()

הבטחה 
chrome.tabGroups.update(
  groupId: number,
  updateProperties: object,
  callback?: function,
)

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

פרמטרים

  • groupId

    number

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

  • updateProperties

    אובייקט

    • מכווץ

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

      ההגדרה קובעת אם צריך לכווץ את הקבוצה.

    • color [צבע]

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

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

    • title

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

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

  • קריאה חוזרת (callback)

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

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

    (group?: TabGroup) => void

    • קבוצה

      TabGroup אופציונלי

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

החזרות

  • Promise<TabGroup | לא מוגדר>

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

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (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