chrome.fileSystemProvider

תיאור

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

הרשאות

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 (ספירה של "file", "device" או "network") - חובה
מקור הנתונים של מערכות קבצים טעונות.

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

סקירה כללית

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

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

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

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

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

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

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

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

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

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

סוגים

AbortRequestedOptions

תכונות

  • fileSystemId

    מחרוזת

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

  • operationRequestId

    מספר

    המזהה של הבקשה לביטול.

  • requestId

    מספר

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

Action

Chrome 45 ואילך

תכונות

  • id

    מחרוזת

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

  • title

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

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

AddWatcherRequestedOptions

תכונות

  • entryPath

    מחרוזת

    נתיב הכניסה שיש לבדוק.

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    boolean

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

  • requestId

    מספר

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

Change

תכונות

  • changeType

    ChangeType

    סוג השינוי שהתרחש לרשומה.

  • cloudFileInfo

    CloudFileInfo אופציונלי

    בהמתנה

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

  • entryPath

    מחרוזת

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

ChangeType

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

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

CloseFileRequestedOptions

תכונות

  • fileSystemId

    מחרוזת

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

  • openRequestId

    מספר

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

  • requestId

    מספר

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

CloudFileInfo

בהמתנה

תכונות

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

ConfigureRequestedOptions

Chrome 44 ואילך

תכונות

  • fileSystemId

    מחרוזת

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

  • requestId

    מספר

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

CopyEntryRequestedOptions

תכונות

  • fileSystemId

    מחרוזת

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

  • requestId

    מספר

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

  • sourcePath

    מחרוזת

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

  • targetPath

    מחרוזת

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

CreateDirectoryRequestedOptions

תכונות

  • directoryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    boolean

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

  • requestId

    מספר

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

CreateFileRequestedOptions

תכונות

  • filePath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • requestId

    מספר

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

DeleteEntryRequestedOptions

תכונות

  • entryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    boolean

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

  • requestId

    מספר

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

EntryMetadata

תכונות

  • cloudFileInfo

    CloudFileInfo אופציונלי

    בהמתנה

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

  • cloudIdentifier

    CloudIdentifier אופציונלי

    Chrome 117 ומעלה

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

  • isDirectory

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

    True אם זו ספרייה. אם נדרש, יש לספק את הערך הזה בoptions.

  • mimeType

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

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

  • modificationTime

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

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

  • name

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

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

  • size

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

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

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

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

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

ExecuteActionRequestedOptions

Chrome 45 ואילך

תכונות

  • actionId

    מחרוזת

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

  • entryPaths

    מחרוזת[]

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

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

  • fileSystemId

    מחרוזת

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

  • requestId

    מספר

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

FileSystemInfo

תכונות

  • displayName

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • openedFiles

    OpenedFile[]

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

  • openedFilesLimit

    מספר

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

  • supportsNotifyTag

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

    Chrome 45 ואילך

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

  • צופים

    צופים[]

    Chrome 45 ואילך

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

  • ניתן לכתיבה

    boolean

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

GetActionsRequestedOptions

Chrome 45 ואילך

תכונות

  • entryPaths

    מחרוזת[]

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

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

  • fileSystemId

    מחרוזת

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

  • requestId

    מספר

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

GetMetadataRequestedOptions

תכונות

  • cloudFileInfo

    boolean

    בהמתנה

    מוגדר לערך true אם התבקש ערך cloudFileInfo.

  • cloudIdentifier

    boolean

    Chrome 117 ומעלה

    מוגדר לערך true אם התבקש ערך cloudIdentifier.

  • entryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • isDirectory

    boolean

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

    מוגדר לערך true אם התבקש ערך is_directory.

  • mimeType

    boolean

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

    מוגדר לערך true אם התבקש ערך mimeType.

  • modificationTime

    boolean

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

    מוגדר לערך true אם התבקש ערך modificationTime.

  • name

    boolean

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

    מוגדר לערך true אם התבקש ערך name.

  • requestId

    מספר

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

  • size

    boolean

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

    מוגדר לערך true אם התבקש ערך size.

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

    boolean

    מוגדר לערך true אם התבקש ערך thumbnail.

MountOptions

תכונות

  • displayName

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • openedFilesLimit

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

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

  • מתמיד

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

    Chrome 64 ומעלה

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

  • supportsNotifyTag

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

    Chrome 45 ואילך

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

  • ניתן לכתיבה

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

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

MoveEntryRequestedOptions

תכונות

  • fileSystemId

    מחרוזת

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

  • requestId

    מספר

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

  • sourcePath

    מחרוזת

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

  • targetPath

    מחרוזת

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

NotifyOptions

תכונות

  • changeType

    ChangeType

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

  • שינויים

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

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

  • fileSystemId

    מחרוזת

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

  • observedPath

    מחרוזת

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

  • רקורסיבי

    boolean

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

  • תג

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

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

OpenedFile

תכונות

  • filePath

    מחרוזת

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

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

    OpenFileMode

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

  • openRequestId

    מספר

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

OpenFileMode

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

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

"READ"

OpenFileRequestedOptions

תכונות

  • filePath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

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

    OpenFileMode

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

  • requestId

    מספר

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

ProviderError

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

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

"IN_USE"

"EXISTS"

"NOT_FOUND"

"ACCESS_DENIED"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NO_SPACE"

"NOT_A_DIRECTORY"

"INVALID_OPERATION"

"NOT_A_FILE"

"NOT_EMPTY"

"INVALID_URL"

"IO"

ReadDirectoryRequestedOptions

תכונות

  • directoryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • isDirectory

    boolean

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

    מוגדר לערך true אם התבקש ערך is_directory.

  • mimeType

    boolean

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

    מוגדר לערך true אם התבקש ערך mimeType.

  • modificationTime

    boolean

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

    מוגדר לערך true אם התבקש ערך modificationTime.

  • name

    boolean

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

    מוגדר לערך true אם התבקש ערך name.

  • requestId

    מספר

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

  • size

    boolean

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

    מוגדר לערך true אם התבקש ערך size.

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

    boolean

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

    מוגדר לערך true אם התבקש ערך thumbnail.

ReadFileRequestedOptions

תכונות

  • fileSystemId

    מחרוזת

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

  • length

    מספר

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

  • היסט

    מספר

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

  • openRequestId

    מספר

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

  • requestId

    מספר

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

RemoveWatcherRequestedOptions

תכונות

  • entryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    boolean

    מצב הצופה.

  • requestId

    מספר

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

TruncateRequestedOptions

תכונות

  • filePath

    מחרוזת

    נתיב הקובץ לחיתוך.

  • fileSystemId

    מחרוזת

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

  • length

    מספר

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

  • requestId

    מספר

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

UnmountOptions

תכונות

  • fileSystemId

    מחרוזת

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

UnmountRequestedOptions

תכונות

  • fileSystemId

    מחרוזת

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

  • requestId

    מספר

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

Watcher

תכונות

  • entryPath

    מחרוזת

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

  • lastTag

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

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

  • רקורסיבי

    boolean

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

WriteFileRequestedOptions

תכונות

  • נתונים

    ArrayBuffer

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

  • fileSystemId

    מחרוזת

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

  • היסט

    מספר

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

  • openRequestId

    מספר

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

  • requestId

    מספר

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

שיטות

get()

הבטחה 
chrome.fileSystemProvider.get(
  fileSystemId: string,
  callback?: function,
)

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

פרמטרים

  • fileSystemId

    מחרוזת

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

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

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

    (fileSystem: FileSystemInfo)=>void

החזרות

  • Promise<FileSystemInfo>

    Chrome 96 ומעלה

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

getAll()

הבטחה 
chrome.fileSystemProvider.getAll(
  callback?: function,
)

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

פרמטרים

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

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

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

    (fileSystems: FileSystemInfo[])=>void

החזרות

  • Promise<FileSystemInfo[]>

    Chrome 96 ומעלה

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

mount()

הבטחה 
chrome.fileSystemProvider.mount(
  options: MountOptions,
  callback?: function,
)

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

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

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

פרמטרים

  • אפשרויות

    MountOptions

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 96 ומעלה

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

notify()

Promise Chrome 45 ואילך 
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
  callback?: function,
)

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

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

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

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

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

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

פרמטרים

  • אפשרויות

    NotifyOptions

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 96 ומעלה

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

unmount()

הבטחה 
chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
  callback?: function,
)

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

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

פרמטרים

  • אפשרויות

    UnmountOptions

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 96 ומעלה

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

אירועים

onAbortRequested

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

מוצגת בקשה להגדלה כשמבטלים פעולה עם operationRequestId. יש להפסיק מיד את הפעולה שבוצעה באמצעות operationRequestId ולבצע successCallback מתוך בקשת הביטול. אם הביטול נכשל, יש לקרוא לפונקציה errorCallback. הערה: אין לקרוא לקריאות חוזרות (callback) של הפעולה שבוטלה, כי המערכת תתעלם מהן. למרות הקריאה ל-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

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 נכון, והרשומה היא ספרייה, יש למחוק באופן רקורסיבי גם את כל הרשומות שבתוכה.

פרמטרים

  • קריאה חוזרת (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.

פרמטרים

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

    פונקציה

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

    (options: GetActionsRequestedOptions,successCallback: function,errorCallback: function)=>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)=>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.

פרמטרים

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

    פונקציה

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

    (options: OpenFileRequestedOptions,successCallback: function,errorCallback: function)=>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)=>void

    • אפשרויות

      ReadFileRequestedOptions

    • successCallback

      פונקציה

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

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

      • נתונים

        ArrayBuffer

      • hasMore

        boolean

    • 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 של ה-API unmount ביחד עם 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