chrome.printingMetrics

תיאור

כדי לאחזר נתונים לגבי השימוש בהדפסה, יש להשתמש ב-API chrome.printingMetrics.

הרשאות

printingMetrics

זמינות

Chrome 79 ואילך ChromeOS בלבד נדרשת מדיניות

סוגים

ColorMode

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

"BLACK_AND_WHITE"
מציין שנעשה שימוש במצב שחור-לבן.

"צבע"
מציין שנעשה שימוש במצב צבע.

DuplexMode

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

"ONE_SIDED"
מציין שנעשה שימוש בהדפסה חד-צדדית.

"TWO_SIDED_LONG_EDGE"
מציין שנעשה שימוש בהדפסה דו-צדדית, כלומר על הקצה הארוך.

"TWO_SIDED_SHORT_EDGE"
מציין שנעשה שימוש בהדפסה דו-צדדית, כלומר על קצה קצר.

MediaSize

תכונות

  • גובה

    מספר

    הגובה (במיקרומטרים) של המדיה המשמשת להדפסה.

  • vendorId

    מחרוזת

    המזהה שסיפק הספק, למשל 'iso_a3_297x420mm' או 'na_index-3x5_3x5in'. ערכים אפשריים הם ערכים של מאפיין IPP 'media' שניתן למצוא בדף IANA .

  • רוחב

    מספר

    הרוחב (במיקרומטרים) של המדיה המשמשת להדפסה.

Printer

תכונות

  • name

    מחרוזת

    שם המדפסת המוצג.

  • source

    PrinterSource

    מקור המדפסת.

  • uri

    מחרוזת

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

PrinterSource

מקור המדפסת.

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

"USER"
מציין שהמדפסת נוספה על ידי המשתמש.

"POLICY"
מציין שהמדפסת נוספה באמצעות מדיניות.

PrintJobInfo

תכונות

  • completionTime

    מספר

    זמן השלמת המשימה (באלפיות שנייה לאחר תקופת מערכת Unix).

  • creationTime

    מספר

    זמן יצירת המשימה (באלפיות שנייה אחרי מערכת Unix).

  • id

    מחרוזת

    המזהה של המשרה.

  • numberOfPages

    מספר

    מספר הדפים במסמך.

  • מדפסת

    מדפסת

    המידע על המדפסת שבה מודפס המסמך.

  • printer_status

    PrinterStatus

    Chrome 85 ומעלה

    הסטטוס של המדפסת.

  • הגדרות

    PrintSettings

    ההגדרות של עבודת ההדפסה.

  • המקור שמראה מי יזם את משימת ההדפסה.

  • sourceId

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

    המזהה של המקור. המערכת תציג ערך של null אם המקור הוא print_PREVIEW או ANDROID_APP.

  • הסטטוס הסופי של המשרה.

  • title

    מחרוזת

    כותרת המסמך שהודפס.

PrintJobSource

המקור של עבודת ההדפסה.

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

"print_PREVIEW"
מציין שהמשימה נוצרה מדף התצוגה המקדימה של ההדפסה שהמשתמש יזם.

"ANDROID_APP"
מציין שהמשימה נוצרה מאפליקציה ל-Android.

"extension"
מציין שהמשימה נוצרה על-ידי תוסף באמצעות Chrome API.

"ISOLATED_WEB_APP"
מציין שהמשימה נוצרה על ידי אפליקציית אינטרנט מבודדת באמצעות API.

PrintJobStatus

מציין את הסטטוס הסופי של משימת ההדפסה.

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

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

'מבוטל'
מציין שמשימת ההדפסה בוטלה על ידי המשתמש או באמצעות API.

'printED'
מציין שמשימת ההדפסה הודפסה ללא שגיאות.

PrintSettings

תכונות

  • color [צבע]

    ColorMode

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

  • עותקים

    מספר

    מספר העותקים המבוקש.

  • דופלקס

    DuplexMode

    מצב הדופלקס המבוקש.

  • mediaSize

    MediaSize

    גודל המדיה המבוקש.

שיטות

getPrintJobs()

הבטחה 
chrome.printingMetrics.getPrintJobs(
  callback?: function,
)

מחזירה את הרשימה של משימות ההדפסה שהסתיימו.

פרמטרים

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

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

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

    (jobs: PrintJobInfo[])=>void

החזרות

  • Promise<PrintJobInfo[]>

    Chrome 96 ומעלה

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

אירועים

onPrintJobFinished

chrome.printingMetrics.onPrintJobFinished.addListener(
  callback: function,
)

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

פרמטרים

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

    פונקציה

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

    (jobInfo: PrintJobInfo)=>void