storage package

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

الدوال

صفوف

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

واجهات

المتغيرات

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

function(app, ...)

getStorage(app, bucketUrl)

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

Signature:

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

المَعلمات

المرتجعات:

مساحة تخزين Firebase

مثيل FirebaseStorage

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

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

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

Signature:

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

المَعلمات

المرتجعات:

فراغ

ref(storage, url)

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

Signature:

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

المَعلمات

المرتجعات:

StorageReference

function(ref, ...)

deleteObject(ref)

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

Signature:

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

المَعلمات

المرتجعات:

وعود <باطلة>

عنصر 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>;

المَعلمات

المرتجعات:

وعود<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>;

المَعلمات

المرتجعات:

وعد <ArrayBuffer>

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

getDownloadURL(ref)

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

Signature:

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

المَعلمات

المرتجعات:

وعود<string>

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

getMetadata(ref)

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

Signature:

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

المَعلمات

المرتجعات:

وعد <FullMetadata>

getStream(ref, maxDownloadSizeBytes)

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

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

Signature:

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

المَعلمات

المرتجعات:

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>;

المَعلمات

المرتجعات:

وعد <ListResult>

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

listAll(ref)

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

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

Signature:

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

المَعلمات

المرتجعات:

وعد <ListResult>

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

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

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

Signature:

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

المَعلمات

المرتجعات:

وعد <FullMetadata>

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

uploadBytes(ref, data, metadata)

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

Signature:

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

المَعلمات

المرتجعات:

وعد <UploadResult>

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

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

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

Signature:

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

المَعلمات

المرتجعات:

UploadTask

مهمة تحميل

uploadString(ref, value, format, metadata)

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

Signature:

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

المَعلمات

المرتجعات:

وعد <UploadResult>

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

function(storageOrref, ...)

ref(storageOrref, path)

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

Signature:

export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): 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 

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