chrome.fileSystem

תיאור

שימוש ב-API של chrome.fileSystem כדי ליצור, לקרוא, לנווט ולכתוב במערכת הקבצים המקומית של המשתמש. באמצעות ממשק ה-API הזה, אפליקציות Chrome יכולות לקרוא ולכתוב במיקום שהמשתמש בחר. לדוגמה, אפליקציה לעריכת טקסט יכולה להשתמש ב-API כדי לקרוא ולכתוב מסמכים מקומיים. כל הכשלים מקבלים הודעה דרך chrome.runtime.lastError.

הרשאות

fileSystem

זמינות

חזית בלבד

סוגים

AcceptOption

מאפיינים

  • תיאור

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

    זהו טקסט התיאור האופציונלי לאפשרות הזו. אם הוא לא נמצא, המערכת תיצור תיאור באופן אוטומטי. שמכילה בדרך כלל רשימה מורחבת של סיומות חוקיות (למשל, "text/html" יכול להתרחב ל-"*.html, *.htm").

  • תוספים

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

    תוספים לאישור, למשל "jpg", "gif", "crx".

  • mimeTypes

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

    סוגי mime לקבלה, למשל "image/jpeg" או 'audio/* '. אחד מסוג mimeType או תוסף חייב להכיל לפחות רכיב חוקי אחד.

ChooseEntryOptions

מאפיינים

  • מקבל

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

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

  • acceptsAllTypes

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

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

  • acceptsMultiple

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

    הגדרה שקובעת אם לאשר מספר קבצים. האפשרות הזו נתמכת רק עבור openFile ו- openWritableFile. אם היא מוגדרת כ-True, תתבצע קריאה חוזרת לקריאה חוזרת (callback) של ChooseEntry עם רשימת ערכים. אחרת, הוא ייקרא עם ערך יחיד.

  • suggestedName

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

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

  • סוג

    ChooseEntryType אופציונלי

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

ChooseEntryType

Enum

"openFile"
שולח בקשה למשתמש לפתוח קובץ קיים ומחזיר FileEntry ללא הצלחה. החל מגרסה 31 של Chrome, ניתן יהיה לכתוב ב-FileEntry אם יש באפליקציה אפשרות 'כתיבה' הרשאה בקטע 'fileSystem'; אחרת, ה-FileEntry יהיה לקריאה בלבד.

"openWritableFile"
מציג למשתמש בקשה לפתוח קובץ קיים ומחזיר FileEntry שניתן לכתיבה לאחר השלמתו. קריאות מהסוג הזה ייכשלו ויתקבלו שגיאת זמן ריצה אם האפליקציה לא כוללת את הערך 'write'. בקטע 'fileSystem'.

"saveFile"
מציגה למשתמש בקשה לפתוח קובץ קיים או קובץ חדש ומחזירה פעולת FileEntry ניתנת לכתיבה ללא שגיאות. קריאות מהסוג הזה ייכשלו ויתקבל שגיאת זמן ריצה אם האפליקציה לא כוללת את הערך 'write'. בקטע 'fileSystem'.

"openDirectory"
מציגה למשתמש בקשה לפתוח ספרייה ומחזירה את הפקודה DirectoryEntry ללא שגיאות. קריאות שמשתמשות בסוג זה ייכשלו ויתקבל שגיאת זמן ריצה אם האפליקציה לא כוללת 'ספרייה'. תחת 'fileSystem'. אם באפליקציה יש רכיב 'כתיבה' בהרשאה 'fileSystem', ה-DirectoryEntry שהוחזר יהיה ניתן לכתיבה. אחרת, היא תהיה לקריאה בלבד. חדש ב-Chrome 31.

RequestFileSystemOptions

Chrome 44 ואילך

מאפיינים

  • volumeId

    מחרוזת

    המזהה של נפח האחסון המבוקש.

  • ניתן לכתיבה

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

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

Volume

Chrome 44 ואילך

מאפיינים

  • volumeId

    מחרוזת

  • ניתן לכתיבה

    בוליאני

VolumeListChangedEvent

Chrome 44 ואילך

מאפיינים

שיטות

chooseEntry()

chrome.fileSystem.chooseEntry(
  options?: ChooseEntryOptions,
  callback: function,
)

מבקשים מהמשתמש לבחור קובץ או ספרייה.

פרמטרים

  • אפשרויות

    ChooseEntryOptions אופציונלי

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

    פונקציה

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

    (entry?: Entry, fileEntries?: FileEntry[]) => void

    • ערך

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

    • fileEntries

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

getDisplayPath()

הבטחה 
chrome.fileSystem.getDisplayPath(
  entry: Entry,
  callback?: function,
)

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

פרמטרים

  • ערך

    הערך

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

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

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

    (displayPath: string) => void

    • displayPath

      מחרוזת

החזרות

  • Promise<string>

    Chrome 117 ואילך

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

getVolumeList()

הבטחה Chrome מגרסה 44 ואילך 
chrome.fileSystem.getVolumeList(
  callback?: function,
)

הפונקציה מחזירה רשימה של כרכים זמינים של requestFileSystem(). נדרשת הרשאת "fileSystem": {"requestFileSystem"} בקובץ המניפסט. האפשרות הזו זמינה רק לאפליקציות "קיוסק" שפועלות בסשן קיוסק. אם יש שגיאה, הפונקציה volumes לא תוגדר לערך chrome.runtime.lastError.

פרמטרים

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

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

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

    (volumes?: Volume[]) => void

החזרות

  • Promise<Volume[] | לא מוגדר>

    Chrome 117 ואילך

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

getWritableEntry()

chrome.fileSystem.getWritableEntry(
  entry: Entry,
  callback: function,
)

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

פרמטרים

  • ערך

    הערך

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

    פונקציה

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

    (entry: Entry) => void

    • ערך

      הערך

isRestorable()

הבטחה 
chrome.fileSystem.isRestorable(
  id: string,
  callback?: function,
)

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

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

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

    (isRestorable: boolean) => void

    • isRestorable

      בוליאני

החזרות

  • Promise<boolean>

    Chrome 117 ואילך

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

isWritableEntry()

הבטחה 
chrome.fileSystem.isWritableEntry(
  entry: Entry,
  callback?: function,
)

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

פרמטרים

  • ערך

    הערך

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

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

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

    (isWritable: boolean) => void

    • isWritable

      בוליאני

החזרות

  • Promise<boolean>

    Chrome 117 ואילך

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

requestFileSystem()

הבטחה Chrome מגרסה 44 ואילך 
chrome.fileSystem.requestFileSystem(
  options: RequestFileSystemOptions,
  callback?: function,
)

מבקשת גישה למערכת קבצים לנפח שמיוצג על ידי options.volumeId. אם המדיניות options.writable מוגדרת כ-True, מערכת הקבצים תהיה ניתנת לכתיבה. אחרת, היא תהיה לקריאה בלבד. לאפשרות writable נדרשת ההרשאה "fileSystem": {"write"} במניפסט. האפשרות הזו זמינה רק לאפליקציות "קיוסק" שפועלות בסשן קיוסק. במצב קיוסק להפעלה ידנית, תוצג תיבת דו-שיח לאישור בחלק העליון של חלון האפליקציה הפעילה. אם יש שגיאה, הפונקציה fileSystem לא תוגדר לערך chrome.runtime.lastError.

פרמטרים

  • אפשרויות

    RequestFileSystemOptions

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

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

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

    (fileSystem?: FileSystem) => void

    • fileSystem

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

החזרות

  • Promise<FileSystem | לא מוגדר>

    Chrome 117 ואילך

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

restoreEntry()

chrome.fileSystem.restoreEntry(
  id: string,
  callback: function,
)

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

    פונקציה

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

    (entry: Entry) => void

    • ערך

      הערך

retainEntry()

chrome.fileSystem.retainEntry(
  entry: Entry,
)

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

פרמטרים

  • ערך

    הערך

החזרות

  • מחרוזת

אירועים

onVolumeListChanged

Chrome 44 ואילך 
chrome.fileSystem.onVolumeListChanged.addListener(
  callback: function,
)

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

פרמטרים