الوصف
استخدِم واجهة برمجة التطبيقات chrome.fileSystemProvider
API لإنشاء أنظمة الملفات التي يمكن الوصول إليها من مدير الملفات على نظام التشغيل Chrome.
الأذونات
fileSystemProvider
مدى التوفّر
يجب تعريف إذن وقسم "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
(منطقية) - اختيارية- ما إذا كانت عملية الضبط من خلال onConfigureRequest متاحة أم لا. الإعداد التلقائي: "خطأ".
multiple_mounts
(منطقية) - اختيارية- ما إذا كانت أنظمة الملفات المُثبَّتة متعددة (أكثر من نظام واحد) متوافقة. الإعداد التلقائي: "خطأ".
watchable
(منطقية) - اختيارية- ما إذا كان إعداد المشاهدين وإرسال إشعارات بشأن التغييرات متاحة أم لا. الإعداد التلقائي: "خطأ".
source
(تعداد "الملف" أو "الجهاز" أو "الشبكة") - مطلوبة- مصدر البيانات لأنظمة الملفات المثبّتة
يستخدم تطبيق الملفات المعلومات المذكورة أعلاه لعرض عناصر واجهة المستخدم ذات الصلة بشكل مناسب. على سبيل المثال، إذا تم ضبط configurable
على "صحيح"، سيتم عرض عنصر قائمة لضبط وحدات الحجم. وبالمثل، في حال ضبط multiple_mounts
على true
، سيسمح تطبيق Files بإضافة أكثر من نقطة تثبيت واحدة من واجهة المستخدم. إذا كانت قيمة السمة watchable
هي false
، سيتم عرض زر إعادة التحميل. وتجدُر الإشارة إلى أنّه يجب توفير الدعم للمشاهدين إن أمكن، لكي تظهر التغييرات التي تطرأ على نظام الملفات على الفور وبشكل تلقائي.
نظرة عامة
تسمح واجهة برمجة التطبيقات File System Provider API بالإضافات إلى إتاحة أنظمة الملفات الافتراضية المتاحة في مدير الملفات على نظام التشغيل ChromeOS. تشمل حالات الاستخدام فك ضغط الأرشيفات والوصول إلى الملفات في خدمة سحابة إلكترونية أخرى غير Drive.
تثبيت أنظمة الملفات
ويمكن أن يوفّر توفير الامتدادات إما محتوى نظام الملفات من مصدر خارجي (مثل خادم بعيد أو جهاز USB) أو استخدام ملف محلي (مثل أرشيف) كإدخال له.
لكتابة أنظمة الملفات التي تمثّل معالِجات ملفات (المصدر هو "file"
)، يجب أن يكون مقدّم الخدمة تطبيقًا مجمّعًا، لأنّ الحدث onLaunched
غير متاح للإضافات.
إذا كان المصدر عبارة عن شبكة أو جهاز، يجب تثبيت نظام الملفات عند استدعاء حدث onMountRequested.
مصدر بيانات نظام الملفات | نقطة الإدخال |
---|---|
"file" |
يتوفّر هذا الخيار للتطبيقات المجمّعة فقط. |
"device" أو "network" |
onMountRequested |
تكوين أنظمة الملفات
يمكن ضبط أنظمة الملفات المقدَّمة بعد تحميلها من خلال الحدث onConfigureRequested. وهو مفيد بشكل خاص لأنظمة الملفات التي توفر المحتوى عبر الشبكة لتعيين بيانات الاعتماد المناسبة. إنّ معالجة هذا الحدث اختيارية.
رحلة المستخدِم
يتذكر Chrome أنظمة الملفات المقدمة بمجرد تثبيتها وتتم إعادة تحميلها تلقائيًا بعد إعادة التشغيل أو إعادة التشغيل. وبالتالي، بعد تثبيت نظام الملفات من خلال الإضافة التي تقدّم، سيظلّ متوفّرًا إلى أن يتم إلغاء تحميل الإضافة أو تستدعي الإضافة طريقة إلغاء التثبيت.
الأنواع
AbortRequestedOptions
أماكن إقامة
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
operationRequestId
الرقم
رقم تعريف الطلب المراد الإلغاء
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
Action
أماكن إقامة
-
id
سلسلة
معرّف الإجراء. أي سلسلة أو
CommonActionId
للإجراءات الشائعة. -
title
سلسلة اختيارية
تمثّل هذه السمة عنوان الإجراء. وقد يتم تجاهله بسبب الإجراءات الشائعة.
AddWatcherRequestedOptions
أماكن إقامة
-
entryPath
سلسلة
تمثّل هذه السمة مسار الإدخال المطلوب ملاحظته.
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
المتكرر
boolean
لتحديد ما إذا كانت الملاحظة يجب أن تتضمن جميع الإدخالات الثانوية بشكل متكرر. وقد ينطبق ذلك على الأدلة فقط.
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
Change
أماكن إقامة
-
changeType
نوع التغيير الذي حدث للإدخال.
-
cloudFileInfo
CloudFileInfo اختيارية
Chrome 125 والإصدارات الأحدثتشير هذه السمة إلى معلومات ذات صلة بالملف في حال دعمه من خلال نظام ملفات سحابي.
-
entryPath
سلسلة
مسار الإدخال الذي تم تغييره.
ChangeType
نوع التغيير الذي تم رصده في الدليل الذي تم رصده
التعداد
CloseFileRequestedOptions
أماكن إقامة
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
openRequestId
الرقم
معرّف طلب يتم استخدامه لفتح الملف.
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
CloudFileInfo
أماكن إقامة
-
versionTag
سلسلة اختيارية
علامة تمثل إصدار الملف.
CloudIdentifier
أماكن إقامة
-
id
سلسلة
معرّف موفِّر الملف أو الدليل المحدَّد
-
providerName
سلسلة
معرّف لمقدّم مساحة التخزين في السحابة الإلكترونية (على سبيل المثال، "drive.google.com").
CommonActionId
قائمة بالإجراءات الشائعة التطبيق "SHARE"
مخصّص لمشاركة الملفات مع الآخرين. "SAVE_FOR_OFFLINE"
للتثبيت (الحفظ للوصول بلا اتصال بالإنترنت). "OFFLINE_NOT_NECESSARY"
للإشعار بأن الملف لا يلزم تخزينه للوصول إليه بلا اتصال بالإنترنت بعد الآن. مُستخدمة في onGetActionsRequested
وonExecuteActionRequested
.
التعداد
"SAVE_FOR_OFFLINE"
"OFFLINE_NOT_NECESSARY"
ConfigureRequestedOptions
أماكن إقامة
-
fileSystemId
سلسلة
معرّف نظام الملفات المراد إعداده.
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
CopyEntryRequestedOptions
أماكن إقامة
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
-
sourcePath
سلسلة
مسار المصدر للإدخال المطلوب نسخه.
-
targetPath
سلسلة
المسار الوجهة لعملية النسخ.
CreateDirectoryRequestedOptions
أماكن إقامة
-
directoryPath
سلسلة
مسار الدليل المراد إنشاؤه.
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
المتكرر
boolean
ما إذا كانت العملية متكررة (للأدلة فقط)
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
CreateFileRequestedOptions
أماكن إقامة
-
filePath
سلسلة
مسار الملف المراد إنشاؤه.
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
DeleteEntryRequestedOptions
أماكن إقامة
-
entryPath
سلسلة
مسار الإدخال المطلوب حذفه.
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
المتكرر
boolean
ما إذا كانت العملية متكررة (للأدلة فقط)
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
EntryMetadata
أماكن إقامة
-
cloudFileInfo
CloudFileInfo اختيارية
Chrome 125 والإصدارات الأحدثيشير ذلك المصطلح إلى معلومات تحدِّد ملفًا معيّنًا في النظام الأساسي للملفات على السحابة الإلكترونية. يجب توفيره إذا تم طلبه في
options
، وأن يكون الملف محميًا في التخزين في السحابة الإلكترونية. -
cloudIdentifier
CloudIdentifier اختياري
Chrome 117 والإصدارات الأحدثتمثيل Cloud Storage لهذا الإدخال يجب توفيره إذا تم طلبه في
options
، وأن يكون الملف محميًا في التخزين في السحابة الإلكترونية. بالنسبة إلى الملفات المحلية التي لا يدعمها التخزين في السحابة الإلكترونية، يجب أن تكون غير محددة عند طلبها. -
isDirectory
منطقية اختيارية
True إذا كان دليلاً. يجب توفير هذه السمة إذا تم طلبها في
options
. -
mimeType
سلسلة اختيارية
نوع MIME للإدخال. اختيارية دائمًا، ولكن يجب تقديمها عند طلبها في
options
. -
modificationTime
التاريخ اختياري
وقت آخر تعديل لهذا الإدخال. يجب توفير هذه السمة إذا تم طلبها في
options
. -
اسم
سلسلة اختيارية
اسم هذا الإدخال (وليس اسم المسار الكامل). يجب ألا يحتوي على "/". بالنسبة إلى الجذر، يجب أن يكون فارغًا. يجب توفير هذه السمة إذا تم طلبها في
options
. -
الحجم
الرقم اختياري
حجم الملف بالبايت يجب توفير هذه السمة إذا تم طلبها في
options
. -
thumbnail
سلسلة اختيارية
صورة مصغّرة على شكل معرّف موارد منتظم (URI) للبيانات بتنسيق PNG أو JPEG أو WEBP بحجم 32 كيلوبايت كحد أقصى اختيارية، ولكن لا يمكن تقديمها إلا عندما يطلبها حدث
onGetMetadataRequested
صراحةً.
ExecuteActionRequestedOptions
أماكن إقامة
-
actionId
سلسلة
معرّف الإجراء المراد تنفيذه.
-
entryPaths
سلسلة[]
Chrome 47 والإصدارات الأحدثمجموعة مسارات الإدخالات التي سيتم استخدامها للإجراء.
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
FileSystemInfo
أماكن إقامة
-
displayName
سلسلة
اسم لنظام الملفات يمكن لشخص عادي قراءته.
-
fileSystemId
سلسلة
معرّف نظام الملفات.
-
openedFiles
قائمة بالملفات المفتوحة حاليًا.
-
openedFilesLimit
الرقم
الحدّ الأقصى لعدد الملفات التي يمكن فتحها في آنٍ واحد إذا كانت القيمة 0، فلا يكون محدودًا.
-
supportsNotifyTag
منطقية اختيارية
Chrome 45 والإصدارات الأحدثما إذا كان نظام الملفات يسمح بالحقل
tag
لملاحظة الأدلة. -
المشاهدون
مُشاهد[]
Chrome 45 والإصدارات الأحدثقائمة بالمشاهدين
-
قابل للكتابة
boolean
ما إذا كان نظام الملفات يدعم العمليات التي قد تؤدي إلى تغيير محتوى نظام الملفات (مثل إنشاء الملفات أو حذفها أو الكتابة إليها)
GetActionsRequestedOptions
أماكن إقامة
-
entryPaths
سلسلة[]
Chrome 47 والإصدارات الأحدثقائمة مسارات الإدخالات لقائمة الإجراءات.
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
GetMetadataRequestedOptions
أماكن إقامة
-
cloudFileInfo
boolean
Chrome 125 والإصدارات الأحدثويجب ضبط القيمة على
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
. -
اسم
boolean
Chrome 49 والإصدارات الأحدثويجب ضبط القيمة على
true
في حال طلب قيمةname
. -
requestId
الرقم
المعرّف الفريد لهذا الطلب.
-
الحجم
boolean
Chrome 49 والإصدارات الأحدثويجب ضبط القيمة على
true
في حال طلب قيمةsize
. -
thumbnail
boolean
ويجب ضبط القيمة على
true
في حال طلب قيمةthumbnail
.
MountOptions
أماكن إقامة
-
displayName
سلسلة
اسم لنظام الملفات يمكن لشخص عادي قراءته.
-
fileSystemId
سلسلة
مُعرّف السلسلة لنظام الملفات. يجب أن يكون فريدًا لكل إضافة.
-
openedFilesLimit
الرقم اختياري
الحدّ الأقصى لعدد الملفات التي يمكن فتحها في آنٍ واحد إذا لم يتم تحديده، أو 0، فلا يكون محدودًا.
-
ثابت
منطقية اختيارية
الإصدار 64 من Chrome والإصدارات الأحدثما إذا كان يجب أن يستأنف إطار العمل نظام الملفات في جلسة تسجيل الدخول التالية. صحيح بشكل تلقائي.
-
supportsNotifyTag
منطقية اختيارية
Chrome 45 والإصدارات الأحدثما إذا كان نظام الملفات يتيح استخدام الحقل
tag
للأدلة التي يتم تتبّعها -
قابل للكتابة
منطقية اختيارية
ما إذا كان نظام الملفات يدعم العمليات التي قد تؤدي إلى تغيير محتوى نظام الملفات (مثل إنشاء الملفات أو حذفها أو الكتابة إليها)
MoveEntryRequestedOptions
أماكن إقامة
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
requestId
الرقم
المعرّف الفريد لهذا الطلب.
-
sourcePath
سلسلة
سيتم نقل مسار المصدر للإدخال إلى مكان جديد.
-
targetPath
سلسلة
المسار الوجهة لعملية النسخ.
NotifyOptions
أماكن إقامة
-
changeType
نوع التغيير الذي حدث على الإدخال المرصود إذا تم حذفه، ستتم إزالة الإدخال الذي تم رصده تلقائيًا من قائمة الإدخالات المرصودة.
-
التغييرات
تغيير[] اختياري
قائمة التغييرات التي تم إجراؤها على الإدخالات ضمن الدليل الذي تم رصده (بما في ذلك الإدخال نفسه)
-
fileSystemId
سلسلة
معرّف نظام الملفات المرتبط بهذا التغيير
-
observedPath
سلسلة
تمثّل هذه السمة مسار الإدخال الذي تم رصده.
-
المتكرر
boolean
وضع الإدخال الذي تم رصده
-
العلامة
سلسلة اختيارية
علامة للإشعار. هذا الإجراء مطلوب إذا تم تثبيت نظام الملفات باستخدام الخيار
supportsNotifyTag
. تجدر الإشارة إلى أنّ هذه العلامة ضرورية لتقديم إشعارات بشأن التغييرات التي طرأت حتى في حال إيقاف النظام.
OpenedFile
أماكن إقامة
-
filePath
سلسلة
مسار الملف المفتوح.
-
الوضع
تُستخدَم لتحديد ما إذا تم فتح الملف للقراءة أو الكتابة.
-
openRequestId
الرقم
معرّف طلب يُستخدَم من خلال طلبات القراءة/الكتابة المتتالية والإغلاق.
OpenFileMode
وضع فتح الملف يتم الاستخدام في onOpenFileRequested
.
التعداد
OpenFileRequestedOptions
أماكن إقامة
-
filePath
سلسلة
مسار الملف المراد فتحه.
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
الوضع
تحدّد هذه السمة ما إذا كان سيتم استخدام الملف للقراءة أو الكتابة.
-
requestId
الرقم
معرّف طلب سيتم استخدامه من خلال الطلبات المتتالية للقراءة/الكتابة والإغلاق.
ProviderError
رموز الخطأ التي يتم استخدامها من خلال تقديم إضافات استجابةً للطلبات وكذلك في حال حدوث أخطاء عند استدعاء طرق من واجهة برمجة التطبيقات. لتحقيق النجاح، يجب استخدام "OK"
.
التعداد
"EXISTS"
"NOT_FOUND"
"ACCESS_DENIED"
"TOO_MANY_OPENED"
"NO_MEMORY"
"NO_SPACE"
"NOT_A_DIRECTORY"
"NOT_A_FILE"
"NOT_EMPTY"
"IO"
ReadDirectoryRequestedOptions
أماكن إقامة
-
directoryPath
سلسلة
مسار الدليل الذي يطلب المحتوى
-
fileSystemId
سلسلة
تمثّل هذه السمة معرّف نظام الملفات المرتبط بهذه العملية.
-
isDirectory
boolean
Chrome 49 والإصدارات الأحدثويجب ضبط القيمة على
true
في حال طلب قيمةis_directory
. -
mimeType
boolean
Chrome 49 والإصدارات الأحدثويجب ضبط القيمة على
true
في حال طلب قيمةmimeType
. -
modificationTime
boolean
Chrome 49 والإصدارات الأحدثويجب ضبط القيمة على
true
في حال طلب قيمةmodificationTime
. -
اسم
boolean
Chrome 49 والإصدارات الأحدثويجب ضبط القيمة على
true
في حال طلب قيمةname
. -
requestId
الرقم
المعرّف الفريد لهذا الطلب.
-
الحجم
boolean
Chrome 49 والإصدارات الأحدثويجب ضبط القيمة على
true
في حال طلب قيمةsize
. -
thumbnail
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
على النحو التالي:(fileSystem: FileSystemInfo) => void
-
fileSystem
-
المرتجعات
-
Promise<FileSystemInfo>
Chrome 96 والإصدارات الأحدثتتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.
getAll()
chrome.fileSystemProvider.getAll(
callback?: function,
)
تعرض جميع أنظمة الملفات التي ثبّتها الإضافة.
المَعلمات
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:(fileSystems: FileSystemInfo[]) => void
-
fileSystems
-
المرتجعات
-
Promise<FileSystemInfo[]>
Chrome 96 والإصدارات الأحدثتتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.
mount()
chrome.fileSystemProvider.mount(
options: MountOptions,
callback?: function,
)
تثبيت نظام ملفات بالسمتَين fileSystemId
وdisplayName
المحدَّدين سيتم عرض displayName
في اللوحة اليمنى من تطبيق "الملفات". يمكن أن يحتوي displayName
على أي أحرف تشمل "/"، ولكن لا يمكن أن يكون سلسلة فارغة. يجب أن يكون displayName
وصفيًا ولكن ليس بالضرورة أن يكون فريدًا. يجب ألا تكون قيمة الحقل "fileSystemId
" سلسلة فارغة.
بناءً على نوع نظام الملفات الذي يتم تحميله، يجب ضبط الخيار source
بشكل صحيح.
في حال حدوث خطأ، سيتم ضبط runtime.lastError
باستخدام رمز الخطأ المقابل.
المَعلمات
-
الخيارات
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 96 والإصدارات الأحدثتتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.
notify()
chrome.fileSystemProvider.notify(
options: NotifyOptions,
callback?: function,
)
لإرسال إشعار بشأن التغييرات في الدليل الذي تمت مشاهدته على observedPath
في وضع recursive
. إذا تم تثبيت نظام الملفات باستخدام supportsNotifyTag
، يجب تقديم tag
بالإضافة إلى جميع التغييرات منذ آخر إشعار يتم الإبلاغ عنه دائمًا، حتى في حال إيقاف النظام. يمكن الحصول على آخر علامة باستخدام getAll
.
للاستخدام، يجب ضبط خيار البيان file_system_provider.notify
على "صحيح".
يمكن أن تكون قيمة tag
أي سلسلة فريدة لكل مكالمة، لذا من الممكن تحديد آخر إشعار مسجَّل. على سبيل المثال، إذا بدأت الإضافة التي تم توفيرها بعد إعادة التشغيل، وكانت آخر علامة إشعار تم تسجيلها تساوي "123"، من المفترض أن تستدعي الإضافة notify
لجميع التغييرات التي حدثت منذ التغيير الذي تم وضع علامة "123" عليه. لا يمكن أن تكون سلسلة فارغة.
لا يمكن لبعض الموفرين تقديم علامة، ولكن إذا كان نظام الملفات يحتوي على سجل تغييرات، يمكن أن تكون العلامة على سبيل المثال رقم تغيير أو رقم مراجعة.
يُرجى ملاحظة أنّه في حال إزالة دليل رئيسي، ستتم أيضًا إزالة جميع الإدخالات الفرعية، وإذا تمت مشاهدتها، يجب إرسال إشعار إلى واجهة برمجة التطبيقات بشأن ذلك. كذلك، إذا تمت إعادة تسمية دليل، فستتم إزالة جميع الإدخالات التابعة في الواقع، نظرًا لعدم وجود إدخال ضمن مساراتها الأصلية بعد الآن.
في حال حدوث خطأ، سيتم ضبط runtime.lastError
على رمز الخطأ المقابل.
المَعلمات
-
الخيارات
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 96 والإصدارات الأحدثتتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.
unmount()
chrome.fileSystemProvider.unmount(
options: UnmountOptions,
callback?: function,
)
لإلغاء تثبيت نظام ملفات باستخدام السمة fileSystemId
المحدّدة. ويجب طلبها بعد استدعاء onUnmountRequested
. ويمكن أيضًا أن تقرِّر الإضافة التي تقدِّمها عملية إلغاء التثبيت إذا لم يتم طلبها (على سبيل المثال، في حال فقدان الاتصال أو حدوث خطأ في ملف).
في حال حدوث خطأ، سيتم ضبط runtime.lastError
باستخدام رمز الخطأ المقابل.
المَعلمات
-
الخيارات
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 96 والإصدارات الأحدثتتوفّر الوعود في إصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير عمليات معاودة الاتصال من أجل التوافق مع الأنظمة القديمة. لا يمكنك استخدام كليهما في نفس استدعاء الدالة. يتم حل الوعد بنفس النوع الذي يتم تمريره إلى معاودة الاتصال.
فعاليات
onAbortRequested
chrome.fileSystemProvider.onAbortRequested.addListener(
callback: function,
)
يتم رفعه عند إلغاء عملية مع operationRequestId
. يجب إيقاف العملية التي يتم تنفيذها باستخدام operationRequestId
على الفور وتنفيذ successCallback
من طلب الإلغاء هذا. في حال تعذَّر الإلغاء، يجب طلب "errorCallback
". تجدر الإشارة إلى أنّه يجب عدم استدعاء عمليات معاودة الاتصال للعملية المُلغاة، لأنّه سيتم تجاهلها. على الرغم من الاتصال بـ errorCallback
، قد يتم إلغاء الطلب قسرًا.
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: AbortRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onAddWatcherRequested
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
callback: function,
)
يتم رفعه عند طلب ضبط مُشاهد جديد للدليل. في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: AddWatcherRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onCloseFileRequested
chrome.fileSystemProvider.onCloseFileRequested.addListener(
callback: function,
)
تم رفع المستوى عند فتح ملف تم فتحه سابقًا باستخدام openRequestId
، ويتم طلب إغلاقه.
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: CloseFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onConfigureRequested
chrome.fileSystemProvider.onConfigureRequested.addListener(
callback: function,
)
تم رفع المستوى عند إظهار مربّع حوار ضبط fileSystemId
. في حال معالجتها، يجب ضبط خيار تحديد file_system_provider.configurable
على "صحيح".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: ConfigureRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onCopyEntryRequested
chrome.fileSystemProvider.onCopyEntryRequested.addListener(
callback: function,
)
يتم رفعها عند نسخ إدخال (بشكل متكرر في حال طلب دليل). في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: CopyEntryRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onCreateDirectoryRequested
chrome.fileSystemProvider.onCreateDirectoryRequested.addListener(
callback: function,
)
يتم رفعه عند إنشاء دليل. يجب أن تفشل العملية مع خطأ EXISTS إذا كان الدليل الهدف موجودًا بالفعل. إذا كان recursive
صحيحًا، يجب عندها إنشاء جميع الأدلة المفقودة في مسار الدليل.
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: CreateDirectoryRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onCreateFileRequested
chrome.fileSystemProvider.onCreateFileRequested.addListener(
callback: function,
)
يتم رفعه عند إنشاء ملف. إذا كان الملف متوفّرًا من قبل، يجب استدعاء errorCallback
مع عرض رمز الخطأ "EXISTS"
.
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: CreateFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onDeleteEntryRequested
chrome.fileSystemProvider.onDeleteEntryRequested.addListener(
callback: function,
)
يتم رفعه عند طلب حذف أحد الإدخالات. إذا كانت قيمة recursive
true، وكان الإدخال دليلاً، فيجب أيضًا حذف جميع الإدخالات بالداخل بشكل متكرر.
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: DeleteEntryRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onExecuteActionRequested
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
callback: function,
)
يتم رفعه عند تنفيذ إجراء لمجموعة من الملفات أو الأدلة/ مطلوب. بعد اكتمال الإجراء، يجب استدعاء "successCallback
". عند حدوث خطأ، يجب استدعاء "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: ExecuteActionRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onGetActionsRequested
chrome.fileSystemProvider.onGetActionsRequested.addListener(
callback: function,
)
تم رفع التصنيف عند طلب قائمة إجراءات لمجموعة من الملفات أو الأدلة في entryPaths
. يجب أن تكون جميع الإجراءات التي يتم إرجاعها قابلة للتطبيق على كل إدخال. في حال عدم وجود مثل هذه الإجراءات، يجب عرض مصفوفة فارغة. ويجب عرض الإجراءات مع طلب successCallback
. في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: GetActionsRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:(actions: Action[]) => void
-
الإجراءات
الإجراء[]
-
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onGetMetadataRequested
chrome.fileSystemProvider.onGetMetadataRequested.addListener(
callback: function,
)
يتم رفعها عند طلب بيانات وصفية لملف أو دليل في entryPath
. يجب عرض البيانات الوصفية من خلال طلب successCallback
. في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: GetMetadataRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:(metadata: EntryMetadata) => void
-
البيانات الوصفية
-
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onMountRequested
chrome.fileSystemProvider.onMountRequested.addListener(
callback: function,
)
يتم رفع التصنيف عند إظهار مربّع حوار لتثبيت نظام ملفات جديد. إذا كانت الإضافة أو التطبيق معالِج ملفات، يجب عدم معالجة هذا الحدث. بدلاً من ذلك، يجب التعامل مع app.runtime.onLaunched
لتثبيت أنظمة ملفات جديدة عند فتح ملف. بالنسبة إلى عمليات التثبيت المتعدّدة، يجب ضبط خيار البيان file_system_provider.multiple_mounts
على "صحيح".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(successCallback: function, errorCallback: function) => void
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onMoveEntryRequested
chrome.fileSystemProvider.onMoveEntryRequested.addListener(
callback: function,
)
يتم رفعها عند نقل إدخال (بشكل متكرر في حال طلب دليل). في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: MoveEntryRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onOpenFileRequested
chrome.fileSystemProvider.onOpenFileRequested.addListener(
callback: function,
)
يتم رفع التصنيف عند فتح ملف على filePath
. إذا لم يكن الملف متوفّرًا، من المفترض أن تتعذّر العملية. يمكن تحديد الحد الأقصى لعدد الملفات المفتوحة في آنٍ واحد من خلال MountOptions
.
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: OpenFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:(metadata?: EntryMetadata) => void
-
البيانات الوصفية
EntryMetadata اختيارية
-
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onReadDirectoryRequested
chrome.fileSystemProvider.onReadDirectoryRequested.addListener(
callback: function,
)
تم رفعه عند طلب محتوى دليل في directoryPath
. يجب عرض النتائج في مجموعات عن طريق استدعاء الدالة successCallback
عدة مرات. في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: ReadDirectoryRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:(entries: EntryMetadata[], hasMore: boolean) => void
-
الإدخالات
-
hasMore
boolean
-
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onReadFileRequested
chrome.fileSystemProvider.onReadFileRequested.addListener(
callback: function,
)
يتم رفعه عند قراءة محتوى ملف تم فتحه سابقًا باستخدام openRequestId
. يجب عرض النتائج في مجموعات من خلال استدعاء الدالة successCallback
عدة مرات. في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: ReadFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:(data: ArrayBuffer, hasMore: boolean) => void
-
البيانات
ArrayBuffer
-
hasMore
boolean
-
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onRemoveWatcherRequested
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
callback: function,
)
يتم رفعه عند إزالة المُشاهد. في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: RemoveWatcherRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onTruncateRequested
chrome.fileSystemProvider.onTruncateRequested.addListener(
callback: function,
)
يتم رفعه عند اقتطاع ملف إلى الطول المطلوب. في حال حدوث خطأ، يجب طلب "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(options: TruncateRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-
onUnmountRequested
chrome.fileSystemProvider.onUnmountRequested.addListener(
callback: function,
)
يتم رفع هذا السعر عند إلغاء التثبيت لنظام الملفات الذي يحمل المعرّف fileSystemId
. في الرد، يجب طلب طريقة واجهة برمجة التطبيقات unmount
مع successCallback
. في حال تعذّر إلغاء التثبيت (على سبيل المثال، بسبب عملية معلّقة)، يجب استدعاء "errorCallback
".
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
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
على النحو التالي:(options: WriteFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
الخيارات
-
successCallback
الوظيفة
تبدو معلَمة
successCallback
على النحو التالي:() => void
-
errorCallback
الوظيفة
تبدو معلَمة
errorCallback
على النحو التالي:(error: ProviderError) => void
-
خطأ
-
-