browser.tabGroups

תיאור

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

הרשאות

tabGroups

זמינות

‫Chrome 89 ואילך ‫browser.* ‎ מגרסה 148 של Chrome ‫MV3 ואילך

סוגים

Color

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

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

"grey"

"blue"

"red"

"צהוב"

"ירוק"

"ורוד"

"purple"

"cyan"

"orange"

TabGroup

מאפיינים

• במצב מכווץ

  בוליאני

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

• צבע

  צבע

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

• id [מזהה]

  number

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

• משותפת

  בוליאני

  ‫Chrome 137 ואילך browser.* ‎ מגרסת Chrome 148

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

• title

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

  שם הקבוצה.

• windowId

  number

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

מאפיינים

TAB_GROUP_ID_NONE

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

ערך

-1

Methods

get()

browser.tabGroups.get(
  groupId: number,
): Promise<TabGroup>

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

פרמטרים

• groupId

  number

החזרות

• Promise<TabGroup>

  ‫Chrome 90 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

move()

browser.tabGroups.move(
  groupId: number,
  moveProperties: object,
): Promise<TabGroup | undefined>

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

פרמטרים

• groupId

  number

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

• moveProperties

  אובייקט

  • אינדקס

    number

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

  • windowId

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

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

החזרות

• Promise<TabGroup | undefined>

  ‫Chrome 90 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

query()

browser.tabGroups.query(
  queryInfo: object,
): Promise<TabGroup[]>

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

פרמטרים

• queryInfo

  אובייקט

  • במצב מכווץ

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

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

  • צבע

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

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

  • משותפת

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

    ‫Chrome 137 ואילך browser.* ‎ מגרסת Chrome 148

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

  • title

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

    התאמת שמות של קבוצות לתבנית.

  • windowId

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

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

החזרות

• Promise<TabGroup[]>

  ‫Chrome 90 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

update()

browser.tabGroups.update(
  groupId: number,
  updateProperties: object,
): Promise<TabGroup | undefined>

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

פרמטרים

• groupId

  number

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

• updateProperties

  אובייקט

  • במצב מכווץ

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

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

  • צבע

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

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

  • title

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

    שם הקבוצה.

החזרות

• Promise<TabGroup | undefined>

  ‫Chrome 90 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

אירועים

onCreated

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

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

פרמטרים

• callback

  פונקציה

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

  (group: TabGroup) => void

  • קבוצה

    TabGroup

onMoved

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

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

פרמטרים

• callback

  פונקציה

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

  (group: TabGroup) => void

  • קבוצה

    TabGroup

onRemoved

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

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

פרמטרים

• callback

  פונקציה

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

  (group: TabGroup) => void

  • קבוצה

    TabGroup

onUpdated

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

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

פרמטרים

• callback

  פונקציה

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

  (group: TabGroup) => void

  • קבוצה

    TabGroup