chrome.tabGroups

توضیحات

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

مجوزها

tabGroups

در دسترس بودن

Chrome 89+ MV3+

انواع

Color

رنگ گروه

Enum

"خاکستری"

"آبی"

"قرمز"

"زرد"

"سبز"

"صورتی"

"بنفش"

"فیروزه ای"

"نارنجی"

TabGroup

خواص

  • فرو ریخت

    بولی

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

  • رنگ

    رنگ

    رنگ گروه

  • شناسه

    شماره

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

  • عنوان

    رشته اختیاری

    عنوان گروه.

  • شناسه پنجره

    شماره

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

خواص

TAB_GROUP_ID_NONE

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

ارزش

-1

روش ها

get()

قول بده
chrome.tabGroups.get(
  groupId: number,
  callback?: function,
)

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

پارامترها

  • شناسه گروه

    شماره

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (group: TabGroup) => void

برمی گرداند

  • Promise< TabGroup >

    Chrome 90+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

move()

قول بده
chrome.tabGroups.move(
  groupId: number,
  moveProperties: object,
  callback?: function,
)

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

پارامترها

  • شناسه گروه

    شماره

    شناسه گروه برای جابجایی

  • moveProperties

    شی

    • شاخص

      شماره

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

    • شناسه پنجره

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

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (group?: TabGroup) => void

    • گروه

      TabGroup اختیاری است

      جزئیات درباره گروه منتقل شده

برمی گرداند

  • Promise< TabGroup | تعریف نشده>

    Chrome 90+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

query()

قول بده
chrome.tabGroups.query(
  queryInfo: object,
  callback?: function,
)

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

پارامترها

  • queryInfo

    شی

    • فرو ریخت

      بولی اختیاری

      این که آیا گروه ها فرو می ریزند.

    • رنگ

      رنگ اختیاری

      رنگ گروه ها

    • عنوان

      رشته اختیاری

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

    • شناسه پنجره

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

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: TabGroup[]) => void

برمی گرداند

  • Promise< TabGroup []>

    Chrome 90+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

update()

قول بده
chrome.tabGroups.update(
  groupId: number,
  updateProperties: object,
  callback?: function,
)

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

پارامترها

  • شناسه گروه

    شماره

    شناسه گروه برای تغییر.

  • updateProperties

    شی

    • فرو ریخت

      بولی اختیاری

      این که آیا گروه باید فروپاشی شود یا خیر.

    • رنگ

      رنگ اختیاری

      رنگ گروه.

    • عنوان

      رشته اختیاری

      عنوان گروه.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (group?: TabGroup) => void

    • گروه

      TabGroup اختیاری است

      جزئیات درباره گروه به روز شده

برمی گرداند

  • Promise< TabGroup | تعریف نشده>

    Chrome 90+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

رویدادها

onCreated

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

هنگامی که یک گروه ایجاد می شود، فعال می شود.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (group: TabGroup) => void

onMoved

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

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

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (group: TabGroup) => void

onRemoved

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

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

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (group: TabGroup) => void

onUpdated

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

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

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (group: TabGroup) => void