browser.tabGroups

شرح

از میانای برنامه‌سازی کاربردی chrome.tabGroups برای تعامل با سیستم گروه‌بندی برگه مرورگر استفاده کنید. می‌توانید از این API برای اصلاح و بازآرایی گروه‌های برگه در مرورگر استفاده کنید. برای گروه‌بندی کردن و ازگروه خارج کردن زبانه‌ها، یا برای جستجوی اینکه چه زبانه‌هایی در گروه‌ها هستند، از chrome.tabs API استفاده کنید.

اجازه‌ها

tabGroups

دردسترس بودن

Chrome 89+ browser.* از Chrome 148 MV3+

انواع

Color

رنگ گروه.

شمارشی

"grey"

«آبی»

"red"

«yellow»

«سبز»

"pink"

"purple"

«cyan»

"orange"

TabGroup

مشخصات

  • جمع‌شده

    بولی

    اینکه گروه جمع شده است یا نه. گروه جمع‌شده گروهی است که زبانه‌های آن پنهان است.

  • رنگ

    رنگ

    رنگ گروه.

  • id

    شماره

    شناسه گروه. شناسه‌های گروه در یک جلسه مرورگر منحصربه‌فرد هستند.

  • هم‌رسانی‌شده

    بولی

    Chrome نسخه ۱۳۷ و بالاتر browser.* ‎ از Chrome نسخه ۱۴۸

    اینکه گروه هم‌رسانی شده است یا نه.

  • عنوان

    رشته اختیاری

    عنوان گروه.

  • windowId

    شماره

    شناسه پنجره‌ای که حاوی گروه است.

مشخصات

TAB_GROUP_ID_NONE

شناسه‌ای که نشان‌دهنده عدم وجود گروه است.

مقدار

‫-۱

روش‌ها

get()

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

جزئیات مربوط به گروه مشخص‌شده را بازیابی می‌کند.

پارامترها

  • groupId

    شماره

بازگشتی‌ها

  • Promise<TabGroup>

    Chrome نسخه ۹۰ به بالا browser.* از Chrome نسخه ۱۴۸

move()

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

گروه و همه زبانه‌های آن را در پنجره خودش یا به پنجره‌ای جدید منتقل می‌کند.

پارامترها

  • groupId

    شماره

    شناسه گروهی که باید منتقل شود.

  • moveProperties

    شیء

    • شاخص

      شماره

      جایگاهی که گروه به آن منتقل می‌شود. از -1 برای قرار دادن گروه در انتهای پنجره استفاده کنید.

    • windowId

      شماره اختیاری

      پنجره‌ای که گروه به آن منتقل می‌شود. به‌طور پیش‌فرض به پنجره‌ای که گروه درحال‌حاضر در آن قرار دارد می‌رود. توجه داشته باشید که گروه‌ها را فقط می‌توان به پنجره‌هایی با نوع windows.WindowType "normal" منتقل کرد یا از آن‌ها خارج کرد.

بازگشتی‌ها

  • Promise<TabGroup | undefined>

    Chrome نسخه ۹۰ به بالا browser.* از Chrome نسخه ۱۴۸

query()

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

همه گروه‌هایی را که ویژگی‌های مشخص‌شده دارند، یا همه گروه‌ها را درصورتی‌که ویژگی‌ای مشخص نشده باشد، دریافت می‌کند.

پارامترها

  • queryInfo

    شیء

    • جمع‌شده

      بولی اختیاری

      اینکه گروه‌ها جمع شده‌اند یا نه.

    • رنگ

      رنگ اختیاری

      رنگ گروه‌ها.

    • هم‌رسانی‌شده

      بولی اختیاری

      Chrome نسخه ۱۳۷ و بالاتر browser.* ‎ از Chrome نسخه ۱۴۸

      اینکه گروه هم‌رسانی شده است یا نه.

    • عنوان

      رشته اختیاری

      مطابقت دادن عنوان‌های گروه با الگو.

    • windowId

      شماره اختیاری

      شناسه پنجره اصلی، یا windows.WINDOW_ID_CURRENT برای پنجره فعلی.

بازگشتی‌ها

  • Promise<TabGroup[]>

    Chrome نسخه ۹۰ به بالا browser.* از Chrome نسخه ۱۴۸

update()

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

ویژگی‌های گروه را اصلاح می‌کند. مشخصاتی که در updateProperties مشخص نشده‌اند اصلاح نمی‌شوند.

پارامترها

  • groupId

    شماره

    شناسه گروهی که باید اصلاح شود.

  • updateProperties

    شیء

    • جمع‌شده

      بولی اختیاری

      آیا گروه باید جمع شود یا نه.

    • رنگ

      رنگ اختیاری

      رنگ گروه.

    • عنوان

      رشته اختیاری

      عنوان گروه.

بازگشتی‌ها

  • Promise<TabGroup | undefined>

    Chrome نسخه ۹۰ به بالا browser.* از Chrome نسخه ۱۴۸

رویدادها

onCreated

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

وقتی گروهی ایجاد می‌شود، فعال می‌شود.

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

    (group: TabGroup) => void

onMoved

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

وقتی گروهی در پنجره جابه‌جا می‌شود فعال می‌شود. رویدادهای انتقال همچنان برای برگه‌های جداگانه در گروه و همچنین برای خود گروه فعال می‌شوند. وقتی گروهی بین پنجره‌ها جابه‌جا می‌شود، این رویداد فعال نمی‌شود؛ درعوض، از یک پنجره برداشته می‌شود و در پنجره دیگر ایجاد می‌شود.

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

    (group: TabGroup) => void

onRemoved

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

وقتی گروهی بسته می‌شود، چه مستقیماً توسط کاربر یا به‌طور خودکار به‌دلیل نداشتن برگه، فعال می‌شود.

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

    (group: TabGroup) => void

onUpdated

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

وقتی گروهی به‌روزرسانی می‌شود، فعال می‌شود.

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

    (group: TabGroup) => void