chrome.tabs

הערה: ה-Service Worker ודפי תוספים יכולים להשתמש ב-Tabs API, אבל לא בסקריפטים של תוכן.

תיאור

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

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

הרשאות

רוב התכונות לא דורשות הרשאות כדי להשתמש בהן. לדוגמה: יצירת כרטיסייה חדשה, טעינה מחדש של כרטיסייה, ניווט לכתובת URL אחרת וכו'.

יש שלוש הרשאות שמפתחים צריכים להיות מודעים אליהן כשהם עובדים עם Tabs API.

הרשאת 'כרטיסיות'

ההרשאה הזו לא נותנת גישה למרחב השמות של chrome.tabs. במקום זאת, התוסף יכול להפעיל את tabs.query() כנגד ארבעה מאפיינים רגישים במכונות של tabs.Tab: url, pendingUrl, title ו-favIconUrl.

{
  "name": "My extension",
  ...
  "permissions": [
    "tabs"
  ],
  ...
}

הרשאות המארח

הרשאות מארח מאפשרות לתוסף לקרוא את ארבעת מאפייני tabs.Tab הרגישים של כרטיסייה תואמת ולשלוח שאילתות לגביהם. הם יכולים גם לבצע פעולות ישירות בכרטיסיות התואמות באמצעות שיטות כמו tabs.captureVisibleTab(), tabs.executeScript(), tabs.insertCSS() וtabs.removeCSS().

{
  "name": "My extension",
  ...
  "host_permissions": [
    "http://*/*",
    "https://*/*"
  ],
  ...
}

ההרשאה ActiveTab

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

{
  "name": "My extension",
  ...
  "permissions": [
    "activeTab"
  ],
  ...
}

תרחישים לדוגמה

בקטעים הבאים מתוארים כמה תרחישים נפוצים.

פתיחה של דף תוסף בכרטיסייה חדשה

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

background.js:

chrome.runtime.onInstalled.addListener(({reason}) => {
  if (reason === 'install') {
    chrome.tabs.create({
      url: "onboarding.html"
    });
  }
});

הערה: בדוגמה הזו לא נדרשות הרשאות.

אחזור הכרטיסייה הנוכחית

הדוגמה הזו ממחישה איך קובץ שירות (service worker) של תוסף יכול לאחזר את הכרטיסייה הפעילה מהחלון שנמצא כרגע במיקוד (או מהחלון האחרון שנמצא במיקוד, אם לא מתמקדים בחלון Chrome). בדרך כלל אפשר להתייחס לכך בתור הכרטיסייה הנוכחית של המשתמש.

  async function getCurrentTab() {
    let queryOptions = { active: true, lastFocusedWindow: true };
    // `tab` will either be a `tabs.Tab` instance or `undefined`.
    let [tab] = await chrome.tabs.query(queryOptions);
    return tab;
  }

  function getCurrentTab(callback) {
    let queryOptions = { active: true, lastFocusedWindow: true };
    chrome.tabs.query(queryOptions, ([tab]) => {
      if (chrome.runtime.lastError)
      console.error(chrome.runtime.lastError);
      // `tab` will either be a `tabs.Tab` instance or `undefined`.
      callback(tab);
    });
  }

השתקת הכרטיסייה שצוינה

הדוגמה הזו מראה איך תוסף יכול להחליף את המצב של מצב מושתק בכרטיסייה נתונה.

  async function toggleMuteState(tabId) {
    const tab = await chrome.tabs.get(tabId);
    const muted = !tab.mutedInfo.muted;
    await chrome.tabs.update(tabId, {muted});
    console.log(`Tab ${tab.id} is ${muted ? "muted" : "unmuted"}`);
  }

  function toggleMuteState(tabId) {
    chrome.tabs.get(tabId, async (tab) => {
      let muted = !tab.mutedInfo.muted;
      await chrome.tabs.update(tabId, { muted });
      console.log(`Tab ${tab.id} is ${ muted ? "muted" : "unmuted" }`);
    });
  }

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

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

  chrome.tabs.onActivated.addListener(moveToFirstPosition);

  async function moveToFirstPosition(activeInfo) {
    try {
      await chrome.tabs.move(activeInfo.tabId, {index: 0});
      console.log("Success.");
    } catch (error) {
      if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
        setTimeout(() => moveToFirstPosition(activeInfo), 50);
      } else {
        console.error(error);
      }
    }
  }

חשוב: שימוש ב-catch(error) ב-Promise מבטיח ששגיאה שמאכלסת את 'chrome.runtime.lastError' אחרת לא תבוטל.

  chrome.tabs.onActivated.addListener(moveToFirstPositionMV2);

  function moveToFirstPositionMV2(activeInfo) {
    chrome.tabs.move(activeInfo.tabId, { index: 0 }, () => {
      if (chrome.runtime.lastError) {
        const error = chrome.runtime.lastError;
        if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
          setTimeout(() => moveToFirstPositionMV2(activeInfo), 50);
        } else {
          console.error(error);
        }
      } else {
        console.log("Success.");
      }
    });
  }

העברת הודעה לסקריפט התוכן של כרטיסייה נבחרת

הדוגמה הזו ממחישה איך קובץ שירות (service worker) של תוסף יכול לתקשר עם סקריפטים של תוכן בכרטיסיות ספציפיות בדפדפן באמצעות tabs.sendMessage().

function sendMessageToActiveTab(message) {
  const [tab] = await chrome.tabs.query({ active: true, lastFocusedWindow: true });
  const response = await chrome.tabs.sendMessage(tab.id, message);
  // TODO: Do something with the response.
}

דוגמאות לתוספים

להדגמות נוספות של תוספי API של Tabs API אפשר להיעזר בנושאים הבאים:

• Manifest V2 – תוספי API של כרטיסיות.
• מניפסט V3 – מנהל הכרטיסיות.

סוגים

MutedInfo

Chrome 46 ואילך

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

תכונות

• extensionId

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

  המזהה של התוסף ששינה את מצב ההשתקה. לא מוגדר אם תוסף לא היה הסיבה לשינוי האחרון של מצב ההשתקה.

• מושתק

  boolean

  האם הכרטיסייה מושתקת (מונע השמעת צליל). יכול להיות שהכרטיסייה תושתק גם אם היא לא הושמעה או שלא מושמע בה צליל כרגע. זהה לזו של אינדיקטור האודיו 'מושתק'.

• סיבה

  MutedInfoReason אופציונלי

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

MutedInfoReason

Chrome 46 ואילך

אירוע שגרם לשינוי מצב מושתק.

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

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

"צילום"
צילום הכרטיסייה הופעל, והמצב הזה אלץ שינוי במצב מושתק.

"תוסף"
תוסף, שמזוהה באמצעות השדה extensionsId, מגדיר את מצב ההשתקה.

Tab

תכונות

• פעיל

  boolean

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

• audible, אודיבל

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

  Chrome 45 ואילך

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

• autoDiscardable

  boolean

  Chrome בגרסה 54 ומעלה

  קביעה אם הדפדפן יכול למחוק את הכרטיסייה באופן אוטומטי כשהמשאבים מועטים.

• דחית את

  boolean

  Chrome בגרסה 54 ומעלה

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

• favIconUrl

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

  כתובת ה-URL של סמל הכרטיסייה. המאפיין הזה מוצג רק אם המניפסט של התוסף כולל את ההרשאה "tabs". היא גם יכולה להיות מחרוזת ריקה אם הכרטיסייה נטענת.

• groupId

  מספר

  Chrome 88 ומעלה

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

• גובה

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

  גובה הכרטיסייה בפיקסלים.

• מודגש

  boolean

  אם הכרטיסייה מודגשת.

• id

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

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

• גלישה פרטית

  boolean

  אם הכרטיסייה נמצאת בחלון פרטי.

• index

  מספר

  האינדקס מבוסס-אפס של הכרטיסייה בתוך החלון שלה.

• lastAccessed

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

  Chrome 121 ומעלה

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

• mutedInfo

  MutedInfo אופציונלי

  Chrome 46 ואילך

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

• openerTabId

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

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

• pendingUrl

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

  Chrome 79 ומעלה

  כתובת ה-URL שאליה הכרטיסייה מנווטת, לפני ההתחייבות. המאפיין הזה מופיע רק אם המניפסט של התוסף כולל את ההרשאה "tabs" וקיים ניווט בהמתנה.

• מוצמד

  boolean

  האם הכרטיסייה מוצמדת.

• האפשרות נבחרה

  boolean

  הוצא משימוש

  יש להשתמש ב-tabs.Tab.highlighted.

  אם הכרטיסייה נבחרה.

• sessionId

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

  מזהה הסשן ששימש לזיהוי ייחודי של כרטיסייה שהתקבלה מ-sessions API.

• status

  TabStatus אופציונלי

  סטטוס הטעינה של הכרטיסייה.

• title

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

  כותרת הכרטיסייה. המאפיין הזה מוצג רק אם המניפסט של התוסף כולל את ההרשאה "tabs".

• כתובת אתר

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

  כתובת ה-URL האחרונה שהוקצתה למסגרת הראשית של הכרטיסייה. המאפיין הזה מופיע רק אם המניפסט של התוסף כולל את ההרשאה "tabs", ויכול להיות שהוא יהיה מחרוזת ריקה אם הכרטיסייה עדיין לא הוזמנה. למידע נוסף, ראו Tab.pendingUrl.

• רוחב

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

  רוחב הכרטיסייה בפיקסלים.

• windowId

  מספר

  מזהה החלון שמכיל את הכרטיסייה.

TabStatus

Chrome 44 ואילך

סטטוס הטעינה של הכרטיסייה.

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

WindowType

Chrome 44 ואילך

סוג החלון.

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

ZoomSettings

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

תכונות

• defaultZoomFactor

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

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

  משמש להחזרת רמת ברירת המחדל של מרחק התצוגה בכרטיסייה הנוכחית בשיחות ל-tab.getZoomSettings.

• אמצעי תחבורה

  ZoomSettingsMode אופציונלי

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

• היקף

  ZoomSettingsScope אופציונלי

  המדיניות קובעת אם השינויים בשינוי מרחק התצוגה יישמרו במקור של הדף, או ייכנסו לתוקף רק בכרטיסייה הזו. ברירת המחדל היא per-origin במצב automatic. אחרת, ברירת המחדל היא per-tab.

ZoomSettingsMode

Chrome 44 ואילך

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

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

'אוטומטית'
שינויי המרחק מהתצוגה מטופלים באופן אוטומטי על-ידי הדפדפן.

"manual"
ביטול הטיפול האוטומטי בשינויים של מרחק התצוגה. האירוע onZoomChange עדיין יישלח, והתוסף אחראי להאזין לאירוע הזה ולהתאים את הדף באופן ידני. במצב הזה אין תמיכה בשינוי מרחק התצוגה של per-origin, ולכן המערכת מתעלמת מהגדרת המרחק מהתצוגה של scope ומתבססת על ההנחה per-tab.

"disabled"
השבתת כל שינוי מרחק התצוגה בכרטיסייה. הכרטיסייה חוזרת לרמת ברירת המחדל של מרחק התצוגה, והמערכת מתעלמת מכל ניסיון לשינוי מרחק התצוגה.

ZoomSettingsScope

Chrome 44 ואילך

המדיניות קובעת אם השינויים בשינוי מרחק התצוגה יישמרו במקור של הדף, או ייכנסו לתוקף רק בכרטיסייה הזו. ברירת המחדל היא per-origin במצב automatic. אחרת, ברירת המחדל היא per-tab.

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

"לכל מקור"
שינויי מרחק התצוגה מתעדכנים במקור של הדף עם המרחק מהתצוגה, כלומר, גם כל שאר הכרטיסיות שהועברו לאותו מקור מוגדלות. בנוסף, שינויים של מרחק התצוגה ב-per-origin נשמרים עם המקור, כלומר כשמנווטים לדפים אחרים באותו מקור, התצוגה של כולם משתנה לאותו גורם זום. ההיקף per-origin זמין רק במצב automatic.

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

תכונות

MAX_CAPTURE_VISIBLE_TAB_CALLS_PER_SECOND

Chrome 92 ומעלה

מספר הפעמים המקסימלי שניתן לקרוא ל-captureVisibleTab בשנייה. השירות captureVisibleTab הוא שירות יקר ולא כדאי להתקשר אליו לעיתים קרובות מדי.

תמורה לכסף

2

TAB_ID_NONE

Chrome 46 ואילך

מזהה שמייצג את העובדה שאין כרטיסייה בדפדפן.

תמורה לכסף

1-

TAB_INDEX_NONE

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

אינדקס שמייצג את המחסור באינדקס כרטיסיות ב-tab_strip.

תמורה לכסף

1-

שיטות

captureVisibleTab()

הבטחה

chrome.tabs.captureVisibleTab(
  windowId?: number,
  options?: ImageDetails,
  callback?: function,
)

צילום האזור הגלוי של הכרטיסייה שפעילה כרגע בחלון שצוין. כדי לקרוא לשיטה הזו, לתוסף צריכה להיות ההרשאה <all_urls> או ההרשאה activeTab. בנוסף לאתרים שתוספים יכולים לגשת אליהם בדרך כלל, השיטה הזו מאפשרת לתוספים לתעד אתרים רגישים שבדרך כלל מוגבלים אליהם, כולל דפי chrome:-scheme, דפים של תוספים אחרים, וכתובות URL של נתונים: את האתרים הרגישים האלה. ניתן לצלם את האתרים הרגישים האלה רק עם ההרשאה activeTab. ניתן לתעד כתובות URL של קבצים רק אם לתוסף ניתנה גישה לקובץ.

פרמטרים

• windowId

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

  חלון היעד. ברירת המחדל היא החלון הנוכחי.

• אפשרויות

  ImageDetails אופציונלי

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

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

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

  (dataUrl: string)=>void

  • dataUrl

    מחרוזת

    כתובת URL של נתונים שמקודדת תמונה של האזור הגלוי בכרטיסייה שצולמה. יכולה להיות מוקצית למאפיין 'src' של רכיב HTML img לרשת המדיה.

החזרות

• הבטחה<string>

  Chrome 88 ומעלה

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

connect()

chrome.tabs.connect(
  tabId: number,
  connectInfo?: object,
)

מתחבר לסקריפטים של התוכן בכרטיסייה שצוינה. האירוע runtime.onConnect מופעל בכל סקריפט תוכן שפועל בכרטיסייה שצוינה עבור התוסף הנוכחי. אפשר לקרוא פרטים נוספים במאמר בנושא העברת הודעות ב-Content Script.

פרמטרים

• tabId

  מספר

• connectInfo

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

  • documentId

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

    Chrome 106 ומעלה

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

  • frameId

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

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

  • name

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

    מועבר ל-onConnect עבור סקריפטים של תוכן שמאזינים לאירוע החיבור.

החזרות

• runtime.Port

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

create()

הבטחה

chrome.tabs.create(
  createProperties: object,
  callback?: function,
)

יצירת כרטיסייה חדשה.

פרמטרים

• createProperties

  אובייקט

  • פעיל

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

    בחירה אם הכרטיסייה תהפוך לכרטיסייה הפעילה בחלון. ההגדרה הזו לא משפיעה על התמקדות החלון (מידע נוסף זמין בקטע windows.update). ברירת המחדל היא true.

  • index

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

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

  • openerTabId

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

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

  • מוצמד

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

    אם צריך להצמיד את הכרטיסייה. ברירת המחדל היא false

  • האפשרות נבחרה

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

    הוצא משימוש

    יש להשתמש באפשרות פעיל.

    אם הכרטיסייה צריכה להפוך לכרטיסייה שנבחרה בחלון. ברירת המחדל היא true

  • כתובת אתר

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

    כתובת ה-URL שאליה רוצים לנווט אל הכרטיסייה. כתובות URL שמוגדרות במלואן חייבות לכלול סכמה (כלומר, 'http://www.google.com', ולא 'www.google.com'). כתובות URL יחסיות הן יחסיות לדף הנוכחי בתוך התוסף. ברירת המחדל היא דף הכרטיסייה החדשה.

  • windowId

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

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

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

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

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

  (tab: Tab)=>void

  • tab

    מקש Tab

    הכרטיסייה שנוצרה.

החזרות

• Promise<Tab>

  Chrome 88 ומעלה

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

detectLanguage()

הבטחה

chrome.tabs.detectLanguage(
  tabId?: number,
  callback?: function,
)

מזהה את השפה הראשית של התוכן בכרטיסייה.

פרמטרים

• tabId

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

  ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.

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

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

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

  (language: string)=>void

  • language

    מחרוזת

    קוד שפת ISO כמו en או fr. לרשימה מלאה של השפות הנתמכות בשיטה זו, ראה kLanguageInfoTable. העמודה השנייה עד רביעית מסומנת ומוחזר הערך הראשון שאינו NULL, מלבד סינית פשוטה שבה מוחזר zh-CN. לשפה לא ידועה/לא מוגדרת, מוחזר und.

החזרות

• הבטחה<string>

  Chrome 88 ומעלה

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

discard()

Promise Chrome 54 ואילך

chrome.tabs.discard(
  tabId?: number,
  callback?: function,
)

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

פרמטרים

• tabId

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

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

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

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

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

  (tab?: Tab)=>void

  • tab

    Tab אופציונלי

    הכרטיסייה שנמחקה, אם היא נמחקה בהצלחה; לא הוגדר אחרת.

החזרות

• הבטחה<Tab|לא מוגדר>

  Chrome 88 ומעלה

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

duplicate()

הבטחה

chrome.tabs.duplicate(
  tabId: number,
  callback?: function,
)

שכפול של כרטיסייה.

פרמטרים

• tabId

  מספר

  המזהה של הכרטיסייה שיש לשכפל.

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

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

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

  (tab?: Tab)=>void

  • tab

    Tab אופציונלי

    פרטים על הכרטיסייה הכפולה. האובייקט tabs.Tab לא מכיל את url, pendingUrl, title, ו-favIconUrl אם לא התבקשה ההרשאה "tabs".

החזרות

• הבטחה<Tab|לא מוגדר>

  Chrome 88 ומעלה

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

executeScript()

Promise &leq; MV2 הוצא משימוש החל מגרסה 91 של Chrome

chrome.tabs.executeScript(
  tabId?: number,
  details: InjectDetails,
  callback?: function,
)

הוחלף על ידי scripting.executeScript במניפסט V3.

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

פרמטרים

• tabId

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

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

• פרטים

  InjectDetails

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

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

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

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

  (result?: any[])=>void

  • תוצאה אחת

    כל[] אופציונלי

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

החזרות

• Promise<any[]|undefined>

  Chrome 88 ומעלה

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

get()

הבטחה

chrome.tabs.get(
  tabId: number,
  callback?: function,
)

מאחזר פרטים על הכרטיסייה שצוינה.

פרמטרים

• tabId

  מספר

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

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

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

  (tab: Tab)=>void

  • tab

    מקש Tab

החזרות

• Promise<Tab>

  Chrome 88 ומעלה

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

getAllInWindow()

Promise &leq; MV2 הוצא משימוש

chrome.tabs.getAllInWindow(
  windowId?: number,
  callback?: function,
)

יש להשתמש ב-tabs.query {windowId: windowId}.

קבלת פרטים על כל הכרטיסיות בחלון שצוין.

פרמטרים

• windowId

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

  ברירת המחדל היא החלון הנוכחי.

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

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

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

  (tabs: Tab[])=>void

  • כרטיסיות

    מקש Tab[]

החזרות

• Promise<Tab[]>

  Chrome 88 ומעלה

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

getCurrent()

הבטחה

chrome.tabs.getCurrent(
  callback?: function,
)

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

פרמטרים

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

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

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

  (tab?: Tab)=>void

  • tab

    Tab אופציונלי

החזרות

• הבטחה<Tab|לא מוגדר>

  Chrome 88 ומעלה

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

getSelected()

Promise &leq; MV2 הוצא משימוש

chrome.tabs.getSelected(
  windowId?: number,
  callback?: function,
)

יש להשתמש ב-tabs.query {active: true}.

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

פרמטרים

• windowId

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

  ברירת המחדל היא החלון הנוכחי.

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

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

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

  (tab: Tab)=>void

  • tab

    מקש Tab

החזרות

• Promise<Tab>

  Chrome 88 ומעלה

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

getZoom()

הבטחה

chrome.tabs.getZoom(
  tabId?: number,
  callback?: function,
)

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

פרמטרים

• tabId

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

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

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

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

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

  (zoomFactor: number)=>void

  • zoomFactor

    מספר

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

החזרות

• הבטחה<number>

  Chrome 88 ומעלה

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

getZoomSettings()

הבטחה

chrome.tabs.getZoomSettings(
  tabId?: number,
  callback?: function,
)

קבלת ההגדרות הנוכחיות של מרחק התצוגה של כרטיסייה מסוימת.

פרמטרים

• tabId

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

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

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

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

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

  (zoomSettings: ZoomSettings)=>void

  • zoomSettings

    ZoomSettings

    ההגדרות הנוכחיות של מרחק התצוגה בכרטיסייה.

החזרות

• Promise<ZoomSettings>

  Chrome 88 ומעלה

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

goBack()

Promise Chrome 72 ואילך

chrome.tabs.goBack(
  tabId?: number,
  callback?: function,
)

חוזרים לדף הקודם, אם יש דף כזה.

פרמטרים

• tabId

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

  מזהה הכרטיסייה שיש לנווט חזרה. ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.

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

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 88 ומעלה

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

goForward()

Promise Chrome 72 ואילך

chrome.tabs.goForward(
  tabId?: number,
  callback?: function,
)

עבור לדף הבא, אם זמין.

פרמטרים

• tabId

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

  מזהה הכרטיסייה לניווט קדימה. ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.

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

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 88 ומעלה

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

group()

Promise Chrome 88 ומעלה

chrome.tabs.group(
  options: object,
  callback?: function,
)

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

פרמטרים

• אפשרויות

  אובייקט

  • createProperties

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

    הגדרות ליצירת קבוצה. לא ניתן להשתמש אם ה-groupId כבר צוין.

    • windowId

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

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

  • groupId

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

    מזהה הקבוצה שאליה רוצים להוסיף את הכרטיסיות. אם לא מגדירים קבוצה חדשה, תיווצר קבוצה חדשה.

  • tabIds

    מספר|[מספר,...מספר[]]

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

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

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

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

  (groupId: number)=>void

  • groupId

    מספר

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

החזרות

• הבטחה<number>

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

highlight()

הבטחה

chrome.tabs.highlight(
  highlightInfo: object,
  callback?: function,
)

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

פרמטרים

• highlightInfo

  אובייקט

  • כרטיסיות

    מספר|מספר[]

    אינדקס כרטיסייה אחד או יותר להדגשה.

  • windowId

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

    החלון שמכיל את הכרטיסיות.

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

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

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

  (window: Window)=>void

  • חלון

    חלון

    מכילה פרטים על החלון שהכרטיסיות שלו הודגשו.

החזרות

• Promise<windows.Window>

  Chrome 88 ומעלה

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

insertCSS()

Promise &leq; MV2 הוצא משימוש החל מגרסה 91 של Chrome

chrome.tabs.insertCSS(
  tabId?: number,
  details: InjectDetails,
  callback?: function,
)

הוחלף על ידי scripting.insertCSS במניפסט V3.

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

פרמטרים

• tabId

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

  מזהה הכרטיסייה שאליה יש להוסיף את ה-CSS. ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.

• פרטים

  InjectDetails

  פרטים על טקסט ה-CSS להוספה. יש להגדיר את הקוד או את מאפיין הקובץ, אבל אי אפשר להגדיר את שניהם בו-זמנית.

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

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 88 ומעלה

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

move()

הבטחה

chrome.tabs.move(
  tabIds: number|number[],
  moveProperties: object,
  callback?: function,
)

מעביר כרטיסייה אחת או יותר למיקום חדש בתוך החלון שלה, או לחלון חדש. שים לב: ניתן להעביר כרטיסיות רק מחלונות רגילים (window.type === "regular" ).

פרמטרים

• tabIds

  מספר|מספר[]

  מזהה הכרטיסייה או רשימת מזהי הכרטיסיות להעברה.

• moveProperties

  אובייקט

  • index

    מספר

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

  • windowId

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

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

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

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

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

  (tabs: Tab|Tab[])=>void

  • כרטיסיות

    מקש Tab|Tab[]

    פרטים על הכרטיסיות שהועברו.

החזרות

• התחייבות<Tab|Tab[]>

  Chrome 88 ומעלה

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

query()

הבטחה

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

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

פרמטרים

• queryInfo

  אובייקט

  • פעיל

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

    אם הכרטיסיות פעילות בחלונות שלהן.

  • audible, אודיבל

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

    Chrome 45 ואילך

    האם ניתן לשמוע את הכרטיסיות.

  • autoDiscardable

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

    Chrome בגרסה 54 ומעלה

    אם הדפדפן יכול למחוק את הכרטיסיות באופן אוטומטי כשהמשאבים מועטים.

  • currentWindow

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

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

  • דחית את

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

    Chrome בגרסה 54 ומעלה

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

  • groupId

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

    Chrome 88 ומעלה

    מזהה הקבוצה שבה הכרטיסיות נמצאות או tabGroups.TAB_GROUP_ID_NONE לכרטיסיות שהן לא מקובצות.

  • מודגש

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

    אם הכרטיסיות מודגשות.

  • index

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

    המיקום של הכרטיסיות בתוך החלונות שלהן.

  • lastFocusedWindow

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

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

  • מושתק

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

    Chrome 45 ואילך

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

  • מוצמד

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

    האם הכרטיסיות מוצמדות.

  • status

    TabStatus אופציונלי

    הסטטוס של טעינת הכרטיסייה.

  • title

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

    מתאימים את כותרות הדפים לדפוס מסוים. המערכת תתעלם מהמאפיין הזה אם לתוסף אין את ההרשאה "tabs".

  • כתובת אתר

    string|string[] optional

    מתאימים כרטיסיות לדפוס כתובת URL אחד או יותר. אין התאמה למזהי מקטעים. המערכת תתעלם מהמאפיין הזה אם לתוסף אין את ההרשאה "tabs".

  • windowId

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

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

  • windowType

    WindowType אופציונלי

    סוג החלון שבו נמצאות הכרטיסיות.

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

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

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

  (result: Tab[])=>void

  • תוצאה אחת

    מקש Tab[]

החזרות

• Promise<Tab[]>

  Chrome 88 ומעלה

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

reload()

הבטחה

chrome.tabs.reload(
  tabId?: number,
  reloadProperties?: object,
  callback?: function,
)

טוענים כרטיסייה מחדש.

פרמטרים

• tabId

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

  מזהה הכרטיסייה לטעינה מחדש. ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.

• reloadProperties

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

  • bypassCache

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

    האם לעקוף את השמירה המקומית במטמון. ברירת המחדל היא false.

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

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 88 ומעלה

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

remove()

הבטחה

chrome.tabs.remove(
  tabIds: number|number[],
  callback?: function,
)

סוגר כרטיסייה אחת או יותר.

פרמטרים

• tabIds

  מספר|מספר[]

  מזהה הכרטיסייה או רשימת מזהי הכרטיסיות לסגירה.

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

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 88 ומעלה

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

removeCSS()

Promise Chrome 87 ואילך &leq; MV2 הוצא משימוש החל מגרסה 91 של Chrome

chrome.tabs.removeCSS(
  tabId?: number,
  details: DeleteInjectionDetails,
  callback?: function,
)

הוחלף על ידי scripting.removeCSS במניפסט V3.

הסרה משירות CSS של דף שהוחדר בעבר על ידי קריאה אל scripting.insertCSS.

פרמטרים

• tabId

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

  מזהה הכרטיסייה שממנה יש להסיר את ה-CSS. ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.

• פרטים

  DeleteInjectionDetails

  פרטים על טקסט ה-CSS להסרה. יש להגדיר את הקוד או את מאפיין הקובץ, אבל אי אפשר להגדיר את שניהם בו-זמנית.

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

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 88 ומעלה

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

sendMessage()

הבטחה

chrome.tabs.sendMessage(
  tabId: number,
  message: any,
  options?: object,
  callback?: function,
)

שולח הודעה יחידה לסקריפטים של התוכן בכרטיסייה שצוינה, עם קריאה חוזרת(callback) אופציונלית שתפעל כשנשלחת תשובה. האירוע runtime.onMessage מופעל בכל סקריפט תוכן שפועל בכרטיסייה שצוינה עבור התוסף הנוכחי.

פרמטרים

• tabId

  מספר

• הודעה

  הכול

  ההודעה שיש לשלוח. ההודעה צריכה להיות אובייקט שניתן ל-JSON.

• אפשרויות

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

  • documentId

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

    Chrome 106 ומעלה

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

  • frameId

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

    שליחת הודעה למסגרת ספציפית שמזוהה על ידי frameId במקום לכל המסגרות בכרטיסייה.

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

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

  Chrome 99 ומעלה

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

  (response: any)=>void

  • תשובה

    הכול

    אובייקט תגובת JSON שנשלח על ידי ה-handler של ההודעה. אם תתרחש שגיאה במהלך ההתחברות לכרטיסייה שצוינה, תתבצע קריאה חוזרת ללא ארגומנטים וה-runtime.lastError יוגדר כהודעת השגיאה.

החזרות

• מבטיח<any>

  Chrome 99 ומעלה

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

sendRequest()

Promise &leq; MV2 הוצא משימוש

chrome.tabs.sendRequest(
  tabId: number,
  request: any,
  callback?: function,
)

יש להשתמש ב-runtime.sendMessage.

שולחת בקשה אחת לסקריפטים של התוכן בכרטיסייה שצוינה, עם קריאה חוזרת(callback) אופציונלית שתפעל כשנשלחת תשובה. האירוע extension.onRequest מופעל בכל סקריפט תוכן שפועל בכרטיסייה שצוינה עבור התוסף הנוכחי.

פרמטרים

• tabId

  מספר

• בקשה

  הכול

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

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

  Chrome 99 ומעלה

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

  (response: any)=>void

  • תשובה

    הכול

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

החזרות

• מבטיח<any>

  Chrome 99 ומעלה

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

setZoom()

הבטחה

chrome.tabs.setZoom(
  tabId?: number,
  zoomFactor: number,
  callback?: function,
)

שינוי מרחק התצוגה של כרטיסייה מסוימת.

פרמטרים

• tabId

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

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

• zoomFactor

  מספר

  גורם הזום החדש. הערך 0 מגדיר את הכרטיסייה לגורם ברירת המחדל הנוכחי של הזום. ערכים גדולים מ-0 מציינים גורם זום (אולי לא ברירת המחדל) של הכרטיסייה.

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

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 88 ומעלה

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

setZoomSettings()

הבטחה

chrome.tabs.setZoomSettings(
  tabId?: number,
  zoomSettings: ZoomSettings,
  callback?: function,
)

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

פרמטרים

• tabId

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

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

• zoomSettings

  ZoomSettings

  המדיניות הזו מגדירה את אופן הטיפול בשינויים של מרחק התצוגה ובאיזה היקף.

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

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 88 ומעלה

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

ungroup()

Promise Chrome 88 ומעלה

chrome.tabs.ungroup(
  tabIds: number|[number,...number[]],
  callback?: function,
)

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

פרמטרים

• tabIds

  מספר|[מספר,...מספר[]]

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

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

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

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

  ()=>void

החזרות

• Promise<void>

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

update()

הבטחה

chrome.tabs.update(
  tabId?: number,
  updateProperties: object,
  callback?: function,
)

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

פרמטרים

• tabId

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

  ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.

• updateProperties

  אובייקט

  • פעיל

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

    האם הכרטיסייה צריכה להיות פעילה. ההגדרה הזו לא משפיעה על התמקדות החלון (מידע נוסף זמין בכתובת windows.update).

  • autoDiscardable

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

    Chrome בגרסה 54 ומעלה

    קביעה אם הדפדפן יסגור את הכרטיסייה באופן אוטומטי כשהמשאבים מועטים.

  • מודגש

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

    מוסיף או מסיר את הכרטיסייה מהבחירה הנוכחית.

  • מושתק

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

    Chrome 45 ואילך

    האם יש להשתיק את הכרטיסייה.

  • openerTabId

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

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

  • מוצמד

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

    אם צריך להצמיד את הכרטיסייה.

  • האפשרות נבחרה

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

    הוצא משימוש

    צריך להשתמש באפשרות מודגש.

    בחירה אם לבחור בכרטיסייה.

  • כתובת אתר

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

    כתובת ה-URL שאליה צריך לעבור לכרטיסייה. אין תמיכה בכתובות URL של JavaScript. במקום זאת, יש להשתמש ב-scripting.executeScript.

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

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

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

  (tab?: Tab)=>void

  • tab

    Tab אופציונלי

    פרטים על הכרטיסייה המעודכנת. האובייקט tabs.Tab לא מכיל את url, pendingUrl, title, ו-favIconUrl אם לא התבקשה ההרשאה "tabs".

החזרות

• הבטחה<Tab|לא מוגדר>

  Chrome 88 ומעלה

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

אירועים

onActivated

chrome.tabs.onActivated.addListener(
  callback: function,
)

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

פרמטרים

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

  פונקציה

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

  (activeInfo: object)=>void

  • activeInfo

    אובייקט

    • tabId

      מספר

      המזהה של הכרטיסייה שהפכה לפעילה.

    • windowId

      מספר

      מזהה החלון שבתוכו השתנתה הכרטיסייה הפעילה.

onActiveChanged

&leq; MV2 הוצא משימוש

chrome.tabs.onActiveChanged.addListener(
  callback: function,
)

יש להשתמש ב-tabs.onActivated.

מופעלת כשהכרטיסייה שנבחרה בחלון משתנה. לתשומת ליבכם: יכול להיות שכתובת ה-URL של הכרטיסייה לא תהיה מוגדרת בזמן שהאירוע הזה הופעל, אבל אפשר להאזין לאירועים ב-tabs.onUpdated כדי לקבל הודעה כשכתובת URL מוגדרת.

פרמטרים

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

  פונקציה

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

  (tabId: number,selectInfo: object)=>void

  • tabId

    מספר

  • selectInfo

    אובייקט

    • windowId

      מספר

      מזהה החלון שבתוכו השתנתה הכרטיסייה שנבחרה.

onAttached

chrome.tabs.onAttached.addListener(
  callback: function,
)

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

פרמטרים

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

  פונקציה

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

  (tabId: number,attachInfo: object)=>void

  • tabId

    מספר

  • attachInfo

    אובייקט

    • newPosition

      מספר

    • newWindowId

      מספר

onCreated

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

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

פרמטרים

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

  פונקציה

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

  (tab: Tab)=>void

  • tab

    מקש Tab

onDetached

chrome.tabs.onDetached.addListener(
  callback: function,
)

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

פרמטרים

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

  פונקציה

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

  (tabId: number,detachInfo: object)=>void

  • tabId

    מספר

  • detachInfo

    אובייקט

    • oldPosition

      מספר

    • oldWindowId

      מספר

onHighlightChanged

&leq; MV2 הוצא משימוש

chrome.tabs.onHighlightChanged.addListener(
  callback: function,
)

יש להשתמש ב-tabs.onHighlighted.

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

פרמטרים

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

  פונקציה

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

  (selectInfo: object)=>void

  • selectInfo

    אובייקט

    • tabIds

      מספר[]

      כל הכרטיסיות המודגשות בחלון.

    • windowId

      מספר

      החלון שהכרטיסיות שלו השתנו.

onHighlighted

chrome.tabs.onHighlighted.addListener(
  callback: function,
)

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

פרמטרים

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

  פונקציה

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

  (highlightInfo: object)=>void

  • highlightInfo

    אובייקט

    • tabIds

      מספר[]

      כל הכרטיסיות המודגשות בחלון.

    • windowId

      מספר

      החלון שהכרטיסיות שלו השתנו.

onMoved

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

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

פרמטרים

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

  פונקציה

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

  (tabId: number,moveInfo: object)=>void

  • tabId

    מספר

  • moveInfo

    אובייקט

    • fromIndex

      מספר

    • toIndex

      מספר

    • windowId

      מספר

onRemoved

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

מופעל כשכרטיסייה נסגרת.

פרמטרים

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

  פונקציה

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

  (tabId: number,removeInfo: object)=>void

  • tabId

    מספר

  • removeInfo

    אובייקט

    • isWindowClosing

      boolean

      True כשהכרטיסייה נסגרה כי חלון ההורה שלה נסגר.

    • windowId

      מספר

      החלון שהכרטיסייה שלו סגורה.

onReplaced

chrome.tabs.onReplaced.addListener(
  callback: function,
)

מופעל כשכרטיסייה מוחלפת בכרטיסייה אחרת בגלל עיבוד מראש או עיבוד מיידי.

פרמטרים

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

  פונקציה

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

  (addedTabId: number,removedTabId: number)=>void

  • addedTabId

    מספר

  • removedTabId

    מספר

onSelectionChanged

&leq; MV2 הוצא משימוש

chrome.tabs.onSelectionChanged.addListener(
  callback: function,
)

יש להשתמש ב-tabs.onActivated.

מופעלת כשהכרטיסייה שנבחרה בחלון משתנה.

פרמטרים

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

  פונקציה

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

  (tabId: number,selectInfo: object)=>void

  • tabId

    מספר

  • selectInfo

    אובייקט

    • windowId

      מספר

      מזהה החלון שבתוכו השתנתה הכרטיסייה שנבחרה.

onUpdated

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

מופעל כשכרטיסייה מתעדכנת.

פרמטרים

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

  פונקציה

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

  (tabId: number,changeInfo: object,tab: Tab)=>void

  • tabId

    מספר

  • changeInfo

    אובייקט

    • audible, אודיבל

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

      Chrome 45 ואילך

      מצב השמע החדש של הכרטיסייה.

    • autoDiscardable

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

      Chrome בגרסה 54 ומעלה

      המצב החדש של הכרטיסייה.

    • דחית את

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

      Chrome בגרסה 54 ומעלה

      מצב המחיקה החדש של הכרטיסייה.

    • favIconUrl

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

      כתובת ה-URL של סמל האתר החדש של הכרטיסייה.

    • groupId

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

      Chrome 88 ומעלה

      הקבוצה החדשה של הכרטיסייה.

    • mutedInfo

      MutedInfo אופציונלי

      Chrome 46 ואילך

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

    • מוצמד

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

      מצב ההצמדה החדש של הכרטיסייה.

    • status

      TabStatus אופציונלי

      סטטוס הטעינה של הכרטיסייה.

    • title

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

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

      השם החדש של הכרטיסייה.

    • כתובת אתר

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

      כתובת ה-URL של הכרטיסייה, אם היא השתנתה.

  • tab

    מקש Tab

onZoomChange

chrome.tabs.onZoomChange.addListener(
  callback: function,
)

מופעל בעת שינוי מרחק תצוגה בכרטיסייה.

פרמטרים

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

  פונקציה

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

  (ZoomChangeInfo: object)=>void

  • ZoomChangeInfo

    אובייקט

    • newZoomFactor

      מספר

    • oldZoomFactor

      מספר

    • tabId

      מספר

    • zoomSettings

      ZoomSettings