storage package

التخزين السحابي لـ Firebase

المهام

وظيفة وصف
وظيفة (التطبيق، ...)
getStorage(التطبيق، BucketUrl) يحصل على مثيل FirebaseStorage لتطبيق Firebase المحدد.
وظيفة (التخزين، ...)
ConnectStorageEmulator (التخزين، المضيف، المنفذ، الخيارات) قم بتعديل مثيل FirebaseStorage هذا للتواصل مع محاكي Cloud Storage.
المرجع (التخزين، عنوان url) إرجاع مرجع التخزين لعنوان URL المحدد.
وظيفة (المرجع، ...)
حذف الكائن (المرجع) يحذف الكائن في هذا الموقع.
getBlob(المرجع، maxDownloadSizeBytes) يقوم بتنزيل البيانات في موقع الكائن. إرجاع خطأ إذا لم يتم العثور على الكائن. لاستخدام هذه الوظيفة، يتعين عليك إضافة أصل تطبيقك إلى القائمة البيضاء في مجموعة Cloud Storage الخاصة بك. راجع أيضًا https://cloud.google.com/storage/docs/configuring-cors واجهة برمجة التطبيقات هذه غير متوفرة في Node.
getBytes(المرجع، maxDownloadSizeBytes) يقوم بتنزيل البيانات في موقع الكائن. إرجاع خطأ إذا لم يتم العثور على الكائن. لاستخدام هذه الوظيفة، يتعين عليك إضافة أصل تطبيقك إلى القائمة البيضاء في مجموعة Cloud Storage الخاصة بك. راجع أيضًا https://cloud.google.com/storage/docs/configuring-cors
الحصول علىDownloadURL(المرجع) إرجاع عنوان URL للتنزيل لمرجع التخزين المحدد .
الحصول على بيانات التعريف (المرجع) Promise يتم حله باستخدام البيانات التعريفية لهذا الكائن. إذا كان هذا الكائن غير موجود أو لا يمكن استرجاع بيانات التعريف، فسيتم رفض الوعد.
getStream(المرجع، maxDownloadSizeBytes) يقوم بتنزيل البيانات في موقع الكائن. يثير حدث خطأ إذا لم يتم العثور على الكائن. واجهة برمجة التطبيقات هذه متاحة فقط في Node.
القائمة (المرجع، الخيارات) قم بإدراج العناصر (الملفات) والبادئات (المجلدات) ضمن مرجع التخزين هذا. قائمة API متاحة فقط للإصدار 2 من قواعد Firebase. GCS هو متجر رئيسي. يفرض Firebase Storage دلالات بنية المجلد المحدد '/'. ارجع إلى قائمة API الخاصة بـ GCS إذا كنت تريد معرفة المزيد. للالتزام بدلالات قواعد Firebase، لا يدعم Firebase Storage الكائنات التي تنتهي مساراتها بـ "/" أو تحتوي على حرفين "/" متتاليين. ستقوم Firebase Storage List API بتصفية هذه الكائنات غير المدعومة. قد تفشل list() إذا كان هناك عدد كبير جدًا من الكائنات غير المدعومة في المجموعة.
قائمة الكل (المرجع) قم بإدراج جميع العناصر (الملفات) والبادئات (المجلدات) ضمن مرجع التخزين هذا. هذه طريقة مساعدة لاستدعاء list() بشكل متكرر حتى لا يكون هناك المزيد من النتائج. حجم الصفحة الافتراضي هو 1000. ملاحظة: قد لا تكون النتائج متسقة إذا تم تغيير الكائنات أثناء تشغيل هذه العملية. تحذير: من المحتمل أن يستهلك listAll الكثير من الموارد إذا كان هناك عدد كبير جدًا من النتائج.
تحديث البيانات الوصفية (المرجع، البيانات الوصفية) يقوم بتحديث بيانات التعريف لهذا الكائن.
تحميل بايت (المرجع، البيانات، البيانات الوصفية) يقوم بتحميل البيانات إلى موقع هذا الكائن. لا يمكن استئناف التحميل.
uploadBytesResumable(المرجع، البيانات، البيانات الوصفية) يقوم بتحميل البيانات إلى موقع هذا الكائن. يمكن إيقاف التحميل مؤقتًا واستئنافه، ويكشف عن تحديثات التقدم.
uploadString (المرجع، القيمة، التنسيق، البيانات الوصفية) تحميل سلسلة إلى موقع هذا الكائن. لا يمكن استئناف التحميل.
وظيفة (storageOrRef، ...)
المرجع (storageOrRef، المسار) يُرجع مرجع تخزين للمسار المحدد في المجموعة الافتراضية.

الطبقات

فصل وصف
خطأ في التخزين حدث خطأ تم إرجاعه بواسطة Firebase Storage SDK.

التعدادات

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

واجهات

واجهه المستخدم وصف
FirebaseStorage مثيل تخزين Firebase.
بيانات التعريف الكاملة المجموعة الكاملة من بيانات تعريف الكائن، بما في ذلك خصائص القراءة فقط.
خيارات القائمة تقبل list() .
نتيجة القائمة تم إرجاع النتيجة بواسطة القائمة ().
SettableMetadata بيانات تعريف الكائن التي يمكن تعيينها في أي وقت.
StorageObserver مراقب التدفق لتخزين Firebase.
مرجع التخزين يمثل مرجعًا لكائن Google Cloud Storage. يمكن للمطورين تحميل الكائنات وتنزيلها وحذفها، بالإضافة إلى الحصول على/تعيين البيانات التعريفية للكائن.
تحميل البيانات الوصفية بيانات تعريف الكائن التي يمكن تعيينها عند التحميل.
تحميل النتيجة تم إرجاع النتيجة من تحميل غير قابل للاستئناف.
تحميل مهمة يمثل عملية تحميل كائن. يسمح لك بمراقبة وإدارة التحميل.
تحميل مهمةSnapshot يحمل بيانات حول الحالة الحالية لمهمة التحميل.

المتغيرات

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

اكتب الأسماء المستعارة

اكتب الاسم المستعار وصف
تنسيق السلسلة تعداد لتنسيقات السلسلة الممكنة للتحميل.
حدث المهمة حدث يتم تشغيله في مهمة.
حالة المهمة يمثل الحالة الحالية للتحميل قيد التشغيل.

وظيفة (التطبيق، ...)

getStorage(التطبيق، BucketUrl)

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

إمضاء:

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

حدود

معامل يكتب وصف
برنامج FirebaseApp تطبيق Firebase للحصول على مثيل FirebaseStorage لـ.
دلوUrl خيط gs:// url إلى مجموعة تخزين Firebase الخاصة بك. إذا لم يتم اجتيازه، فسيتم استخدام حاوية التخزين الافتراضية للتطبيق.

عائدات:

FirebaseStorage

مثيل FirebaseStorage .

وظيفة (التخزين، ...)

ConnectStorageEmulator (التخزين، المضيف، المنفذ، الخيارات)

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

إمضاء:

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

حدود

معامل يكتب وصف
تخزين FirebaseStorage مثيل FirebaseStorage
يستضيف خيط مضيف المحاكي (على سبيل المثال: المضيف المحلي)
ميناء رقم منفذ المحاكي (على سبيل المثال: 5001)
خيارات { mockUserToken؟: EmulatorMockTokenOptions | خيط؛ } خيارات المحاكي. options.mockUserToken هو رمز المصادقة الوهمي لاستخدامه في اختبار قواعد الأمان للوحدة.

عائدات:

فارغ

المرجع (التخزين، عنوان url)

إرجاع مرجع التخزين لعنوان URL المحدد.

إمضاء:

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

حدود

معامل يكتب وصف
تخزين FirebaseStorage مثيل FirebaseStorage .
عنوان URL خيط عنوان URL. إذا كان فارغًا، فسيتم إرجاع المرجع الجذري.

عائدات:

مرجع التخزين

وظيفة (المرجع، ...)

حذف الكائن (المرجع)

يحذف الكائن في هذا الموقع.

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين للكائن المراد حذفه.

عائدات:

وعد<باطل>

Promise الذي يتم حله إذا نجح الحذف.

getBlob(المرجع، maxDownloadSizeBytes)

يقوم بتنزيل البيانات في موقع الكائن. إرجاع خطأ إذا لم يتم العثور على الكائن.

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

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

إمضاء:

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

حدود

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

عائدات:

وعد<Blob>

وعد يتم حله باستخدام كائن ثنائي كبير الحجم يحتوي على بايتات الكائن

getBytes(المرجع، maxDownloadSizeBytes)

يقوم بتنزيل البيانات في موقع الكائن. إرجاع خطأ إذا لم يتم العثور على الكائن.

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

إمضاء:

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

حدود

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

عائدات:

وعد<ArrayBuffer>

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

الحصول علىDownloadURL(المرجع)

إرجاع عنوان URL للتنزيل لمرجع التخزين المحدد .

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين للحصول على عنوان URL للتنزيل لـ.

عائدات:

وعد <سلسلة>

Promise يتم حله باستخدام عنوان URL للتنزيل لهذا الكائن.

الحصول على بيانات التعريف (المرجع)

Promise يتم حله باستخدام البيانات التعريفية لهذا الكائن. إذا كان هذا الكائن غير موجود أو لا يمكن استرجاع بيانات التعريف، فسيتم رفض الوعد.

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين للحصول على البيانات التعريفية منه.

عائدات:

وعد< بيانات التعريف الكاملة >

getStream(المرجع، maxDownloadSizeBytes)

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

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

إمضاء:

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

حدود

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

عائدات:

NodeJS.ReadableStream

دفق يحتوي على بيانات الكائن بالبايت

القائمة (المرجع، الخيارات)

قم بإدراج العناصر (الملفات) والبادئات (المجلدات) ضمن مرجع التخزين هذا.

قائمة API متاحة فقط للإصدار 2 من قواعد Firebase.

GCS هو متجر رئيسي. يفرض Firebase Storage دلالات بنية المجلد المحدد '/'. ارجع إلى قائمة API الخاصة بـ GCS إذا كنت تريد معرفة المزيد.

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

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين للحصول على القائمة منه.
خيارات خيارات القائمة راجع خيارات القائمة للحصول على التفاصيل.

عائدات:

الوعد < النتيجة >

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

قائمة الكل (المرجع)

قم بإدراج جميع العناصر (الملفات) والبادئات (المجلدات) ضمن مرجع التخزين هذا.

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

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين للحصول على القائمة منه.

عائدات:

الوعد < النتيجة >

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

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

يقوم بتحديث بيانات التعريف لهذا الكائن.

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين لتحديث البيانات التعريفية لـ.
البيانات الوصفية SettableMetadata بيانات التعريف الجديدة للكائن. سيتم تغيير القيم التي تم تعيينها بشكل صريح فقط. سيؤدي تعيين القيمة بشكل صريح إلى null إلى إزالة البيانات التعريفية.

عائدات:

وعد< بيانات التعريف الكاملة >

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

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

يقوم بتحميل البيانات إلى موقع هذا الكائن. لا يمكن استئناف التحميل.

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين حيث يجب تحميل البيانات.
بيانات فقاعة | Uint8Array | ArrayBuffer البيانات المراد تحميلها.
البيانات الوصفية تحميل البيانات الوصفية البيانات الوصفية للبيانات المراد تحميلها.

عائدات:

وعد< UploadResult >

وعد يحتوي على UploadResult

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

يقوم بتحميل البيانات إلى موقع هذا الكائن. يمكن إيقاف التحميل مؤقتًا واستئنافه، ويكشف عن تحديثات التقدم.

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين حيث يجب تحميل البيانات.
بيانات فقاعة | Uint8Array | ArrayBuffer البيانات المراد تحميلها.
البيانات الوصفية تحميل البيانات الوصفية البيانات الوصفية للبيانات المراد تحميلها.

عائدات:

تحميل مهمة

مهمة التحميل

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

تحميل سلسلة إلى موقع هذا الكائن. لا يمكن استئناف التحميل.

إمضاء:

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

حدود

معامل يكتب وصف
المرجع مرجع التخزين مرجع التخزين حيث يجب تحميل السلسلة.
قيمة خيط السلسلة المراد تحميلها.
شكل تنسيق السلسلة تنسيق السلسلة المراد تحميلها.
البيانات الوصفية تحميل البيانات الوصفية البيانات الوصفية للسلسلة المراد تحميلها.

عائدات:

وعد< UploadResult >

وعد يحتوي على UploadResult

وظيفة (storageOrRef، ...)

المرجع (storageOrRef، المسار)

يُرجع مرجع تخزين للمسار المحدد في المجموعة الافتراضية.

إمضاء:

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

حدود

معامل يكتب وصف
تخزينأوالمرجع تخزين Firebase | مرجع التخزين FirebaseStorage أو StorageReference .
طريق خيط

عائدات:

مرجع التخزين

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

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

إمضاء:

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

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

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

إمضاء:

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

حدث المهمة

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

إمضاء:

export declare type TaskEvent = 'state_changed';

حالة المهمة

يمثل الحالة الحالية للتحميل قيد التشغيل.

إمضاء:

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

رمز خطأ التخزين

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

إمضاء:

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-argument-count"
INVALID_CHECKSUM "invalid-checksum"
INVALID_DEFAULT_BUCKET "invalid-default-bucket"
INVALID_EVENT_NAME "invalid-event-name"
INVALID_FORMAT "invalid-format"
INVALID_ROOT_OPERATION "invalid-root-operation"
URL غير صالح "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_DOWNLOAD_URL "no-download-url"
المفعول به غير موجود "object-not-found"
PROJECT_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 "unauthorized-app"
مجهول "unknown"
بيئة غير مدعومة "unsupported-environment"