chrome.fileSystemProvider

תאריך הרענון: 2026-09-25 robots: noindex

תיאור

אפשר להשתמש ב-chrome.fileSystemProvider API כדי ליצור מערכות קבצים שאפשר לגשת אליהן ממנהל הקבצים ב-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 of "file", "device", or "network") - חובה
מקור הנתונים של מערכות קבצים שמוצמדות.

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

סקירה כללית

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

הוספת מערכות קבצים

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

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

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

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

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

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

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

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

סוגים

AbortRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • operationRequestId

    number

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

  • requestId

    number

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

Action

‫Chrome 45 ואילך

מאפיינים

  • id [מזהה]

    מחרוזת

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

  • title

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

    שם הפעולה. יכול להיות שהיא לא תפעל בפעולות נפוצות.

AddWatcherRequestedOptions

מאפיינים

  • entryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    בוליאני

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

  • requestId

    number

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

Change

מאפיינים

  • changeType

    ChangeType

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

  • cloudFileInfo

    ‫CloudFileInfo optional

    ‫Chrome 125 ואילך

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

  • entryPath

    מחרוזת

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

ChangeType

סוג השינוי שזוהה בספרייה שנבדקה.

ספירה

‫"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.

ספירה

"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 optional

    ‫Chrome 125 ואילך

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

  • cloudIdentifier

    ‫CloudIdentifier optional

    ‫Chrome 117 ואילך

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

  • isDirectory

    ‫boolean אופציונלי

    הערך הוא 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

    ‫boolean אופציונלי

    ‫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, אין הגבלה.

  • קבוע

    ‫boolean אופציונלי

    ‫Chrome 64+‎

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

  • supportsNotifyTag

    ‫boolean אופציונלי

    ‫Chrome 45 ואילך

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

  • ניתן לכתיבה

    ‫boolean אופציונלי

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

MoveEntryRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • requestId

    number

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

  • sourcePath

    מחרוזת

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

  • targetPath

    מחרוזת

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

NotifyOptions

מאפיינים

  • changeType

    ChangeType

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

  • שינויים

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

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

  • fileSystemId

    מחרוזת

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

  • observedPath

    מחרוזת

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

  • רקורסיבי

    בוליאני

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

  • תג

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

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

OpenedFile

מאפיינים

  • filePath

    מחרוזת

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

  • מצב

    OpenFileMode

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

  • openRequestId

    number

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

OpenFileMode

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

ספירה

‫READ

‫WRITE

OpenFileRequestedOptions

מאפיינים

  • filePath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • מצב

    OpenFileMode

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

  • requestId

    number

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

ProviderError

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

ספירה

‫"OK"

‫"FAILED"

‫"IN_USE"

‫"EXISTS"

‫NOT_FOUND

"ACCESS_DENIED"

‫"TOO_MANY_OPENED"

‫"NO_MEMORY"

‫"NO_SPACE"

"NOT_A_DIRECTORY"

‫INVALID_OPERATION

‫"SECURITY"

‫"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

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

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

    (fileSystem: FileSystemInfo) =& gt;void

החזרות

  • Promise<FileSystemInfo>

    ‫Chrome 96 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getAll()

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

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

פרמטרים

  • callback

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

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

    (fileSystems: FileSystemInfo[]) =& gt;void

החזרות

  • Promise<FileSystemInfo[]>

    ‫Chrome 96 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

mount()

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

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

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

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

פרמטרים

  • options

    MountOptions

  • callback

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

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

    () =& gt;void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

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

    התמיכה ב-Promises קיימת רק ב-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 יהיה קוד השגיאה המתאים.

פרמטרים

  • options

    NotifyOptions

  • callback

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

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

    () =& gt;void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

unmount()

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

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

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

פרמטרים

  • options

    UnmountOptions

  • callback

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

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

    () =& gt;void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

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

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

אירועים

onAbortRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: AbortRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

    • successCallback

      פונקציה

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

      () =& gt;void

    • errorCallback

      פונקציה

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

      (error: ProviderError) =& gt;void

onAddWatcherRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: AddWatcherRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

onCloseFileRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: CloseFileRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

onConfigureRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: ConfigureRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

onCopyEntryRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: CopyEntryRequestedOptions, successCallback: function, errorCallback: function) =& gt;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) =& gt;void

onDeleteEntryRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: DeleteEntryRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

onExecuteActionRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: ExecuteActionRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

onGetActionsRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: GetActionsRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

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) =& gt;void

    • successCallback

      פונקציה

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

      () =& gt;void

    • errorCallback

      פונקציה

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

      (error: ProviderError) =& gt;void

onMoveEntryRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: MoveEntryRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

onOpenFileRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: OpenFileRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

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) =& gt;void

    • successCallback

      פונקציה

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

      (data: ArrayBuffer, hasMore: boolean) =& gt;void

      • נתונים

        ArrayBuffer

      • hasMore

        בוליאני

    • errorCallback

      פונקציה

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

      (error: ProviderError) =& gt;void

onRemoveWatcherRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: RemoveWatcherRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

onTruncateRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: TruncateRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

    • successCallback

      פונקציה

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

      () =& gt;void

    • errorCallback

      פונקציה

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

      (error: ProviderError) =& gt;void

onUnmountRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: UnmountRequestedOptions, successCallback: function, errorCallback: function) =& gt;void

    • successCallback

      פונקציה

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

      () =& gt;void

    • errorCallback

      פונקציה

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

      (error: ProviderError) =& gt;void

onWriteFileRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: WriteFileRequestedOptions, successCallback: function, errorCallback: function) =& gt;void