storage package

التخزين في السحابة الإلكترونية لبرنامج Firebase

الدوال

دالة الوصف
الدالّة(app, ...)
getStorage(app, bucketUrl) الحصول على مثيل FirebaseStorage لتطبيق Firebase المحدَّد
الدالّة(storage, ...)
connectStorageEmulator(مساحة التخزين والمضيف والمنفذ والخيارات) يمكنك تعديل مثيل FirebaseStorage هذا للاتصال بمحاكي Cloud Storage.
ref(storage, url) تعرض StorageReference لعنوان URL المحدَّد.
الدالّة(ref, ...)
deleteObject(ref) حذف العنصر في هذا الموقع.
getBlob(ref, maxDownloadSizeBytes) يتم تنزيل البيانات في موقع العنصر تعرض رسالة خطأ في حال عدم العثور على العنصر.لاستخدام هذه الوظيفة، عليك إضافة مصدر تطبيقك إلى القائمة البيضاء في حزمة Cloud Storage. يمكنك أيضًا الاطّلاع على https://cloud.google.com/storage/docs/configring-corsواجهة برمجة التطبيقات هذه غير متاحة في Node.
getBytes(ref, maxDownloadSizeBytes) يتم تنزيل البيانات في موقع العنصر تعرض رسالة خطأ في حال عدم العثور على العنصر.لاستخدام هذه الوظيفة، عليك إضافة مصدر تطبيقك إلى القائمة البيضاء في حزمة Cloud Storage. يمكنك الاطّلاع أيضًا على https://cloud.google.com/storage/docs/configring-cors.
getDownloadURL(ref) تعرض عنوان URL للتنزيل الخاص بـ StorageReference المحدَّد.
getMetadata(ref) سمة Promise يتم حلها باستخدام البيانات الوصفية لهذا العنصر في حال عدم توفّر هذا العنصر أو تعذّر استرداد البيانات الوصفية، سيتم رفض الوعد.
getStream(ref, maxDownloadSizeBytes) يتم تنزيل البيانات في موقع العنصر تؤدي هذه السياسة إلى عرض حدث خطأ في حال عدم العثور على العنصر.لا تتوفّر واجهة برمجة التطبيقات هذه إلا في Node.
list(ref, options) يمكنك إدراج عناصر (الملفات) والبادئات (المجلدات) ضمن مرجع مساحة التخزين هذا.لا تتوفّر واجهة برمجة التطبيقات List API إلا للإصدار 2 من قواعد Firebase.إنّ GCS هو متجر تخزين الملفات الثنائية الكبيرة (blob). تفرض مساحة تخزين Firebase دلالة '/' بنية المجلدات المحددة. لمعرفة المزيد من المعلومات، يمكنك الرجوع إلى واجهة برمجة التطبيقات List API من GCS.للالتزام بدلالات قواعد Firebase، لا تتوافق مساحة تخزين Firebase مع العناصر التي تنتهي مساراتها بـ "/". أو تحتوي على علامتَي "/" متتاليتين. وستفلتر واجهة برمجة التطبيقات لقائمة التخزين في Firebase هذه العناصر غير المتوافقة. قد تفشل list() إذا كان هناك عدد كبير جدًا من العناصر غير المتوافقة في الحزمة.
listAll(ref) أدرِج جميع العناصر (الملفات) والبادئات (المجلدات) ضمن مرجع مساحة التخزين هذا.وهذه طريقة مساعدة لاستدعاء القائمة() بشكل متكرر حتى لا تتوفّر نتائج أخرى. الحجم التلقائي للتقسيم على صفحات هو 1000.ملاحظة: قد لا تكون النتائج متسقة إذا تم تغيير العناصر أثناء تشغيل هذه العملية.تحذير: من المحتمل أن تستهلك listAll موارد كثيرة جدًا إذا كان هناك عدد كبير جدًا من النتائج.
updateMetadata(ref, Metadata) لتعديل البيانات الوصفية لهذا العنصر
uploadBytes(المرجع، البيانات، البيانات الوصفية) تعمل هذه الميزة على تحميل البيانات إلى موقع هذا العنصر. التحميل غير قابل للاستئناف.
uploadBytesResumable(المرجع، البيانات، البيانات الوصفية) تعمل هذه الميزة على تحميل البيانات إلى موقع هذا العنصر. يمكن إيقاف التحميل مؤقتًا واستئنافه، وسيعرض لك تحديثات مستوى التقدّم.
uploadString(ref, value, format, metadata) تحمِّل سلسلة إلى موقع هذا العنصر. التحميل غير قابل للاستئناف.
الدالّة(storageOrref, ...)
ref(storageOrref, path) تعرض StorageReference للمسار المحدَّد في الحزمة التلقائية.

صفوف

الفئة الوصف
خطأ في مساحة التخزين حدث خطأ من خلال حزمة تطوير البرامج (SDK) لمساحة التخزين في Firebase.

عمليات التعداد

التعداد الوصف
StorageErrorCode رموز الخطأ التي يمكن إرفاقها بـ StorageError عنصرًا.

واجهات

الواجهة الوصف
مساحة تخزين Firebase مثيل مساحة تخزين Firebase
البيانات الوصفية الكاملة المجموعة الكاملة من البيانات الوصفية للعناصر، بما في ذلك السمات للقراءة فقط
ListOptions تقبل الخيارات list().
ListResult تم عرض النتيجة بواسطة list().
SettableMetadata هي البيانات الوصفية للعنصر التي يمكن ضبطها في أي وقت.
StorageMonitorer مراقب التدفق للتخزين في Firebase
StorageReference يمثل مرجعًا إلى عنصر في Google Cloud Storage. يمكن للمطوّرين تحميل العناصر وتنزيلها وحذفها، بالإضافة إلى الحصول على البيانات الوصفية للعناصر أو ضبطها.
UploadMetadata البيانات الوصفية للعنصر التي يمكن ضبطها أثناء التحميل
نتيجة التحميل تم عرض النتيجة من عملية تحميل غير قابلة للاستئناف.
UploadTask يمثّل هذا النوع عملية تحميل عنصر. تسمح لك بمراقبة عملية التحميل وإدارتها.
UploadTaskShot يحتوي على بيانات عن الحالة الحالية لمهمة التحميل.

المتغيرات

متغير الوصف
StringFormat تعداد لتنسيقات السلسلة المحتملة للتحميل.

كتابة العناوين البديلة للبريد الإلكتروني

اكتب العنوان البديل للبريد الإلكتروني الوصف
StringFormat تعداد لتنسيقات السلسلة المحتملة للتحميل.
TaskEvent حدث يتم تشغيله على مهمة.
TaskState يمثل هذا الإعداد الحالة الحالية لعملية تحميل قيد التشغيل.

function(app, ...)

getStorage(app, bucketUrl)

الحصول على مثيل FirebaseStorage لتطبيق Firebase المحدَّد

Signature:

export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;

المَعلمات

المعلمة النوع الوصف
التطبيق تطبيق Firebase تطبيق Firebase للحصول على مثيل FirebaseStorage من أجله.
عنوان bucketUrl السلسلة عنوان url gs:// لحزمة التخزين في Firebase إذا لم يتم اجتياز الاختبار، سيتم استخدام "حزمة التخزين" التلقائية للتطبيق.

المرتجعات:

مساحة تخزين Firebase

مثيل FirebaseStorage

الدالة(storage, ...)

ConnectStorageEmulator(مساحة التخزين والمضيف والمنفذ والخيارات)

يمكنك تعديل مثيل FirebaseStorage هذا للاتصال بمحاكي Cloud Storage.

Signature:

export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

المَعلمات

المعلمة النوع الوصف
التخزين مساحة تخزين Firebase المثيل FirebaseStorage
المضيف السلسلة مضيف المحاكي (مثل: localhost)
المنفذ رقم منفذ المحاكي (مثل: 5001)
خيارات {cyUserToken?: EmulatorMockTokenOptions | سلسلة؛ } خيارات المحاكي. options.mockUserToken هو الرمز المميّز للمصادقة الوهمي الذي سيتم استخدامه في اختبار الوحدات وفقًا لقواعد الأمان.

المرتجعات:

فراغ

ref(storage, url)

تعرض StorageReference لعنوان URL المحدَّد.

Signature:

export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;

المَعلمات

المعلمة النوع الوصف
التخزين مساحة تخزين Firebase مثيل FirebaseStorage
عنوان url السلسلة عنوان URL. إذا كانت هذه القيمة فارغة، سيتم عرض المرجع الجذر.

المرتجعات:

StorageReference

function(ref, ...)

deleteObject(ref)

حذف العنصر في هذا الموقع.

Signature:

export declare function deleteObject(ref: StorageReference): Promise<void>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference للكائن المطلوب حذفه.

المرتجعات:

وعود <باطلة>

عنصر Promise يتم التعامل معه في حال نجاح الحذف.

getBlob(ref, maxDownloadSizeBytes)

يتم تنزيل البيانات في موقع العنصر تعرض رسالة خطأ في حال عدم العثور على العنصر.

لاستخدام هذه الوظيفة، يجب إضافة مصدر تطبيقك إلى القائمة البيضاء في حزمة Cloud Storage. يمكنك الاطّلاع أيضًا على https://cloud.google.com/storage/docs/configring-cors.

واجهة برمجة التطبيقات هذه غير متوفّرة في Node.

Signature:

export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference مرجع التخزين الذي يجب تنزيل البيانات فيه
maxDownloadSizeBytes رقم في حال ضبط هذه السياسة، يتم ضبط الحد الأقصى للحجم المسموح باسترداده بالبايت.

المرتجعات:

وعود<Blob>

وعود تتم معالجتها مع وحدة تخزين بيانات تحتوي على وحدات البايت الخاصة بالكائن

getBytes(ref, maxDownloadSizeBytes)

يتم تنزيل البيانات في موقع العنصر تعرض رسالة خطأ في حال عدم العثور على العنصر.

لاستخدام هذه الوظيفة، يجب إضافة مصدر تطبيقك إلى القائمة البيضاء في حزمة Cloud Storage. يمكنك الاطّلاع أيضًا على https://cloud.google.com/storage/docs/configring-cors.

Signature:

export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference مرجع التخزين الذي يجب تنزيل البيانات فيه
maxDownloadSizeBytes رقم في حال ضبط هذه السياسة، يتم ضبط الحد الأقصى للحجم المسموح باسترداده بالبايت.

المرتجعات:

وعد <ArrayBuffer>

وعد يحتوي على وحدات البايت الخاصة بالكائن

getDownloadURL(ref)

تعرض عنوان URL للتنزيل الخاص بـ StorageReference المحدَّد.

Signature:

export declare function getDownloadURL(ref: StorageReference): Promise<string>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference للحصول على عنوان URL للتنزيل

المرتجعات:

وعود<string>

Promise التي يتم حلها مع عنوان URL للتنزيل لهذا العنصر.

getMetadata(ref)

سمة Promise يتم حلها باستخدام البيانات الوصفية لهذا العنصر في حال عدم توفّر هذا العنصر أو تعذّر استرداد البيانات الوصفية، سيتم رفض الوعد.

Signature:

export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference للحصول على بيانات وصفية منه

المرتجعات:

وعد <FullMetadata>

getStream(ref, maxDownloadSizeBytes)

يتم تنزيل البيانات في موقع العنصر تؤدي إلى حدث خطأ في حال عدم العثور على العنصر.

لا تتوفّر واجهة برمجة التطبيقات هذه إلا في Node.

Signature:

export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): ReadableStream;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference مرجع التخزين الذي يجب تنزيل البيانات فيه
maxDownloadSizeBytes رقم في حال ضبط هذه السياسة، يتم ضبط الحد الأقصى للحجم المسموح باسترداده بالبايت.

المرتجعات:

ReadableStream

مصدر بيانات يحتوي على بيانات العنصر بتنسيق بايت

list(ref, options)

أدرِج العناصر (الملفات) والبادئات (المجلدات) ضمن مرجع مساحة التخزين هذا.

لا تتوفّر List API إلا للإصدار 2 من قواعد Firebase.

GCS هو متجر لبيع المفاتيح الكبيرة (blob). تفرض مساحة تخزين Firebase دلالة '/' بنية المجلدات المحددة. يمكنك الرجوع إلى واجهة برمجة التطبيقات List API من GCS إذا كنت تريد التعرُّف على مزيد من المعلومات.

للالتزام بدلالات قواعد Firebase، لا تتوافق مساحة تخزين Firebase مع الكائنات التي تنتهي مساراتها بـ "/" أو تحتوي على علامتَي "/" متتاليتين. وستفلتر واجهة برمجة التطبيقات لقائمة التخزين في Firebase هذه العناصر غير المتوافقة. قد تفشل list() إذا كان هناك عدد كبير جدًا من العناصر غير المتوافقة في الحزمة.

Signature:

export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference للحصول على قائمة منها
خيارات ListOptions راجِع ListOptions لمعرفة التفاصيل.

المرتجعات:

وعد <ListResult>

قيمة Promise يتم حلها باستخدام العناصر والبادئات. يحتوي prefixes على إشارات إلى مجلدات فرعية ويحتوي items على مراجع لكائنات في هذا المجلد. يمكن استخدام nextPageToken للحصول على بقية النتائج.

listAll(ref)

أدرِج جميع العناصر (الملفات) والبادئات (المجلدات) ضمن مرجع مساحة التخزين هذا.

هذه طريقة مساعدة لاستدعاء list() بشكل متكرر حتى لا تكون هناك نتائج أخرى. الحجم التلقائي للتقسيم على صفحات هو 1000.

Signature:

export declare function listAll(ref: StorageReference): Promise<ListResult>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference للحصول على قائمة منها

المرتجعات:

وعد <ListResult>

هي سمة Promise تتم معالجتها مع كل العناصر والبادئات ضمن مرجع مساحة التخزين الحالي. يحتوي prefixes على مراجع إلى أدلة فرعية، ويحتوي items على مراجع لكائنات في هذا المجلد. ولا يتم إرجاع nextPageToken مطلقًا.

تحديثالبيانات الوصفية(المرجع، البيانات الوصفية)

لتعديل البيانات الوصفية لهذا العنصر

Signature:

export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference لتعديل البيانات الوصفية الخاصة به
البيانات الوصفية SettableMetadata البيانات الوصفية الجديدة للعنصر. سيتم تغيير القيم التي تم ضبطها بشكل صريح فقط. سيؤدي ضبط القيمة صراحةً على "فارغ" إلى إزالة البيانات الوصفية.

المرتجعات:

وعد <FullMetadata>

علامة Promise يتم حلها باستخدام البيانات الوصفية الجديدة لهذا العنصر.

uploadBytes(ref, data, metadata)

تعمل هذه الميزة على تحميل البيانات إلى موقع هذا العنصر. التحميل غير قابل للاستئناف.

Signature:

export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference الذي يجب تحميل البيانات فيه.
البيانات Blob | Uint8Array | مخزن المصفوفات البيانات المطلوب تحميلها.
البيانات الوصفية UploadMetadata بيانات التعريف للبيانات المراد تحميلها.

المرتجعات:

وعد <UploadResult>

وعد يحتوي على نتيجة تحميل

uploadBytesResumable(المرجع، البيانات، البيانات الوصفية)

تعمل هذه الميزة على تحميل البيانات إلى موقع هذا العنصر. يمكن إيقاف التحميل مؤقتًا واستئنافه، وسيعرض لك تحديثات مستوى التقدّم.

Signature:

export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference الذي يجب تحميل البيانات فيه.
البيانات Blob | Uint8Array | مخزن المصفوفات البيانات المطلوب تحميلها.
البيانات الوصفية UploadMetadata بيانات التعريف للبيانات المراد تحميلها.

المرتجعات:

UploadTask

مهمة تحميل

uploadString(ref, value, format, metadata)

تحمِّل سلسلة إلى موقع هذا العنصر. التحميل غير قابل للاستئناف.

Signature:

export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;

المَعلمات

المعلمة النوع الوصف
المرجع StorageReference StorageReference حيث يجب تحميل السلسلة.
القيمة السلسلة السلسلة المطلوب تحميلها.
التنسيق StringFormat تنسيق السلسلة المطلوب تحميلها.
البيانات الوصفية UploadMetadata البيانات الوصفية للسلسلة المطلوب تحميلها

المرتجعات:

وعد <UploadResult>

وعد يحتوي على نتيجة تحميل

function(storageOrref, ...)

ref(storageOrref, path)

تعرض StorageReference للمسار المحدَّد في الحزمة التلقائية.

Signature:

export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;

المَعلمات

المعلمة النوع الوصف
وحدة التخزين أو مرجع FirebaseStorage | StorageReference FirebaseStorage أو StorageReference
المسار السلسلة

المرتجعات:

StorageReference

تنسيق السلسلة

تعداد لتنسيقات السلسلة المحتملة للتحميل.

Signature:

StringFormat: {
    readonly RAW: "raw";
    readonly BASE64: "base64";
    readonly BASE64URL: "base64url";
    readonly DATA_URL: "data_url";
}

تنسيق السلسلة

تعداد لتنسيقات السلسلة المحتملة للتحميل.

Signature:

export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];

TaskEvent

حدث يتم تشغيله على مهمة.

Signature:

export declare type TaskEvent = 'state_changed';

حالة المهمة

يمثل هذا الإعداد الحالة الحالية لعملية تحميل قيد التشغيل.

Signature:

export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';

رمز خطأ Storage

رموز الخطأ التي يمكن إرفاقها بـ StorageError عنصرًا.

Signature:

export declare enum StorageErrorCode

تعداد الأعضاء

عضو القيمة الوصف
APP_DELETED "app-deleted"
BUCKET_NOT_FOUND "bucket-not-found"
تم إلغاؤها "canceled"
لا_SLICE_BLOB "cannot-slice-blob"
خطأ_داخلي "internal-error"
قيمة غير صالحة "invalid-argument"
عدد العناصر غير الصالحة "invalid-argument-count"
غير صالح_التحقق_من_المجموع "invalid-checksum"
قيمة غير صالحة "invalid-default-bucket"
اسم الحدث بدل_EVENT_NAME "invalid-event-name"
تنسيق_غير صالح "invalid-format"
عملية غير صالحة "invalid-root-operation"
عنوان URL غير صالح "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_DOWNLOAD_URL "no-download-url"
OBJECT_NOT_FOUND "object-not-found"
لم يتم العثور على المشروع "project-not-found"
الحصة الإجمالية "quota-exceeded"
عدد مرات إعادة المحاولة: RETRY_LIMIT_EXCEEDED "retry-limit-exceeded"
SERVER_FILE_WRONG_size "server-file-wrong-size"
غير مصدَّق عليها "unauthenticated"
غير مصرَّح بها "unauthorized"
تطبيق غير مصرَّح به "unauthorized-app"
غير معروف "unknown"
بيئة_غير متوافقة "unsupported-environment"