chrome.fileSystemProvider

refresh date: 2026-09-25 robots: noindex

תיאור

אפשר להשתמש ב-API של chrome.fileSystemProvider כדי ליצור מערכות קבצים שאפשר לגשת אליהן ממנהל הקבצים ב-ChromeOS.

הרשאות

fileSystemProvider

זמינות

ChromeOS בלבד

מניפסט

כדי להשתמש ב-File System Provider API, צריך להצהיר על ההרשאה והקטע "fileSystemProvider" במניפסט של התוסף. לדוגמה:

{
  "name": "My extension",
  ...
  "permissions": [
    "fileSystemProvider"
  ],
  ...
  "file_system_provider_capabilities": {
    "configurable": true,
    "watchable": false,
    "multiple_mounts": true,
    "source": "network"
  },
  ...
}

צריך להצהיר על הקטע file_system_provider באופן הבא:

‫configurable (בוליאני) – אופציונלי
אם יש תמיכה בהגדרה באמצעות onConfigureRequested. ברירת המחדל: false.
‫multiple_mounts (בוליאני) – אופציונלי
אם יש תמיכה במספר מערכות קבצים (יותר מאחת) שנטענו. ברירת המחדל: false.
‫watchable (בוליאני) – אופציונלי
אם יש תמיכה בהגדרת צופים ובשליחת התראות על שינויים. ברירת המחדל: false.
source (enum של "file",‏ "device" או "network") – חובה
מקור הנתונים של מערכות קבצים שנטענו.

אפליקציית Files משתמשת במידע שלמעלה כדי להציג בצורה מתאימה את הרכיבים הקשורים בממשק המשתמש. לדוגמה, אם המדיניות configurable מוגדרת כ-True, יוצג פריט בתפריט להגדרת אמצעי אחסון. באופן דומה, אם המדיניות multiple_mounts מוגדרת לערך true, אפליקציית Files תאפשר להוסיף יותר מנקודת טעינה אחת מממשק המשתמש. אם watchable הוא false, יוצג לחצן רענון. הערה: אם אפשר, כדאי להוסיף תמיכה ב-watchers, כדי שהשינויים במערכת הקבצים יבואו לידי ביטוי באופן מיידי ואוטומטי.

סקירה כללית

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

טעינת מערכות קבצים

תוספים שמספקים תוכן יכולים לספק תוכן של מערכת קבצים ממקור חיצוני (כמו שרת מרוחק או התקן USB), או להשתמש בקובץ מקומי (כמו ארכיון) כקלט.

כדי לכתוב מערכות קבצים שהן רכיבי handler של קבצים (המקור הוא "file"), הספק חייב להיות אפליקציה ארוזה, כי האירוע onLaunched לא זמין לתוספים.

אם המקור הוא רשת או מכשיר, צריך לטעון את מערכת הקבצים כשמתבצעת קריאה לאירוע onMountRequested.

מקור הנתונים של מערכת הקבצים נקודת כניסה
"file" זמין רק לאפליקציות ארוזות.
"device" או "network" onMountRequested

הגדרת מערכות קבצים

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

דוחות מחזור חיים

מערכות קבצים שסופקו ונטענו נשמרות בזיכרון של Chrome ונטענות מחדש באופן אוטומטי אחרי אתחול או הפעלה מחדש. לכן, אחרי שמערכת קבצים נטענת על ידי תוסף שמספק אותה, היא תישאר עד שהתוסף ייפרק או עד שהתוסף יפעיל את ה-method‏ unmount.

סוגים

AbortRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • operationRequestId

    number

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

Action

‫Chrome 45 ואילך

מאפיינים

  • id [מזהה]

    מחרוזת

    המזהה של הפעולה. כל מחרוזת או CommonActionId לפעולות נפוצות.

  • title

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

    שם הפעולה. יכול להיות שהמערכת תתעלם מהפרמטר הזה בפעולות נפוצות.

AddWatcherRequestedOptions

מאפיינים

  • entryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    בוליאני

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

Change

מאפיינים

  • changeType

    ChangeType

    סוג השינוי שבוצע ברשומה.

  • cloudFileInfo

    CloudFileInfo אופציונלי

    ‫Chrome מגרסה 125 ואילך

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

  • entryPath

    מחרוזת

    הנתיב של הרשומה שהשתנתה.

ChangeType

סוג השינוי שזוהה בספרייה שנצפתה.

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

"CHANGED"

"DELETED"

CloseFileRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • openRequestId

    number

    מזהה בקשה שמשמש לפתיחת הקובץ.

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

CloudFileInfo

‫Chrome מגרסה 125 ואילך

מאפיינים

  • versionTag

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

    תג שמייצג את גרסת הקובץ.

CloudIdentifier

‫Chrome מגרסה 117 ואילך

מאפיינים

  • id [מזהה]

    מחרוזת

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

  • providerName

    מחרוזת

    מזהה של ספק האחסון בענן (למשל, drive.google.com).

CommonActionId

‫Chrome 45 ואילך

רשימה של פעולות נפוצות. ‫"SHARE" מיועד לשיתוף קבצים עם אחרים. "SAVE_FOR_OFFLINE" להצמדה (שמירה לגישה אופליין). ‫"OFFLINE_NOT_NECESSARY" כדי להודיע שהקובץ לא צריך להיות מאוחסן יותר לגישה אופליין. בשימוש על ידי onGetActionsRequested ו-onExecuteActionRequested.

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

"SAVE_FOR_OFFLINE"

"OFFLINE_NOT_NECESSARY"

"שיתוף"

ConfigureRequestedOptions

‫Chrome מגרסה 44 ואילך

מאפיינים

  • fileSystemId

    מחרוזת

    המזהה של מערכת הקבצים שרוצים להגדיר.

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

CopyEntryRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

  • sourcePath

    מחרוזת

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

  • targetPath

    מחרוזת

    נתיב היעד של פעולת ההעתקה.

CreateDirectoryRequestedOptions

מאפיינים

  • directoryPath

    מחרוזת

    הנתיב של הספרייה שרוצים ליצור.

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    בוליאני

    אם הפעולה היא רקורסיבית (לספריות בלבד).

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

CreateFileRequestedOptions

מאפיינים

  • filePath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

DeleteEntryRequestedOptions

מאפיינים

  • entryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    בוליאני

    אם הפעולה היא רקורסיבית (לספריות בלבד).

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

EntryMetadata

מאפיינים

  • cloudFileInfo

    CloudFileInfo אופציונלי

    ‫Chrome מגרסה 125 ואילך

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

  • cloudIdentifier

    CloudIdentifier אופציונלי

    ‫Chrome מגרסה 117 ואילך

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

  • isDirectory

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

    ‫True אם מדובר בספרייה. חובה לספק את המידע הזה אם הוא נדרש ב-options.

  • mimeType

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

    סוג ה-MIME של הרשומה. תמיד אופציונלי, אבל צריך לספק אותו אם הוא נדרש ב-options.

  • modificationTime

    תאריך (אופציונלי)

    המועד שבו הרשומה הזו שונתה לאחרונה. חובה לספק את המידע הזה אם הוא נדרש ב-options.

  • שם

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

    השם של הרשומה הזו (לא שם הנתיב המלא). אסור להכיל את התו "/". בשורש, השדה חייב להיות ריק. חובה לספק את המידע הזה אם הוא נדרש ב-options.

  • size

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

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

  • תמונה ממוזערת

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

    תמונה ממוזערת כ-URI של נתונים בפורמט PNG, ‏ JPEG או WEBP, בגודל של עד 32KB. אופציונלי, אבל אפשר לספק אותו רק כשמבקשים אותו במפורש באירוע onGetMetadataRequested.

ExecuteActionRequestedOptions

‫Chrome 45 ואילך

מאפיינים

  • actionId

    מחרוזת

    המזהה של הפעולה שצריך לבצע.

  • entryPaths

    string[]‎

    ‫Chrome 47 ואילך

    קבוצת הנתיבים של הרשומות שבהן צריך להשתמש בשביל הפעולה.

  • fileSystemId

    מחרוזת

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

FileSystemInfo

מאפיינים

  • displayName

    מחרוזת

    שם של מערכת הקבצים שקריא לאנשים.

  • fileSystemId

    מחרוזת

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

  • openedFiles

    OpenedFile[]

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

  • openedFilesLimit

    number

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

  • supportsNotifyTag

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

    ‫Chrome 45 ואילך

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

  • צופים

    Watcher[]

    ‫Chrome 45 ואילך

    רשימת הצופים.

  • ניתן לכתיבה

    בוליאני

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

GetActionsRequestedOptions

‫Chrome 45 ואילך

מאפיינים

  • entryPaths

    string[]‎

    ‫Chrome 47 ואילך

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

  • fileSystemId

    מחרוזת

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

GetMetadataRequestedOptions

מאפיינים

  • cloudFileInfo

    בוליאני

    ‫Chrome מגרסה 125 ואילך

    צריך להגדיר את הערך true אם נדרש הערך cloudFileInfo.

  • cloudIdentifier

    בוליאני

    ‫Chrome מגרסה 117 ואילך

    צריך להגדיר את הערך true אם נדרש הערך cloudIdentifier.

  • entryPath

    מחרוזת

    הנתיב של הרשומה שרוצים לאחזר את המטא-נתונים שלה.

  • fileSystemId

    מחרוזת

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

  • isDirectory

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך is_directory.

  • mimeType

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך mimeType.

  • modificationTime

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך modificationTime.

  • שם

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך name.

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

  • size

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך size.

  • תמונה ממוזערת

    בוליאני

    צריך להגדיר את הערך true אם נדרש הערך thumbnail.

MountOptions

מאפיינים

  • displayName

    מחרוזת

    שם של מערכת הקבצים שקריא לאנשים.

  • fileSystemId

    מחרוזת

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

  • openedFilesLimit

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

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

  • קבוע

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

    ‫Chrome מגרסה 64 ואילך

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

  • supportsNotifyTag

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

    ‫Chrome 45 ואילך

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

  • ניתן לכתיבה

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

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

MoveEntryRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

  • sourcePath

    מחרוזת

    נתיב המקור של הרשומה שרוצים להעביר למקום חדש.

  • targetPath

    מחרוזת

    נתיב היעד של פעולת ההעתקה.

NotifyOptions

מאפיינים

  • changeType

    ChangeType

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

  • שינויים

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

    רשימת השינויים ברשומות בספרייה שנמצאת במעקב (כולל הרשומה עצמה)

  • fileSystemId

    מחרוזת

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

  • observedPath

    מחרוזת

    הנתיב של הרשומה שנצפתה.

  • רקורסיבי

    בוליאני

    מצב הרשומה שנצפתה.

  • תג

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

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

OpenedFile

מאפיינים

  • filePath

    מחרוזת

    הנתיב של הקובץ שנפתח.

  • מצב

    OpenFileMode

    אם הקובץ נפתח לקריאה או לכתיבה.

  • openRequestId

    number

    מזהה בקשה לשימוש בבקשות קריאה/כתיבה וסגירה עוקבות.

OpenFileMode

מצב פתיחת קובץ. בשימוש על ידי onOpenFileRequested.

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

"READ"

"WRITE"

OpenFileRequestedOptions

מאפיינים

  • filePath

    מחרוזת

    הנתיב של הקובץ שרוצים לפתוח.

  • fileSystemId

    מחרוזת

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

  • מצב

    OpenFileMode

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

  • requestId

    number

    מזהה בקשה שישמש לבקשות קריאה/כתיבה וסגירה עוקבות.

ProviderError

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

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

"אישור"

"FAILED"

"IN_USE"

"EXISTS"

"NOT_FOUND"

"ACCESS_DENIED"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NO_SPACE"

"NOT_A_DIRECTORY"

"INVALID_OPERATION"

"אבטחה"

"ABORT"

"NOT_A_FILE"

"NOT_EMPTY"

"INVALID_URL"

"IO"

ReadDirectoryRequestedOptions

מאפיינים

  • directoryPath

    מחרוזת

    הנתיב של הספרייה שהתוכן שלה התבקש.

  • fileSystemId

    מחרוזת

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

  • isDirectory

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך is_directory.

  • mimeType

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך mimeType.

  • modificationTime

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך modificationTime.

  • שם

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך name.

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

  • size

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך size.

  • תמונה ממוזערת

    בוליאני

    ‫Chrome 49 ואילך

    צריך להגדיר את הערך true אם נדרש הערך thumbnail.

ReadFileRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • length

    number

    מספר הבייטים שיוחזרו.

  • היסט

    number

    המיקום בקובץ (בבייטים) שממנו מתחילה הקריאה.

  • openRequestId

    number

    מזהה בקשה שמשמש לפתיחת הקובץ.

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

RemoveWatcherRequestedOptions

מאפיינים

  • entryPath

    מחרוזת

    הנתיב של הרשומה שנצפתה.

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    בוליאני

    מצב הצופה.

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

TruncateRequestedOptions

מאפיינים

  • filePath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • length

    number

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

UnmountOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

UnmountRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

Watcher

מאפיינים

  • entryPath

    מחרוזת

    הנתיב של הרשומה שנצפית.

  • lastTag

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

    התג ששימש בהתראה האחרונה לצופה.

  • רקורסיבי

    בוליאני

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

WriteFileRequestedOptions

מאפיינים

  • נתונים

    ArrayBuffer

    מאגר נתונים זמני של בייטים שייכתבו בקובץ.

  • fileSystemId

    מחרוזת

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

  • היסט

    number

    המיקום בקובץ (בבייטים) שממנו מתחילה כתיבת הבייטים.

  • openRequestId

    number

    מזהה בקשה שמשמש לפתיחת הקובץ.

  • requestId

    number

    המזהה הייחודי של הבקשה הזו.

Methods

get()

Promise 
chrome.fileSystemProvider.get(
  fileSystemId: string,
  callback?: function,
): Promise<FileSystemInfo>

הפונקציה מחזירה מידע על מערכת קבצים עם הערך fileSystemId שהועבר.

פרמטרים

  • fileSystemId

    מחרוזת

  • callback

    function optional

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

    (fileSystem: FileSystemInfo) => void

החזרות

  • Promise<FileSystemInfo>

    ‫Chrome מגרסה 96 ואילך

    קריאה חוזרת (callback) לקבלת התוצאה של הפונקציה get.

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getAll()

Promise 
chrome.fileSystemProvider.getAll(
  callback?: function,
): Promise<FileSystemInfo[]>

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

פרמטרים

החזרות

  • Promise<FileSystemInfo[]>

    ‫Chrome מגרסה 96 ואילך

    קריאה חוזרת (callback) לקבלת התוצאה של הפונקציה getAll.

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

mount()

Promise 
chrome.fileSystemProvider.mount(
  options: MountOptions,
  callback?: function,
): Promise<void>

טעינה של מערכת קבצים עם fileSystemId ו-displayName שצוינו. השם displayName יוצג בחלונית הימנית של אפליקציית הקבצים. השם displayName יכול להכיל כל תו, כולל "/", אבל הוא לא יכול להיות מחרוזת ריקה. השדה displayName צריך להיות תיאורי, אבל לא חייב להיות ייחודי. הערך של fileSystemId לא יכול להיות מחרוזת ריקה.

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

אם תהיה שגיאה, הערך של runtime.lastError יוגדר עם קוד השגיאה המתאים.

פרמטרים

  • אפשרויות

    MountOptions

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 96 ואילך

    קריאה חוזרת (callback) כללית של תוצאה שמציינת הצלחה או כישלון.

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

notify()

Promise Chrome 45+‎ 
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
  callback?: function,
): Promise<void>

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

כדי להשתמש, צריך להגדיר את אפשרות המניפסט file_system_provider.notify כ-true.

הערך של tag יכול להיות כל מחרוזת ייחודית לכל קריאה, כדי שאפשר יהיה לזהות את ההתראה האחרונה שנרשמה. לדוגמה, אם התוסף שמספק את המידע מתחיל לפעול אחרי הפעלה מחדש, והתג של ההתראה האחרונה שנרשמה שווה ל-"123", הוא צריך לקרוא ל-notify עבור כל השינויים שקרו מאז השינוי שתויג כ-"123". הוא לא יכול להיות מחרוזת ריקה.

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

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

אם תהיה שגיאה, הערך של runtime.lastError יוגדר לקוד השגיאה המתאים.

פרמטרים

  • אפשרויות

    NotifyOptions

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 96 ואילך

    קריאה חוזרת (callback) כללית של תוצאה שמציינת הצלחה או כישלון.

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

unmount()

Promise 
chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
  callback?: function,
): Promise<void>

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

אם תהיה שגיאה, הערך של runtime.lastError יוגדר עם קוד השגיאה המתאים.

פרמטרים

  • אפשרויות

    UnmountOptions

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 96 ואילך

    קריאה חוזרת (callback) כללית של תוצאה שמציינת הצלחה או כישלון.

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

אירועים

onAbortRequested

chrome.fileSystemProvider.onAbortRequested.addListener(
  callback: function,
)

מופעל כשמבקשים לבטל פעולה באמצעות operationRequestId. צריך להפסיק מיד את הפעולה שבוצעה עם operationRequestId ולבצע את successCallback של בקשת הביטול הזו. אם הביטול נכשל, צריך לקרוא ל-errorCallback. חשוב לזכור: אין להפעיל קריאות חוזרות (callbacks) של הפעולה שבוטלה, כי המערכת תתעלם מהן. למרות הקריאה ל-errorCallback, יכול להיות שהבקשה תבוטל באופן כפוי.

פרמטרים

  • callback

    פונקציה

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

    (options: AbortRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      AbortRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onAddWatcherRequested

‫Chrome 45 ואילך 
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (options: AddWatcherRequestedOptions, successCallback: function, errorCallback: function) => void

onCloseFileRequested

chrome.fileSystemProvider.onCloseFileRequested.addListener(
  callback: function,
)

מופעל כשמתקבלת בקשה לסגור קובץ שנפתח בעבר באמצעות openRequestId.

פרמטרים

  • callback

    פונקציה

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

    (options: CloseFileRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      CloseFileRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onConfigureRequested

‫Chrome מגרסה 44 ואילך 
chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (options: ConfigureRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      ConfigureRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onCopyEntryRequested

chrome.fileSystemProvider.onCopyEntryRequested.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (options: CopyEntryRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      CopyEntryRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onCreateDirectoryRequested

chrome.fileSystemProvider.onCreateDirectoryRequested.addListener(
  callback: function,
)

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

פרמטרים

onCreateFileRequested

chrome.fileSystemProvider.onCreateFileRequested.addListener(
  callback: function,
)

מופעל כשנשלחת בקשה ליצירת קובץ. אם הקובץ כבר קיים, צריך לקרוא ל-errorCallback עם קוד השגיאה "EXISTS".

פרמטרים

  • callback

    פונקציה

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

    (options: CreateFileRequestedOptions, successCallback: function, errorCallback: function) => void

onDeleteEntryRequested

chrome.fileSystemProvider.onDeleteEntryRequested.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (options: DeleteEntryRequestedOptions, successCallback: function, errorCallback: function) => void

onExecuteActionRequested

‫Chrome מגרסה 48 ואילך 
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

מופעל כשמתבקש ביצוע של פעולה בקבוצה של קבצים או ספריות. אחרי שהפעולה מסתיימת, צריך לקרוא ל-successCallback. אם יש שגיאה, צריך להפעיל את errorCallback.

פרמטרים

  • callback

    פונקציה

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

    (options: ExecuteActionRequestedOptions, successCallback: function, errorCallback: function) => void

onGetActionsRequested

‫Chrome מגרסה 48 ואילך 
chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

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

פרמטרים

onGetMetadataRequested

chrome.fileSystemProvider.onGetMetadataRequested.addListener(
  callback: function,
)

מופעל כשמתקבלת בקשה למטא-נתונים של קובץ או ספרייה ב-entryPath. צריך להחזיר את המטא-נתונים עם הקריאה ל-successCallback. אם יש שגיאה, צריך להפעיל את errorCallback.

פרמטרים

onMountRequested

‫Chrome מגרסה 44 ואילך 
chrome.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

מופעל כשמוצגת בקשה להצגת תיבת דו-שיח לטעינת מערכת קבצים חדשה. אם התוסף או האפליקציה הם handler של קבצים, אין צורך לטפל באירוע הזה. במקום זאת, צריך לטפל ב-app.runtime.onLaunched כדי לטעון מערכות קבצים חדשות כשפותחים קובץ. כדי להגדיר כמה נקודות טעינה, צריך להגדיר את האפשרות file_system_provider.multiple_mounts במניפסט כ-true.

פרמטרים

  • callback

    פונקציה

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

    (successCallback: function, errorCallback: function) => void

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onMoveEntryRequested

chrome.fileSystemProvider.onMoveEntryRequested.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (options: MoveEntryRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      MoveEntryRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onOpenFileRequested

chrome.fileSystemProvider.onOpenFileRequested.addListener(
  callback: function,
)

מופעל כשמתקבלת בקשה לפתוח קובץ ב-filePath. אם הקובץ לא קיים, הפעולה תיכשל. אפשר לציין את המספר המקסימלי של קבצים שנפתחים בבת אחת באמצעות MountOptions.

פרמטרים

onReadDirectoryRequested

chrome.fileSystemProvider.onReadDirectoryRequested.addListener(
  callback: function,
)

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

פרמטרים

onReadFileRequested

chrome.fileSystemProvider.onReadFileRequested.addListener(
  callback: function,
)

מופעל כשמתבקשת קריאת תוכן של קובץ שנפתח בעבר באמצעות openRequestId. התוצאות צריכות להיות מוחזרות בחלקים על ידי קריאה ל-successCallback כמה פעמים. אם יש שגיאה, צריך להפעיל את errorCallback.

פרמטרים

  • callback

    פונקציה

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

    (options: ReadFileRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      ReadFileRequestedOptions

    • successCallback

      פונקציה

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

      (data: ArrayBuffer, hasMore: boolean) => void

      • נתונים

        ArrayBuffer

      • hasMore

        בוליאני

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onRemoveWatcherRequested

‫Chrome 45 ואילך 
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

מופעל כשצריך להסיר את הצופה. אם מתרחשת שגיאה, צריך להפעיל את errorCallback.

פרמטרים

  • callback

    פונקציה

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

    (options: RemoveWatcherRequestedOptions, successCallback: function, errorCallback: function) => void

onTruncateRequested

chrome.fileSystemProvider.onTruncateRequested.addListener(
  callback: function,
)

מופעל כשמתקבלת בקשה לחתוך קובץ לאורך הרצוי. אם מתרחשת שגיאה, צריך להפעיל את errorCallback.

פרמטרים

  • callback

    פונקציה

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

    (options: TruncateRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      TruncateRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onUnmountRequested

chrome.fileSystemProvider.onUnmountRequested.addListener(
  callback: function,
)

מופעל כשמתקבלת בקשה לביטול הטעינה של מערכת הקבצים עם המזהה fileSystemId. בתגובה, צריך להפעיל את ה-method ‏unmount של ה-API יחד עם successCallback. אם אי אפשר לבטל את הטעינה (למשל, בגלל פעולה בהמתנה), צריך לקרוא ל-errorCallback.

פרמטרים

  • callback

    פונקציה

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

    (options: UnmountRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      UnmountRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void

onWriteFileRequested

chrome.fileSystemProvider.onWriteFileRequested.addListener(
  callback: function,
)

מופעל כשמתבקשת כתיבת תוכן לקובץ שנפתח קודם לכן באמצעות openRequestId.

פרמטרים

  • callback

    פונקציה

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

    (options: WriteFileRequestedOptions, successCallback: function, errorCallback: function) => void

    • אפשרויות

      WriteFileRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void