chrome.fileSystemProvider

תיאור

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

הרשאות

fileSystemProvider

זמינות

ChromeOS בלבד

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

{
  "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, יוצג לחצן רענון. הערה: אם אפשר, רצוי להוסיף תמיכה ב'צופים', כך שהשינויים במערכת הקבצים יבואו לידי ביטוי באופן מיידי ואוטומטי.

סקירה כללית

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

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

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

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

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

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

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

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

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

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

סוגים

AbortRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • operationRequestId

    number

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

  • requestId

    number

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

Action

Chrome 45+

מאפיינים

  • id [מזהה]

    מחרוזת

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

  • title

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

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

AddWatcherRequestedOptions

מאפיינים

  • entryPath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • רקורסיבי

    בוליאני

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

  • requestId

    number

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

Change

מאפיינים

  • changeType

    ChangeType

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

  • cloudFileInfo

    CloudFileInfo אופציונלי

    Chrome 125+

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

  • entryPath

    מחרוזת

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

ChangeType

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

Enum

"השתנה"

"נמחק"

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 ואילך

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

  • הוא ספרייה

    ערך בוליאני אופציונלי

    True אם זו ספרייה. יש לספק אם מדובר בבקשה בoptions.

  • mimeType

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

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

  • modificationTime

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

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

  • שם

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

    השם של הרשומה הזו (לא שם הנתיב המלא). הערך לא יכול להכיל תו '/'. עבור הרמה הבסיסית (root) צריך להיות ריק. יש לספק אם מדובר בבקשה ב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 לצפייה בספריות.

  • צופים

    צפייה[]

    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

    מחרוזת

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

  • הוא ספרייה

    בוליאני

    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 ואילך

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

  • supportsNotifyTag

    ערך בוליאני אופציונלי

    Chrome 45+

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

  • ניתן לכתיבה

    ערך בוליאני אופציונלי

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

MoveEntryRequestedOptions

מאפיינים

  • fileSystemId

    מחרוזת

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

  • requestId

    number

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

  • sourcePath

    מחרוזת

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

  • targetPath

    מחרוזת

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

NotifyOptions

מאפיינים

  • changeType

    ChangeType

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

  • שינויים

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

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

  • fileSystemId

    מחרוזת

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

  • observedPath

    מחרוזת

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

  • רקורסיבי

    בוליאני

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

  • תג

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

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

OpenedFile

מאפיינים

  • filePath

    מחרוזת

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

  • מצב

    OpenFileMode

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

  • openRequestId

    number

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

OpenFileMode

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

Enum

"לקרוא"

"כתיבה"

OpenFileRequestedOptions

מאפיינים

  • filePath

    מחרוזת

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

  • fileSystemId

    מחרוזת

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

  • מצב

    OpenFileMode

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

  • requestId

    number

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

ProviderError

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

Enum

"אישור"

"נכשל"

"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

    מחרוזת

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

  • הוא ספרייה

    בוליאני

    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

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

שיטות

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

החזרות

  • הבטחה<Empty>

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

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

notify()

הבטחה 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

החזרות

  • הבטחה<Empty>

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

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

unmount()

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

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

אם יש שגיאה, הפונקציה runtime.lastError תוגדר עם קוד השגיאה התואם.

פרמטרים

  • אפשרויות

    UnmountOptions

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

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

אירועים

onAbortRequested

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

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

פרמטרים

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

    פונקציה

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

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

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

    • אפשרויות

      MoveEntryRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => 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

        בוליאני

    • 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 של ה-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

    • אפשרויות

      WriteFileRequestedOptions

    • successCallback

      פונקציה

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

      () => void

    • errorCallback

      פונקציה

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

      (error: ProviderError) => void