chrome.fileSystemProvider

תיאור

אפשר להשתמש ב-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 של 'קובץ', 'מכשיר' או 'רשת') – חובה
מקור הנתונים למערכות קבצים שמוצמדות.

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

סקירה כללית

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

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

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

כדי לכתוב מערכות קבצים שהן handlers של קבצים (המקור הוא "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

    מחרוזת

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

  • רקורסיבי

    בוליאני

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

  • requestId

    number

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

Change

מאפיינים

  • changeType

    ChangeType

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

  • cloudFileInfo

    ‫CloudFileInfo optional

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

"SHARE"

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

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

  • שינויים

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

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

  • fileSystemId

    מחרוזת

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

  • observedPath

    מחרוזת

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

  • רקורסיבי

    בוליאני

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

  • תג

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

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

OpenedFile

מאפיינים

  • filePath

    מחרוזת

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

  • מצב

    OpenFileMode

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

  • openRequestId

    number

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

OpenFileMode

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

Enum

‫"READ"

"WRITE"

OpenFileRequestedOptions

מאפיינים

  • filePath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • מצב

    OpenFileMode

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

  • requestId

    number

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

ProviderError

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

Enum

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

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

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

  • רקורסיבי

    בוליאני

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

WriteFileRequestedOptions

מאפיינים

  • נתונים

    ArrayBuffer

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

  • fileSystemId

    מחרוזת

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

  • היסט

    number

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

  • openRequestId

    number

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

  • requestId

    number

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

Methods

get()

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

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

פרמטרים

  • fileSystemId

    מחרוזת

החזרות

  • Promise<FileSystemInfo>

    ‫Chrome 96 ואילך

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

getAll()

chrome.fileSystemProvider.getAll(): Promise<FileSystemInfo[]>

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

החזרות

  • Promise<FileSystemInfo[]>

    ‫Chrome 96 ואילך

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

mount()

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

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

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

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

פרמטרים

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

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

notify()

‫Chrome 45 ואילך 
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
): Promise<void>

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

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

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

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

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

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

פרמטרים

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

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

unmount()

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

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

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

פרמטרים

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

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

אירועים

onAbortRequested

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • 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

onConfigureRequested

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

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

פרמטרים

  • callback

    פונקציה

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

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

onCopyEntryRequested

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

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

פרמטרים

  • callback

    פונקציה

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

    (options: CopyEntryRequestedOptions, successCallback: function, errorCallback: function) => 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 manifest כ-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

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

    • 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

onUnmountRequested

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • 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