database package

پایگاه داده بیدرنگ Firebase

کارکرد

تابع شرح
عملکرد (برنامه، ...)
getDatabase (برنامه، آدرس اینترنتی) نمونه ای از SDK پایگاه داده بیدرنگ را که با FirebaseApp ارائه شده مرتبط است، برمی گرداند. . اگر نمونه ای وجود نداشته باشد یا اگر نمونه موجود از یک URL پایگاه داده سفارشی استفاده کند، یک نمونه جدید را با تنظیمات پیش فرض راه اندازی می کند.
تابع (db، ...)
connectDatabaseEmulator (db، میزبان، پورت، گزینه ها) نمونه ارائه شده را برای برقراری ارتباط با شبیه ساز پایگاه داده بیدرنگ تغییر دهید.

نکته: این متد باید قبل از انجام هر عملیات دیگری فراخوانی شود.

goOffline (db) اتصال از سرور قطع می شود (تمام عملیات پایگاه داده به صورت آفلاین تکمیل خواهد شد). کلاینت به طور خودکار یک اتصال دائمی به سرور پایگاه داده برقرار می کند، که به طور نامحدود فعال می ماند و در صورت قطع ارتباط مجدداً متصل می شود. با این حال، متدهای goOffline() و goOnline() ممکن است برای کنترل اتصال کلاینت در مواردی که اتصال دائمی نامطلوب است استفاده شود. در حالت آفلاین، مشتری دیگر به روز رسانی داده ها را از پایگاه داده دریافت نخواهد کرد. با این حال، تمام عملیات پایگاه داده که به صورت محلی انجام می‌شوند، بلافاصله رویدادها را فعال می‌کنند و به برنامه شما اجازه می‌دهند به رفتار عادی خود ادامه دهند. علاوه بر این، هر عملیاتی که به صورت محلی انجام می شود، به طور خودکار در صف قرار می گیرد و پس از اتصال مجدد به سرور پایگاه داده، دوباره امتحان می شود. برای اتصال مجدد به پایگاه داده و شروع دریافت رویدادهای راه دور، به goOnline() مراجعه کنید.
آنلاین (db) دوباره به سرور متصل می شود و وضعیت پایگاه داده آفلاین را با وضعیت سرور همگام می کند. این روش باید پس از غیرفعال کردن اتصال فعال با goOffline() استفاده شود. پس از اتصال مجدد، کلاینت داده‌های مناسب را ارسال می‌کند و رویدادهای مناسب را اجرا می‌کند تا مشتری شما به‌طور خودکار «پیش‌گیری» کند.
ref(db، مسیر) یک Reference نشان دهنده مکان در پایگاه داده مربوط به مسیر ارائه شده را برمی گرداند. اگر مسیری ارائه نشود، Reference به ریشه پایگاه داده اشاره می کند.
refFromURL(db، url) Reference را برمی‌گرداند که نشان‌دهنده مکان در پایگاه داده مربوط به نشانی اینترنتی Firebase ارائه شده است. اگر URL یک URL پایگاه داده Firebase معتبر نباشد یا دامنه متفاوتی نسبت به نمونه فعلی Database داشته باشد، یک استثنا ایجاد می شود. توجه داشته باشید که تمام پارامترهای پرس و جو ( orderBy , limitToLast و غیره ) نادیده گرفته می شوند و به Reference برگشتی اعمال نمی شوند.
تابع()
forceLongPolling() استفاده از longPolling به جای وب سوکت ها را اجباری کنید. اگر از پروتکل websocket در پایگاه داده URL استفاده شود، این مورد نادیده گرفته می شود.
forceWebSockets() استفاده از وب سوکت ها را به جای longPolling اجباری کنید.
orderByKey() یک QueryConstraint جدید ایجاد می کند که بر اساس کلید مرتب می شود. نتایج یک پرس و جو را بر اساس مقادیر کلید (صعودی) آنها مرتب می کند. در Sort data می‌توانید درباره orderByKey() اطلاعات بیشتری کسب کنید .
orderByPriority() یک QueryConstraint جدید ایجاد می کند که بر اساس اولویت مرتب می شود. برنامه‌ها نیازی به استفاده از اولویت ندارند، اما می‌توانند مجموعه‌ها را بر اساس ویژگی‌های معمولی مرتب کنند (به ترتیب داده‌ها برای جایگزین‌های اولویت مراجعه کنید.
orderByValue() یک QueryConstraint جدید ایجاد می کند که بر اساس مقدار مرتب می شود. اگر فرزندان یک پرس و جو همه مقادیر اسکالر (رشته، عدد یا بولی) هستند، می توانید نتایج را بر اساس مقادیر (صعودی) آنها مرتب کنید. در Sort data می‌توانید درباره orderByValue() بیشتر بخوانید .
serverTimestamp() یک مقدار مکان نگهدار برای پر کردن خودکار مهر زمانی فعلی (زمان از دوره یونیکس، بر حسب میلی ثانیه) که توسط سرورهای Firebase تعیین شده است، برمی‌گرداند.
تابع (دلتا، ...)
افزایش (دلتا) یک مقدار جای‌بانی را برمی‌گرداند که می‌تواند برای افزایش اتمی مقدار پایگاه داده فعلی توسط دلتای ارائه شده استفاده شود.
عملکرد (فعال، ...)
enableLogging (فعال، مداوم) اطلاعات مربوط به اشکال زدایی را در کنسول ثبت می کند.
تابع (محدود، ...)
limitToFirst(Limit) یک QueryConstraint جدید ایجاد می کند که اگر محدود به اولین تعداد خاص از فرزندان باشد. متد limitToFirst() برای تنظیم حداکثر تعداد فرزندان برای همگام سازی برای یک فراخوان معین استفاده می شود. اگر حد 100 تعیین کنیم، در ابتدا فقط تا 100 رویداد child_added دریافت خواهیم کرد. اگر کمتر از 100 پیام در پایگاه داده ما ذخیره شده باشد، یک رویداد child_added برای هر پیام فعال می شود. با این حال، اگر بیش از 100 پیام داشته باشیم، فقط برای 100 پیام سفارش داده شده اول یک رویداد child_added دریافت خواهیم کرد. با تغییر موارد، رویدادهای child_removed را برای هر موردی که از لیست فعال خارج می‌شود دریافت می‌کنیم به طوری که تعداد کل 100 باقی می‌ماند. می توانید در Filtering data درباره limitToFirst() بیشتر بخوانید .
limitToLast(Limit) یک QueryConstraint جدید ایجاد می کند که محدود به برگرداندن آخرین تعداد مشخص شده از فرزندان است. متد limitToLast() برای تنظیم حداکثر تعداد فرزندان جهت همگام سازی برای یک فراخوان معین استفاده می شود. اگر حد 100 تعیین کنیم، در ابتدا فقط تا 100 رویداد child_added دریافت خواهیم کرد. اگر کمتر از 100 پیام در پایگاه داده ما ذخیره شده باشد، یک رویداد child_added برای هر پیام فعال می شود. با این حال، اگر بیش از 100 پیام داشته باشیم، فقط یک رویداد child_added را برای 100 پیام سفارش داده شده آخر دریافت خواهیم کرد. با تغییر موارد، رویدادهای child_removed را برای هر موردی که از لیست فعال خارج می‌شود دریافت می‌کنیم به طوری که تعداد کل 100 باقی می‌ماند. می‌توانید در Filtering data درباره limitToLast() بیشتر بخوانید .
تابع (لوگر، ...)
enableLogging (logger) اطلاعات مربوط به اشکال زدایی را در کنسول ثبت می کند.
عملکرد (والد، ...)
فرزند (والد، مسیر) یک Reference برای مکان در مسیر نسبی مشخص شده دریافت می کند. مسیر نسبی می تواند یک نام ساده فرزند باشد (مثلاً "ada") یا یک مسیر جدا شده با اسلش عمیق تر (به عنوان مثال، "ada/name/first").
فشار (والد، ارزش) یک مکان فرزند جدید با استفاده از یک کلید منحصر به فرد ایجاد می کند و Reference آن را برمی گرداند. این رایج ترین الگو برای افزودن داده به مجموعه ای از موارد است. اگر مقداری برای push() ارائه دهید، مقدار در محل تولید شده نوشته می شود. اگر مقداری را ارسال نکنید، چیزی در پایگاه داده نوشته نمی‌شود و فرزند خالی می‌ماند (اما می‌توانید از Reference در جای دیگری استفاده کنید). کلیدهای منحصربه‌فرد تولید شده توسط push() بر اساس زمان فعلی مرتب شده‌اند، بنابراین فهرست موارد به‌دست‌آمده به ترتیب زمانی مرتب شده‌اند. کلیدها نیز به گونه ای طراحی شده اند که غیرقابل حدس زدن باشند (آنها حاوی 72 بیت تصادفی آنتروپی هستند). به پیوست به فهرست داده ها مراجعه کنید . به 2^120 روش برای اطمینان از شناسه های منحصر به فرد مراجعه کنید .
تابع (مسیر، ...)
orderByChild (مسیر) یک QueryConstraint جدید ایجاد می کند که با کلید فرزند مشخص شده مرتب می شود. پرس و جوها فقط می توانند با یک کلید در یک زمان سفارش دهند. چند بار فراخوانی orderByChild() در یک کوئری یک خطا است. پرس و جوهای Firebase به شما این امکان را می دهد که داده های خود را با هر کلید فرزندی که در حال پرواز است سفارش دهید. با این حال، اگر از قبل می‌دانید شاخص‌های شما چه هستند، می‌توانید برای عملکرد بهتر، آنها را از طریق قانون indexOn در قوانین امنیتی خود تعریف کنید. برای اطلاعات بیشتر به قانون https://firebase.google.com/docs/database/security/indexing-data مراجعه کنید. در Sort data می‌توانید درباره orderByChild() بیشتر بخوانید .
تابع (پرس و جو، ...)
دریافت (پرس و جو) به روزترین نتیجه را برای این پرس و جو دریافت می کند.
خاموش (پرس و جو، نوع رویداد، پاسخ به تماس) پاسخ تماسی را که قبلاً با شنونده مربوطه on () ( onValue ، onChildAdded ) متصل شده است جدا می کند. توجه: این روش توصیه شده برای حذف شنونده نیست. درعوض، لطفاً از تابع بازگشت به تماس از تابع مربوطه on تماس‌های برگشتی استفاده کنید. پاسخ تماسی را که قبلاً با on*() ضمیمه شده است جدا کنید. فراخوانی off() در شنونده والد به طور خودکار شنوندگان ثبت شده در گره های فرزند را حذف نمی کند، off() همچنین باید از هر شنونده فرزند برای حذف پاسخ تماس فراخوانی شود. اگر یک تماس برگشتی مشخص نشده باشد، همه تماس‌های برگشتی برای eventType مشخص شده حذف خواهند شد. به طور مشابه، اگر هیچ eventType مشخص نشده باشد، همه تماس های برگشتی برای Reference حذف خواهند شد. همچنین می‌توان شنوندگان فردی را با فراخوانی تماس‌های لغو اشتراک حذف کرد.
onChildAdded (پرس و جو، پاسخ به تماس، لغو پاسخ تماس) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildAdded یک بار برای هر فرزند اولیه در این مکان راه اندازی می شود، و هر بار که فرزند جدیدی اضافه می شود دوباره فعال می شود. DataSnapshot ارسال شده به callback داده ها را برای فرزند مربوطه منعکس می کند. برای مقاصد ترتیب، آرگومان دوم ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildAdded (پرس و جو، پاسخ به تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildAdded یک بار برای هر فرزند اولیه در این مکان راه اندازی می شود، و هر بار که فرزند جدیدی اضافه می شود دوباره فعال می شود. DataSnapshot ارسال شده به callback داده ها را برای فرزند مربوطه منعکس می کند. برای مقاصد ترتیب، آرگومان دوم ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildAdded (پرس و جو، پاسخ به تماس، لغو پاسخ تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildAdded یک بار برای هر فرزند اولیه در این مکان راه اندازی می شود، و هر بار که فرزند جدیدی اضافه می شود دوباره فعال می شود. DataSnapshot ارسال شده به callback داده ها را برای فرزند مربوطه منعکس می کند. برای مقاصد ترتیب، آرگومان دوم ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildChanged (پرس و جو، پاسخ به تماس، لغو پاسخ تماس) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. هنگامی که داده های ذخیره شده در یک فرزند (یا هر یک از فرزندان آن) تغییر کند، یک رویداد onChildChanged فعال می شود. توجه داشته باشید که یک رویداد child_changed ممکن است چندین تغییر را در فرزند نشان دهد. DataSnapshot ارسال شده به callback حاوی محتویات فرزند جدید خواهد بود. برای مقاصد سفارش، callback یک آرگومان دوم نیز ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildChanged (پرس و جو، پاسخ به تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. هنگامی که داده های ذخیره شده در یک فرزند (یا هر یک از فرزندان آن) تغییر کند، یک رویداد onChildChanged فعال می شود. توجه داشته باشید که یک رویداد child_changed ممکن است چندین تغییر را در فرزند نشان دهد. DataSnapshot ارسال شده به callback حاوی محتویات فرزند جدید خواهد بود. برای مقاصد سفارش، callback یک آرگومان دوم نیز ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildChanged (پرس و جو، پاسخ به تماس، لغو پاسخ تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. هنگامی که داده های ذخیره شده در یک فرزند (یا هر یک از فرزندان آن) تغییر کند، یک رویداد onChildChanged فعال می شود. توجه داشته باشید که یک رویداد child_changed ممکن است چندین تغییر را در فرزند نشان دهد. DataSnapshot ارسال شده به callback حاوی محتویات فرزند جدید خواهد بود. برای مقاصد سفارش، callback یک آرگومان دوم نیز ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildMoved (پرس و جو، پاسخ به تماس، لغو پاسخ تماس) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildMoved زمانی فعال می‌شود که ترتیب مرتب‌سازی کودک به گونه‌ای تغییر کند که موقعیت آن نسبت به خواهر و برادرش تغییر کند. DataSnapshot ارسال شده به callback مربوط به داده های فرزندی است که جابجا شده است. همچنین یک آرگومان دوم ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildMoved (پرس و جو، پاسخ به تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildMoved زمانی فعال می‌شود که ترتیب مرتب‌سازی کودک به گونه‌ای تغییر کند که موقعیت آن نسبت به خواهر و برادرش تغییر کند. DataSnapshot ارسال شده به callback مربوط به داده های فرزندی است که جابجا شده است. همچنین یک آرگومان دوم ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildMoved (پرس و جو، پاسخ به تماس، لغو پاسخ تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildMoved زمانی فعال می‌شود که ترتیب مرتب‌سازی کودک به گونه‌ای تغییر کند که موقعیت آن نسبت به خواهر و برادرش تغییر کند. DataSnapshot ارسال شده به callback مربوط به داده های فرزندی است که جابجا شده است. همچنین یک آرگومان دوم ارسال می‌شود که رشته‌ای حاوی کلید فرزند خواهر و برادر قبلی به ترتیب مرتب‌سازی است، یا اگر فرزند اول باشد، null .
onChildRemoved (پرس و جو، پاسخ به تماس، لغو پاسخ تماس) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildRemoved یک بار هر بار که یک کودک حذف می شود فعال می شود. DataSnapshot ارسال شده به callback داده های قدیمی فرزند حذف شده خواهد بود. یک کودک زمانی حذف می شود که: - یک کلاینت صراحتاً remove() روی آن فرزند یا یکی از اجدادش فرا می خواند - یک کلاینت set(null) روی آن فرزند یا یکی از اجدادش فراخوانی می کند - آن کودک همه فرزندانش را حذف کرده است - یک پرس و جو در حال اجراست که اکنون فرزند را فیلتر می کند (زیرا ترتیب مرتب سازی تغییر کرده یا حداکثر حد مجاز رسیده است)
onChildRemoved (پرس و جو، پاسخ به تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildRemoved یک بار هر بار که یک کودک حذف می شود فعال می شود. DataSnapshot ارسال شده به callback داده های قدیمی فرزند حذف شده خواهد بود. یک کودک زمانی حذف می شود که: - یک کلاینت صراحتاً remove() روی آن فرزند یا یکی از اجدادش فرا می خواند - یک کلاینت set(null) روی آن فرزند یا یکی از اجدادش فراخوانی می کند - آن کودک همه فرزندانش را حذف کرده است - یک پرس و جو در حال اجراست که اکنون فرزند را فیلتر می کند (زیرا ترتیب مرتب سازی تغییر کرده یا حداکثر حد مجاز رسیده است)
onChildRemoved (پرس و جو، پاسخ به تماس، لغو پاسخ تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onChildRemoved یک بار هر بار که یک کودک حذف می شود فعال می شود. DataSnapshot ارسال شده به callback داده های قدیمی فرزند حذف شده خواهد بود. یک کودک زمانی حذف می شود که: - یک کلاینت صراحتاً remove() روی آن فرزند یا یکی از اجدادش فرا می خواند - یک کلاینت set(null) روی آن فرزند یا یکی از اجدادش فراخوانی می کند - آن کودک همه فرزندانش را حذف کرده است - یک پرس و جو در حال اجراست که اکنون فرزند را فیلتر می کند (زیرا ترتیب مرتب سازی تغییر کرده یا حداکثر حد مجاز رسیده است)
onValue (پرس و جو، پاسخ به تماس، لغو پاسخ تماس) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onValue یک بار با داده های اولیه ذخیره شده در این مکان راه اندازی می شود و سپس هر بار که داده ها تغییر می کنند دوباره فعال می شود. DataSnapshot ارسال شده به callback مربوط به مکانی است که on() در آن فراخوانی شده است. تا زمانی که کل محتویات همگام سازی نشود، فعال نمی شود. اگر مکان داده ای نداشته باشد، با یک DataSnapshot خالی راه اندازی می شود ( val() null را برمی گرداند.
onValue (پرس و جو، پاسخ به تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onValue یک بار با داده های اولیه ذخیره شده در این مکان راه اندازی می شود و سپس هر بار که داده ها تغییر می کنند دوباره فعال می شود. DataSnapshot ارسال شده به callback مربوط به مکانی است که on() در آن فراخوانی شده است. تا زمانی که کل محتویات همگام سازی نشود، فعال نمی شود. اگر مکان داده ای نداشته باشد، با یک DataSnapshot خالی راه اندازی می شود ( val() null را برمی گرداند.
onValue (پرس و جو، پاسخ به تماس، لغو پاسخ تماس، گزینه ها) به تغییرات داده ها در یک مکان خاص گوش می دهد. این روش اصلی برای خواندن داده ها از پایگاه داده است. پاسخ تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر کند فعال می شود. برای توقف دریافت به‌روزرسانی، تماس برگشتی لغو اشتراک را فراخوانی کنید. برای جزئیات بیشتر به بازیابی داده ها در وب مراجعه کنید. یک رویداد onValue یک بار با داده های اولیه ذخیره شده در این مکان راه اندازی می شود و سپس هر بار که داده ها تغییر می کنند دوباره فعال می شود. DataSnapshot ارسال شده به callback مربوط به مکانی است که on() در آن فراخوانی شده است. تا زمانی که کل محتویات همگام سازی نشود، فعال نمی شود. اگر مکان داده‌ای نداشته باشد، با یک DataSnapshot خالی راه‌اندازی می‌شود ( val() null را برمی‌گرداند.
پرس و جو (پرس و جو، محدودیت های پرس و جو) یک نمونه تغییرناپذیر جدید از Query ایجاد می کند که شامل محدودیت های پرس و جو اضافی نیز می شود.
تابع (رجوع، ...)
onDisconnect(رجوع) یک شی OnDisconnect را برمی‌گرداند - برای اطلاعات بیشتر در مورد نحوه استفاده از آن ، به فعال کردن قابلیت‌های آفلاین در جاوا اسکریپت مراجعه کنید.
حذف (رجوع) داده ها را در این مکان پایگاه داده حذف می کند. هر گونه داده در مکان های کودک نیز حذف خواهد شد. اثر حذف بلافاصله قابل مشاهده خواهد بود و "مقدار" رویداد مربوطه فعال می شود. همگام سازی حذف با سرورهای Firebase نیز آغاز خواهد شد و Promise برگشتی پس از تکمیل حل خواهد شد. در صورت ارائه، پس از پایان همگام‌سازی، پاسخ تماس onComplete به صورت ناهمزمان فراخوانی می‌شود.
runTransaction (رجوع، به‌روزرسانی تراکنش، گزینه‌ها) داده ها را در این مکان به صورت اتمی اصلاح می کند. داده ها را در این مکان به صورت اتمی اصلاح کنید. بر خلاف یک set() معمولی که فقط داده ها را بدون توجه به مقدار قبلی آن بازنویسی می کند، runTransaction() برای تغییر مقدار موجود به یک مقدار جدید استفاده می شود و اطمینان حاصل می کند که هیچ تضادی با سایر کلاینت هایی که در همان مکان در همان مکان می نویسند وجود ندارد. . برای انجام این کار، تابع به‌روزرسانی runTransaction() را ارسال می‌کنید که برای تبدیل مقدار فعلی به یک مقدار جدید استفاده می‌شود. اگر مشتری دیگری قبل از اینکه مقدار جدید با موفقیت نوشته شود، در مکان بنویسد، تابع به روز رسانی شما دوباره با مقدار فعلی جدید فراخوانی می شود و نوشتن دوباره امتحان می شود. این کار به طور مکرر اتفاق می افتد تا زمانی که نوشتن شما بدون تضاد با موفقیت انجام شود یا با برگرداندن مقداری از عملکرد به روز رسانی خود، تراکنش را لغو کنید. توجه: اصلاح داده‌ها با set() هر تراکنش معلق در آن مکان را لغو می‌کند، بنابراین در صورت مخلوط کردن set() و runTransaction() برای به‌روزرسانی همان داده‌ها، باید بسیار مراقب باشید. توجه: هنگام استفاده از تراکنش‌هایی با قوانین امنیتی و Firebase در محل، توجه داشته باشید که یک کلاینت برای انجام تراکنش به دسترسی .read علاوه بر دسترسی .write نیاز دارد. این به این دلیل است که ماهیت سمت مشتری تراکنش‌ها به مشتری نیاز دارد که داده‌ها را بخواند تا به صورت تراکنشی آن‌ها را به‌روزرسانی کند.
مجموعه (رجوع، مقدار) داده ها را در این مکان پایگاه داده می نویسد. با این کار همه داده‌ها در این مکان و همه مکان‌های فرزند بازنویسی می‌شوند. اثر نوشتن بلافاصله قابل مشاهده خواهد بود و رویدادهای مربوطه ("ارزش"، "کودک_افزوده"، و غیره) فعال خواهند شد. همگام سازی داده ها با سرورهای Firebase نیز آغاز می شود و Promise برگشتی پس از تکمیل حل می شود. در صورت ارائه، پس از پایان همگام‌سازی، پاسخ تماس onComplete به صورت ناهمزمان فراخوانی می‌شود. ارسال null برای مقدار جدید معادل فراخوانی remove() است. یعنی همه داده‌های این مکان و همه مکان‌های فرزند حذف خواهند شد. set() هر اولویت ذخیره شده در این مکان را حذف می کند، بنابراین اگر قرار است اولویت حفظ شود، باید به جای آن از setWithPriority() استفاده کنید. توجه داشته باشید که اصلاح داده‌ها با set() هر تراکنش معلق در آن مکان را لغو می‌کند، بنابراین در صورت مخلوط کردن set() و transaction() برای اصلاح داده‌های مشابه باید بسیار مراقب باشید. یک set() منفرد یک رویداد "value" را در مکانی که set() انجام شده است ایجاد می کند.
setPriority (رجوع، اولویت) اولویتی را برای داده ها در این مکان پایگاه داده تعیین می کند. برنامه‌ها نیازی به استفاده از اولویت ندارند، اما می‌توانند مجموعه‌ها را بر اساس ویژگی‌های معمولی مرتب کنند (به مرتب‌سازی و فیلتر کردن داده‌ها مراجعه کنید).
setWithPriority (رجوع، مقدار، اولویت) داده ها را در محل پایگاه داده می نویسد. مانند set() اما اولویت را برای آن داده نیز مشخص می کند. برنامه‌ها نیازی به استفاده از اولویت ندارند، اما می‌توانند مجموعه‌ها را بر اساس ویژگی‌های معمولی مرتب کنند (به مرتب‌سازی و فیلتر کردن داده‌ها مراجعه کنید).
به روز رسانی (رجوع، مقادیر) چندین مقدار را همزمان در پایگاه داده می نویسد. آرگومان values ​​شامل چندین جفت ویژگی-مقدار است که با هم در پایگاه داده نوشته خواهند شد. هر ویژگی فرزند می تواند یک ویژگی ساده (مثلاً "نام") یا یک مسیر نسبی (مثلا "نام/اول") از مکان فعلی تا داده ها برای به روز رسانی باشد. برخلاف متد set() ، update() می توان برای به روز رسانی انتخابی تنها ویژگی های ارجاع شده در مکان فعلی استفاده کرد (به جای جایگزینی تمام ویژگی های فرزند در مکان فعلی). اثر نوشتن بلافاصله قابل مشاهده خواهد بود و رویدادهای مربوطه ('value', 'child_added', و غیره) فعال خواهند شد. همگام سازی داده ها با سرورهای Firebase نیز آغاز می شود و Promise برگشتی پس از تکمیل حل می شود. در صورت ارائه، پس از پایان همگام‌سازی، پاسخ تماس onComplete به صورت ناهمزمان فراخوانی می‌شود. یک update() تنها یک رویداد "value" را در مکانی که update() انجام شده است، بدون توجه به تعداد فرزندان اصلاح شده ایجاد می کند. توجه داشته باشید که اصلاح داده‌ها با update() هر تراکنش معلق در آن مکان را لغو می‌کند، بنابراین در صورت ترکیب update() و transaction() برای تغییر داده‌های یکسان، باید بسیار مراقب باشید. ارسال null به update() داده های این مکان را حذف می کند. به معرفی به‌روزرسانی‌های چند مکان و موارد دیگر مراجعه کنید .
تابع (مقدار، ...)
endAt (مقدار، کلید) یک QueryConstraint با نقطه پایان مشخص شده ایجاد می کند. استفاده از startAt() ، startAfter() ، endBefore() ، endAt() و equalTo() به شما امکان می دهد نقاط شروع و پایان دلخواه را برای پرس و جوهای خود انتخاب کنید. نقطه پایان شامل است، بنابراین کودکان با مقدار دقیقا مشخص شده در پرس و جو گنجانده می شوند. آرگومان کلید اختیاری را می توان برای محدود کردن بیشتر محدوده پرس و جو استفاده کرد. اگر مشخص شده باشد، فرزندانی که دقیقاً مقدار مشخص شده را دارند نیز باید نام کلیدی کمتر یا مساوی با کلید مشخص شده داشته باشند. در Filtering data می‌توانید درباره endAt() بیشتر بخوانید .
endBefore (مقدار، کلید) یک QueryConstraint با نقطه پایان مشخص شده (انحصاری) ایجاد می کند. استفاده از startAt() ، startAfter() ، endBefore() ، endAt() و equalTo() به شما امکان می دهد نقاط شروع و پایان دلخواه را برای پرس و جوهای خود انتخاب کنید. نقطه پایان منحصر به فرد است. اگر فقط یک مقدار ارائه شود، فرزندان با مقدار کمتر از مقدار مشخص شده در پرس و جو گنجانده می شوند. اگر یک کلید مشخص شده باشد، فرزندان باید مقدار کمتر یا مساوی با مقدار مشخص شده و نام کلید کمتر از کلید مشخص شده داشته باشند.
برابر (مقدار، کلید) یک QueryConstraint ایجاد می کند که شامل فرزندانی می شود که با مقدار مشخص شده مطابقت دارند. استفاده از startAt() ، startAfter() ، endBefore() ، endAt() و equalTo() به شما امکان می دهد نقاط شروع و پایان دلخواه را برای پرس و جوهای خود انتخاب کنید. آرگومان کلید اختیاری را می توان برای محدود کردن بیشتر محدوده پرس و جو استفاده کرد. اگر مشخص شده باشد، فرزندانی که دقیقاً مقدار مشخص شده را دارند باید دقیقاً کلید مشخص شده را به عنوان نام کلید خود داشته باشند. این می تواند برای فیلتر کردن مجموعه های نتایج با تعداد زیادی مطابق با مقدار مشابه استفاده شود. در Filtering data می توانید اطلاعات بیشتری در مورد equalTo() بخوانید .
startAfter (مقدار، کلید) یک QueryConstraint با نقطه شروع مشخص شده (انحصاری) ایجاد می کند. استفاده از startAt() ، startAfter() ، endBefore() ، endAt() و equalTo() به شما امکان می دهد نقاط شروع و پایان دلخواه را برای پرس و جوهای خود انتخاب کنید. نقطه شروع انحصاری است. اگر فقط یک مقدار ارائه شود، فرزندان با مقدار بیشتر از مقدار مشخص شده در پرس و جو گنجانده می شوند. اگر یک کلید مشخص شده باشد، فرزندان باید مقداری بزرگتر یا مساوی با مقدار مشخص شده و نام کلید aa بزرگتر از کلید مشخص شده داشته باشند.
startAt (مقدار، کلید) یک QueryConstraint با نقطه شروع مشخص شده ایجاد می کند. استفاده از startAt() ، startAfter() ، endBefore() ، endAt() و equalTo() به شما امکان می دهد نقاط شروع و پایان دلخواه را برای پرس و جوهای خود انتخاب کنید. نقطه شروع فراگیر است، بنابراین فرزندان دقیقاً با مقدار مشخص شده در پرس و جو گنجانده می شوند. آرگومان کلید اختیاری را می توان برای محدود کردن بیشتر محدوده پرس و جو استفاده کرد. اگر مشخص شده باشد، فرزندانی که دقیقاً مقدار مشخص شده را دارند نیز باید نام کلیدی بزرگتر یا مساوی با کلید مشخص شده داشته باشند. می‌توانید در Filtering data درباره startAt() بیشتر بخوانید .

کلاس ها

کلاس شرح
پایگاه داده کلاسی که یک پایگاه داده بیدرنگ Firebase را نشان می دهد.
DataSnapshot یک DataSnapshot حاوی داده هایی از یک مکان پایگاه داده است. هر زمان که داده‌ها را از پایگاه داده می‌خوانید، داده‌ها را به صورت DataSnapshot دریافت می‌کنید. یک DataSnapshot به تماس‌های رویدادی که با on() یا once() پیوست می‌کنید ارسال می‌شود. می توانید با فراخوانی متد val() محتویات اسنپ شات را به عنوان یک شی جاوا اسکریپت استخراج کنید. همچنین، می‌توانید با فراخوانی child() برای برگرداندن عکس‌های فوری کودک (که سپس می‌توانید val() روی آن فراخوانی کنید، به داخل عکس فوری بروید. DataSnapshot یک کپی کارآمد و غیرقابل تغییر از داده ها در یک مکان پایگاه داده است. نمی توان آن را تغییر داد و هرگز تغییر نخواهد کرد (برای اصلاح داده ها، همیشه متد set() را مستقیماً در یک Reference فراخوانی می کنید).
OnDisconnect کلاس onDisconnect به شما امکان می دهد زمانی که کلاینت شما از سرور پایگاه داده قطع می شود، داده ها را بنویسید یا پاک کنید. این به‌روزرسانی‌ها، چه ارتباط کلاینت شما به‌طور تمیز قطع شود یا نه، رخ می‌دهند، بنابراین می‌توانید برای پاک‌سازی داده‌ها به آن‌ها اعتماد کنید، حتی اگر اتصال قطع شود یا کلاینت خراب شود. کلاس onDisconnect معمولاً برای مدیریت حضور در برنامه‌هایی استفاده می‌شود که در آن تشخیص تعداد کلاینت‌ها و زمانی که دیگر کلاینت‌ها قطع می‌شوند مفید است. برای اطلاعات بیشتر به فعال کردن قابلیت‌های آفلاین در جاوا اسکریپت مراجعه کنید. برای جلوگیری از بروز مشکل در هنگام قطع اتصال قبل از انتقال درخواست ها به سرور پایگاه داده، این توابع باید قبل از نوشتن هر داده ای فراخوانی شوند. توجه داشته باشید که عملیات onDisconnect فقط یک بار راه اندازی می شود. اگر می‌خواهید هر بار که قطع ارتباط می‌شود، عملیاتی رخ دهد، باید هر بار که دوباره وصل می‌شوید، عملیات onDisconnect را مجدداً برقرار کنید.
QueryConstraint QueryConstraint برای محدود کردن مجموعه اسناد بازگردانده شده توسط یک کوئری پایگاه داده استفاده می شود. QueryConstraint ها با فراخوانی endAt() ایجاد می شوند. ، endBefore() ، شروع کن در() ، startAfter() ، limitToFirst() ، limitToLast() ، orderByChild() ، orderByChild() ، orderByKey() ، orderByPriority() ، orderByValue() یا qualTo() و سپس می توان به query() ارسال کرد تا یک نمونه query جدید ایجاد کند که حاوی این QueryConstraint نیز باشد.
نتیجه تراکنش نوعی برای مقدار رزولوشن runTransaction() .

رابط ها

رابط شرح
مرجع پایگاه داده DatabaseReference یک مکان خاص در پایگاه داده شما را نشان می دهد و می تواند برای خواندن یا نوشتن داده ها در آن مکان پایگاه داده استفاده شود. می توانید با فراخوانی ref() یا ref("child/path") ریشه یا محل فرزند در پایگاه داده خود اشاره کنید. نوشتن با متد set() و خواندن با متد on*() انجام می شود. به https://firebase.google.com/docs/database/web/read-and-write مراجعه کنید
IteratedDataSnapshot نشان دهنده یک عکس فوری کودک از یک Reference است که در حال تکرار است. کلید هرگز تعریف نشده نخواهد بود.
ListenOptions اشیاء گزینه ای که می توان از آنها برای سفارشی کردن شنونده استفاده کرد.
پرس و جو یک Query و جو داده ها را در یک مکان پایگاه داده مرتب و فیلتر می کند تا فقط زیر مجموعه ای از داده های فرزند گنجانده شود. این می تواند برای سفارش مجموعه ای از داده ها بر اساس برخی ویژگی ها (مثلاً ارتفاع دایناسورها) و همچنین برای محدود کردن لیست بزرگی از موارد (به عنوان مثال، پیام های چت) به تعداد مناسب برای همگام سازی با مشتری استفاده شود. کوئری ها با زنجیر کردن یک یا چند روش فیلتر تعریف شده در اینجا ایجاد می شوند. درست مانند DatabaseReference ، می‌توانید با استفاده از روش‌های on*() داده‌ها را از یک Query دریافت کنید. شما فقط رویدادها و DataSnapshot را برای زیرمجموعه داده هایی دریافت خواهید کرد که با درخواست شما مطابقت دارند. برای اطلاعات بیشتر به https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data مراجعه کنید.
ThenableReference یک Promise که همچنین می تواند به عنوان یک DatabaseReference در صورت بازگشت توسط push() عمل کند. . مرجع فوراً در دسترس است و Promise با تکمیل نوشتن در backend حل می شود.
گزینه های تراکنش یک گزینه برای پیکربندی تراکنش ها مخالف است.

نام مستعار را تایپ کنید

نام مستعار را تایپ کنید شرح
نوع رویداد یکی از رشته های زیر: "value"، "child_added"، "child_changed"، "child_removed" یا "child_moved."
QueryConstraintType محدودیت‌های جستجوی مختلف موجود در این SDK را شرح می‌دهد.
لغو اشتراک تماسی که می تواند برای حذف شنونده فراخوانی شود.

عملکرد (برنامه، ...)

getDatabase (برنامه، آدرس اینترنتی)

نمونه SDK پایگاه داده بیدرنگ را که با FirebaseApp ارائه شده مرتبط است، برمی گرداند. . در صورت عدم وجود نمونه یا اینکه نمونه موجود از URL پایگاه داده سفارشی استفاده می کند ، یک نمونه جدید را با تنظیمات پیش فرض آغاز می کند.

امضا:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

مولفه های

پارامتر تایپ کنید شرح
برنامه Firebase App نمونه Firebaseapp که نمونه پایگاه داده Realime برگشتی با آن همراه است.
آدرس اینترنتی رشته URL نمونه پایگاه داده Realtime برای اتصال به. در صورت عدم ارائه ، SDK به نمونه پیش فرض برنامه Firebase متصل می شود.

برمی گرداند:

پایگاه داده

نمونه Database برنامه ارائه شده.

عملکرد (db ، ...)

ConnectDatabaseEmulator (DB ، میزبان ، پورت ، گزینه ها)

برای برقراری ارتباط با شبیه ساز پایگاه داده Realtime ، نمونه ارائه شده را اصلاح کنید.

توجه: این روش باید قبل از انجام هرگونه عملیات دیگر فراخوانی شود.

امضا:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

مولفه های

پارامتر تایپ کنید شرح
دسی بی پایگاه داده نمونه برای اصلاح.
میزبان رشته میزبان شبیه ساز (سابق: localhost)
بندر عدد پورت شبیه ساز (سابق: 8080)
گزینه ها {mockusertoken ؟: emulatormocktokenoptions | رشته؛ }

برمی گرداند:

خالی

GOOFFLINE (DB)

قطع از سرور (کلیه عملیات پایگاه داده به صورت آفلاین تکمیل می شود).

مشتری به طور خودکار اتصال مداوم به سرور پایگاه داده را حفظ می کند ، که به طور نامحدود فعال خواهد بود و هنگام قطع ارتباط مجدد می شود. با این حال ، روش های goOffline() و goOnline() ممکن است برای کنترل اتصال مشتری در مواردی که اتصال مداوم نامطلوب باشد استفاده شود.

در حالی که آفلاین است ، مشتری دیگر به روزرسانی های داده را از پایگاه داده دریافت نمی کند. با این حال ، تمام عملیات بانک اطلاعاتی که به صورت محلی انجام می شود ، بلافاصله وقایع را به آتش می کشند و به شما امکان می دهد به طور عادی به رفتار خود ادامه دهد. علاوه بر این ، هر عملیاتی که به صورت محلی انجام می شود ، به طور خودکار صف می شود و پس از اتصال مجدد به سرور پایگاه داده ، مجدداً مجدداً مجدداً مجدداً صف بندی می شود.

برای اتصال مجدد به پایگاه داده و شروع به دریافت رویدادهای از راه دور ، به goOnline() .

امضا:

export declare function goOffline(db: Database): void;

مولفه های

پارامتر تایپ کنید شرح
دسی بی پایگاه داده نمونه برای قطع ارتباط.

برمی گرداند:

خالی

Goonline (DB)

دوباره به سرور وصل می شود و حالت پایگاه داده آفلاین را با حالت سرور همگام می کند.

این روش باید پس از غیرفعال کردن اتصال فعال با goOffline() استفاده شود . پس از اتصال مجدد ، مشتری داده های مناسب را منتقل می کند و رویدادهای مناسب را آتش می زند تا مشتری شما به طور خودکار "صعود کند".

امضا:

export declare function goOnline(db: Database): void;

مولفه های

پارامتر تایپ کنید شرح
دسی بی پایگاه داده نمونه برای اتصال مجدد.

برمی گرداند:

خالی

Ref (DB ، مسیر)

Reference را نشان می دهد که مکان را در پایگاه داده متناسب با مسیر ارائه شده نشان می دهد. در صورت عدم ارائه مسیری ، Reference به ریشه پایگاه داده اشاره خواهد کرد.

امضا:

export declare function ref(db: Database, path?: string): DatabaseReference;

مولفه های

پارامتر تایپ کنید شرح
دسی بی پایگاه داده نمونه بانک اطلاعاتی برای به دست آوردن مرجع برای.
مسیر رشته مسیر اختیاری نمایانگر مکانی است که Reference برگشتی به آن اشاره خواهد کرد. در صورت عدم ارائه ، Reference برگشتی به ریشه پایگاه داده اشاره خواهد کرد.

برمی گرداند:

پایگاه داده

در صورت ارائه مسیری ، Reference اشاره به مسیر ارائه شده. در غیر این صورت ، Reference اشاره به ریشه بانک اطلاعاتی.

reffromurl (db ، url)

یک Reference نشان می دهد که مکان در پایگاه داده مربوط به URL Firebase ارائه شده را نشان می دهد.

اگر URL یک URL معتبر پایگاه داده Firebase نباشد یا دامنه متفاوتی نسبت به نمونه Database فعلی داشته باشد ، یک استثناء پرتاب می شود.

توجه داشته باشید که تمام پارامترهای پرس و جو ( orderBy ، limitToLast ، و غیره) نادیده گرفته می شوند و در Reference برگشتی اعمال نمی شوند .

امضا:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

مولفه های

پارامتر تایپ کنید شرح
دسی بی پایگاه داده نمونه بانک اطلاعاتی برای به دست آوردن مرجع برای.
آدرس اینترنتی رشته URL Firebase که در آن Reference برگشتی به آن اشاره خواهد کرد.

برمی گرداند:

پایگاه داده

Reference اشاره به URL Firebase ارائه شده.

تابع()

forcelongpolling ()

به جای وب سایت ، استفاده از Polling را مجبور کنید. اگر از پروتکل WebSocket در DatabaseUrl استفاده شود ، این امر نادیده گرفته می شود.

امضا:

export declare function forceLongPolling(): void;

برمی گرداند:

خالی

forcewebsockets ()

به جای طولانی شدن ، استفاده از شبکه های وب را مجبور کنید.

امضا:

export declare function forceWebSockets(): void;

برمی گرداند:

خالی

OrderByKey ()

QueryConstraint جدید را ایجاد می کند که توسط کلید سفارش می دهد.

نتایج یک پرس و جو را بر اساس مقادیر کلیدی (صعودی) آنها مرتب می کند.

می توانید اطلاعات بیشتر در مورد orderByKey() را در داده های مرتب سازی بخوانید .

امضا:

export declare function orderByKey(): QueryConstraint;

برمی گرداند:

بازپرسی

OrderByPriority ()

QueryConstraint جدید را ایجاد می کند که با اولویت سفارش می دهد.

برنامه ها نیازی به استفاده از اولویت ندارند اما می توانند مجموعه ها را با ویژگی های معمولی سفارش دهند (برای گزینه های دیگر برای اولویت ، به مرتب سازی داده ها مراجعه کنید.

امضا:

export declare function orderByPriority(): QueryConstraint;

برمی گرداند:

بازپرسی

OrderByValue ()

QueryConstraint جدید را ایجاد می کند که با ارزش سفارش می دهد.

اگر فرزندان یک پرس و جو همه مقادیر مقیاس پذیر (رشته ، تعداد یا بولی) هستند ، می توانید نتایج را با مقادیر (صعودی) آنها سفارش دهید.

می توانید اطلاعات بیشتری در مورد orderByValue() در داده های مرتب سازی بخوانید .

امضا:

export declare function orderByValue(): QueryConstraint;

برمی گرداند:

بازپرسی

servertimestamp ()

مقدار نگهدارنده مکان را برای جمع آوری خودکار زمان بندی فعلی (زمان از زمان UNIX ، در میلی ثانیه) که توسط سرورهای Firebase تعیین می شود ، برمی گرداند.

امضا:

export declare function serverTimestamp(): object;

برمی گرداند:

هدف - شی

عملکرد (دلتا ، ...)

افزایش (دلتا)

یک مقدار مکان نگهدارنده را که می تواند برای افزایش اتمی مقدار پایگاه داده فعلی توسط دلتا ارائه شده استفاده می کند ، برمی گرداند.

امضا:

export declare function increment(delta: number): object;

مولفه های

پارامتر تایپ کنید شرح
دلتا عدد مبلغ برای تغییر مقدار فعلی به صورت اتمی.

برمی گرداند:

هدف - شی

یک مقدار نگهدارنده مکان برای اصلاح داده ها به صورت سرور آتمی.

عملکرد (فعال ، ...)

enableLogging (فعال، مداوم)

اطلاعات مربوط به اشکال زدایی را به کنسول وارد کنید.

امضا:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

مولفه های

پارامتر تایپ کنید شرح
فعال شد بولی ورود به سیستم اگر true false ورود به سیستم را غیرفعال می کند.
مداوم بولی در صورت true ، وضعیت ورود به سیستم را بین تازه کردن صفحه به یاد می آورد.

برمی گرداند:

هر

عملکرد (حد ، ...)

limittofirst (حد)

QueryConstraint جدید ایجاد می کند که اگر به اولین تعداد خاص کودکان محدود شود.

از روش limitToFirst() برای تعیین حداکثر تعداد کودکانی که برای پاسخ به تماس مشخص شده همگام سازی می شوند ، استفاده می شود. اگر حد 100 را تعیین کنیم ، در ابتدا فقط 100 رویداد child_added دریافت خواهیم کرد. اگر کمتر از 100 پیام ذخیره شده در پایگاه داده خود داشته باشیم ، یک رویداد child_added برای هر پیام آتش می گیرد. با این حال ، اگر بیش از 100 پیام داشته باشیم ، فقط برای 100 پیام سفارش داده شده فقط یک رویداد child_added دریافت خواهیم کرد. با تغییر موارد ، ما برای هر موردی که از لیست فعال خارج می شود ، رویدادهای child_removed را دریافت خواهیم کرد تا تعداد کل در 100 باقی بماند.

می توانید اطلاعات بیشتر در مورد limitToFirst() را در فیلتر کردن داده ها بخوانید .

امضا:

export declare function limitToFirst(limit: number): QueryConstraint;

مولفه های

پارامتر تایپ کنید شرح
حد عدد حداکثر تعداد گره هایی که در این پرس و جو وجود دارد.

برمی گرداند:

بازپرسی

Limittolast (حد)

یک QueryConstraint جدید ایجاد می کند که محدود به بازگشت تنها آخرین تعداد مشخص شده کودکان است.

از روش limitToLast() برای تعیین حداکثر تعداد کودکان برای همگام سازی برای پاسخ به تماس مشخص استفاده می شود. اگر حد 100 را تعیین کنیم ، در ابتدا فقط 100 رویداد child_added دریافت خواهیم کرد. اگر کمتر از 100 پیام ذخیره شده در پایگاه داده خود داشته باشیم ، یک رویداد child_added برای هر پیام آتش می گیرد. با این حال ، اگر بیش از 100 پیام داشته باشیم ، فقط برای 100 پیام سفارش داده شده فقط یک رویداد child_added دریافت خواهیم کرد. با تغییر موارد ، ما برای هر موردی که از لیست فعال خارج می شود ، رویدادهای child_removed را دریافت خواهیم کرد تا تعداد کل در 100 باقی بماند.

می توانید اطلاعات بیشتر در مورد limitToLast() را در فیلتر کردن داده ها بخوانید .

امضا:

export declare function limitToLast(limit: number): QueryConstraint;

مولفه های

پارامتر تایپ کنید شرح
حد عدد حداکثر تعداد گره هایی که در این پرس و جو وجود دارد.

برمی گرداند:

بازپرسی

عملکرد (logger ، ...)

EnableLogging (logger)

اطلاعات مربوط به اشکال زدایی را به کنسول وارد کنید.

امضا:

export declare function enableLogging(logger: (message: string) => unknown): any;

مولفه های

پارامتر تایپ کنید شرح
متمرکز ساز (پیام: رشته) => ناشناخته یک تابع logger سفارشی برای کنترل نحوه ورود به سیستم.

برمی گرداند:

هر

عملکرد (والدین ، ​​...)

فرزند (والدین ، ​​مسیر)

برای مکان در مسیر نسبی مشخص Reference می شود.

مسیر نسبی می تواند یک نام کودک ساده (به عنوان مثال ، "ADA") یا یک مسیر جدا شده عمیق تر (به عنوان مثال ، "ADA/Name/First") باشد.

امضا:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

مولفه های

پارامتر تایپ کنید شرح
والدین پایگاه داده محل والدین
مسیر رشته یک مسیر نسبی از این مکان به محل مورد نظر کودک.

برمی گرداند:

پایگاه داده

مکان مشخص شده کودک

فشار (والدین ، ​​ارزش)

با استفاده از یک کلید منحصر به فرد ، یک مکان کودک جدید ایجاد می کند و Reference خود را برمی گرداند .

این رایج ترین الگوی برای افزودن داده ها به مجموعه ای از موارد است.

اگر مقدار push() ، مقدار به مکان تولید شده نوشته شده است. اگر ارزشی را منتقل نکنید ، هیچ چیز به پایگاه داده نوشته نمی شود و کودک خالی باقی می ماند (اما می توانید از Reference در جای دیگر استفاده کنید).

کلیدهای منحصر به فرد تولید شده توسط push() توسط زمان فعلی سفارش داده می شوند ، بنابراین لیست حاصل از موارد از نظر زمانی مرتب شده است. کلیدها همچنین به گونه ای طراحی شده اند که غیرقابل توصیف باشند (آنها حاوی 72 بیت تصادفی آنتروپی هستند).

به لیستی از داده ها مراجعه کنید . 2^120 راه را برای اطمینان از شناسه های منحصر به فرد مشاهده کنید .

امضا:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

مولفه های

پارامتر تایپ کنید شرح
والدین پایگاه داده محل والدین
ارزش ناشناخته مقدار اختیاری که در مکان تولید شده نوشته شود.

برمی گرداند:

theneableereference

Promise و Reference ترکیبی ; حل و فصل هنگامی که نوشتن کامل است ، اما می تواند بلافاصله به عنوان Reference محل کودک استفاده شود.

عملکرد (مسیر ، ...)

OrderByChild (مسیر)

QueryConstraint جدید را ایجاد می کند که توسط کلید مشخص شده کودک سفارش می دهد.

نمایش داده شد فقط می توانند با یک کلید به طور همزمان سفارش دهند. فراخوانی orderByChild() چندین بار در همان پرس و جو یک خطا است.

نمایش داده های Firebase به شما امکان می دهد داده های خود را توسط هر کلید کودک در پرواز سفارش دهید. با این حال ، اگر از قبل می دانید که شاخص های شما چه خواهد بود ، می توانید برای عملکرد بهتر آنها را از طریق قانون .indexon در قوانین امنیتی خود تعریف کنید. برای اطلاعات بیشتر به https://firebase.google.com/docs/database/securance/indexing-data مراجعه کنید.

می توانید اطلاعات بیشتر در مورد orderByChild() را در داده های مرتب بخوانید .

امضا:

export declare function orderByChild(path: string): QueryConstraint;

مولفه های

پارامتر تایپ کنید شرح
مسیر رشته مسیر سفارش توسط.

برمی گرداند:

بازپرسی

عملکرد (پرس و جو ، ...)

دریافت (پرس و جو)

برای این پرس و جو بیشترین نتیجه را کسب می کند.

امضا:

export declare function get(query: Query): Promise<DataSnapshot>;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.

برمی گرداند:

قول < dataSnapShot >

Promise ای که در صورت وجود یک مقدار در دسترس است ، به DataSnapshot نتیجه می رسد ، یا اگر مشتری نتواند یک مقدار را برگرداند (به عنوان مثال ، اگر سرور غیرقابل دسترسی باشد و هیچ چیزی ذخیره نشده باشد) رد می شود.

خاموش (پرس و جو، نوع رویداد، پاسخ به تماس)

یک پاسخ به تماس قبلی را که قبلاً با on*() مربوطه وصل شده است جدا می کند ( onValue onChildAdded ) شنونده. توجه: این روش توصیه شده برای حذف شنونده نیست. درعوض ، لطفاً از عملکرد برگشتی برگشتی از on* های مربوطه استفاده کنید.

برگشتی را که قبلاً on*() وصل شده بود جدا کنید . تماس off() در مورد شنونده والدین ، ​​شنوندگان ثبت شده در گره های کودک را به طور خودکار حذف نمی کند ، off() نیز باید از هر کودک شنونده خواسته شود تا پاسخ تماس را حذف کنند.

اگر پاسخ به تماس مشخص نشده باشد ، تمام تماس های برگشتی برای رویداد مشخص شده حذف می شود. به همین ترتیب ، اگر هیچ EventType مشخص نشده باشد ، تمام تماس های تماس برای Reference حذف می شوند.

شنوندگان انفرادی همچنین می توانند با استناد به تماس های لغو اشتراک خود حذف شوند.

امضا:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو که شنونده در آن ثبت شده است.
نوع رویداد نوع رویداد یکی از رشته های زیر: "ارزش" ، "Child_added" ، "Child_changed" ، "Child_removed" یا "Child_moved". در صورت حذف ، تمام تماسهای برگشتی برای Reference حذف می شوند.
پاسخ به تماس (عکس فوری: DataSnapShot ، پیشین نام: رشته | تهی) => ناشناخته عملکرد پاسخ به تماس که on() منتقل شده است یا undefined تا همه تماس های برگشتی را حذف کند.

برمی گرداند:

خالی

onchildadded (پرس و جو ، پاسخ به تماس ، CancelCallback)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

یک رویداد onChildAdded یک بار برای هر کودک اولیه در این مکان ایجاد می شود و هر بار که یک کودک جدید اضافه می شود ، دوباره شروع می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، داده های مربوط به کودک مربوطه را منعکس می کند. برای اهداف سفارش ، یک آرگومان دوم تصویب می شود که یک رشته حاوی کلید فرزند خواهر و برادر قبلی با ترتیب مرتب سازی یا null در صورت فرزند اول است.

امضا:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، پیشین نام: رشته | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildadded (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

یک رویداد onChildAdded یک بار برای هر کودک اولیه در این مکان ایجاد می شود و هر بار که یک کودک جدید اضافه می شود ، دوباره شروع می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، داده های مربوط به کودک مربوطه را منعکس می کند. برای اهداف سفارش ، یک آرگومان دوم تصویب می شود که یک رشته حاوی کلید فرزند خواهر و برادر قبلی با ترتیب مرتب سازی یا null در صورت فرزند اول است.

امضا:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، قبلی ChildName: String | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildadded (پرس و جو ، پاسخ به تماس ، لغو ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

یک رویداد onChildAdded یک بار برای هر کودک اولیه در این مکان ایجاد می شود و هر بار که یک کودک جدید اضافه می شود ، دوباره شروع می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، داده های مربوط به کودک مربوطه را منعکس می کند. برای اهداف سفارش ، یک آرگومان دوم تصویب می شود که یک رشته حاوی کلید فرزند خواهر و برادر قبلی با ترتیب مرتب سازی یا null در صورت فرزند اول است.

امضا:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، قبلی ChildName: String | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildChanged (پرس و جو ، پاسخ به تماس ، لغو مکالمه)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هنگامی که داده های ذخیره شده در کودک (یا هر یک از فرزندان آن) تغییر می کنند ، یک رویداد onChildChanged ایجاد می شود. توجه داشته باشید که یک رویداد تنها child_changed ممکن است نشان دهنده تغییرات متعدد در کودک باشد. DataSnapshot که به پاسخ به تماس منتقل شده است ، حاوی محتوای کودک جدید خواهد بود. برای اهداف سفارش ، پاسخ به تماس نیز یک آرگومان دوم منتقل می شود که رشته ای حاوی کلید کودک خواهر و برادر قبلی با مرتب سازی مرتب سازی یا null در صورت فرزند اول است.

امضا:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، قبلی ChildName: String | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildchanged (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هنگامی که داده های ذخیره شده در کودک (یا هر یک از فرزندان آن) تغییر می کنند ، یک رویداد onChildChanged ایجاد می شود. توجه داشته باشید که یک رویداد تنها child_changed ممکن است نشان دهنده تغییرات متعدد در کودک باشد. DataSnapshot که به پاسخ به تماس منتقل شده است ، حاوی محتوای کودک جدید خواهد بود. برای اهداف سفارش ، پاسخ به تماس نیز یک آرگومان دوم منتقل می شود که رشته ای حاوی کلید کودک خواهر و برادر قبلی با مرتب سازی مرتب سازی یا null در صورت فرزند اول است.

امضا:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، قبلی ChildName: String | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildchanged (پرس و جو ، پاسخ به تماس ، لغو ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هنگامی که داده های ذخیره شده در کودک (یا هر یک از فرزندان آن) تغییر می کنند ، یک رویداد onChildChanged ایجاد می شود. توجه داشته باشید که یک رویداد تنها child_changed ممکن است نشان دهنده تغییرات متعدد در کودک باشد. DataSnapshot که به پاسخ به تماس منتقل شده است ، حاوی محتوای کودک جدید خواهد بود. برای اهداف سفارش ، پاسخ به تماس نیز یک آرگومان دوم منتقل می شود که رشته ای حاوی کلید کودک خواهر و برادر قبلی با مرتب سازی مرتب سازی یا null در صورت فرزند اول است.

امضا:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، قبلی ChildName: String | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onChildMoved (پرس و جو، پاسخ به تماس، لغو پاسخ تماس)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هنگامی که ترتیب مرتب سازی کودک تغییر می کند به گونه ای که موقعیت آن نسبت به خواهر و برادرهای آن تغییر کند ، یک رویداد onChildMoved ایجاد می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، برای داده های کودک منتقل شده خواهد بود. همچنین یک آرگومان دوم به تصویب می رسد که رشته ای حاوی کلید فرزند خواهر و برادر قبلی با مرتب سازی مرتب است ، یا اگر فرزند اول باشد null .

امضا:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، قبلی ChildName: String | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildmoved (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هنگامی که ترتیب مرتب سازی کودک تغییر می کند به گونه ای که موقعیت آن نسبت به خواهر و برادرهای آن تغییر کند ، یک رویداد onChildMoved ایجاد می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، برای داده های کودک منتقل شده خواهد بود. همچنین یک آرگومان دوم به تصویب می رسد که رشته ای حاوی کلید فرزند خواهر و برادر قبلی با مرتب سازی مرتب است ، یا اگر فرزند اول باشد null .

امضا:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، قبلی ChildName: String | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildmoved (پرس و جو ، پاسخ به تماس ، لغو ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هنگامی که ترتیب مرتب سازی کودک تغییر می کند به گونه ای که موقعیت آن نسبت به خواهر و برادرهای آن تغییر کند ، یک رویداد onChildMoved ایجاد می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، برای داده های کودک منتقل شده خواهد بود. همچنین یک آرگومان دوم به تصویب می رسد که رشته ای حاوی کلید فرزند خواهر و برادر قبلی با مرتب سازی مرتب است ، یا اگر فرزند اول باشد null .

امضا:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ، قبلی ChildName: String | تهی) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildremoved (پرس و جو ، پاسخ به تماس ، CancelCallback)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هر بار که کودک برداشته می شود ، یک رویداد onChildRemoved یک بار ایجاد می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، داده های قدیمی برای کودک حذف شده خواهد بود. کودک در صورت هر دو حذف می شود:

  • یک مشتری صریحاً با آن کودک یا یکی از اجداد خود تماس می remove() - مشتری با آن کودک یا یکی از اجداد خود تماس می set(null) - آن کودک همه فرزندان خود را برداشته است - یک پرس و جو وجود دارد که اکنون فیلتر می شود از کودک (زیرا این نوع مرتب سازی شده تغییر کرده است یا حداکثر حد ضربه زده شده است)

امضا:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildremoved (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هر بار که کودک برداشته می شود ، یک رویداد onChildRemoved یک بار ایجاد می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، داده های قدیمی برای کودک حذف شده خواهد بود. کودک در صورت هر دو حذف می شود:

  • یک مشتری صریحاً با آن کودک یا یکی از اجداد خود تماس می remove() - مشتری با آن کودک یا یکی از اجداد خود تماس می set(null) - آن کودک همه فرزندان خود را برداشته است - یک پرس و جو وجود دارد که اکنون فیلتر می شود از کودک (زیرا این نوع مرتب سازی شده تغییر کرده است یا حداکثر حد ضربه زده شده است)

امضا:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

onchildremoved (پرس و جو ، پاسخ به تماس ، لغو ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

هر بار که کودک برداشته می شود ، یک رویداد onChildRemoved یک بار ایجاد می شود. DataSnapshot که به تماس تلفنی منتقل می شود ، داده های قدیمی برای کودک حذف شده خواهد بود. کودک در صورت هر دو حذف می شود:

  • یک مشتری صریحاً با آن کودک یا یکی از اجداد خود تماس می remove() - مشتری با آن کودک یا یکی از اجداد خود تماس می set(null) - آن کودک همه فرزندان خود را برداشته است - یک پرس و جو وجود دارد که اکنون فیلتر می شود از کودک (زیرا این نوع مرتب سازی شده تغییر کرده است یا حداکثر حد ضربه زده شده است)

امضا:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با یک DataSnapshot و یک رشته حاوی کلید کودک قبلی ، با مرتب سازی سفارش یا null در صورت فرزند اول ، منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

OnValue (پرس و جو ، پاسخ به تماس ، لغولکبله)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

یک رویداد onValue یک بار با داده های اولیه ذخیره شده در این مکان ایجاد می شود و هر بار که داده ها تغییر می کنند دوباره شروع می شوند. DataSnapshot که به تماس تلفنی منتقل می شود ، برای مکانی است که on() در آن نامیده می شود. تا زمانی که کل محتویات هماهنگ نشود ، شروع نمی شود. اگر مکان داده ای نداشته باشد ، با یک DataSnapshot خالی ( val() null باز می گردد ).

امضا:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با DataSnapshot منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

OnValue (پرس و جو ، پاسخ به تماس ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

یک رویداد onValue یک بار با داده های اولیه ذخیره شده در این مکان ایجاد می شود و هر بار که داده ها تغییر می کنند دوباره شروع می شوند. DataSnapshot که به تماس تلفنی منتقل می شود ، برای مکانی است که on() در آن نامیده می شود. تا زمانی که کل محتویات هماهنگ نشود ، شروع نمی شود. اگر مکان داده ای نداشته باشد ، با یک DataSnapshot خالی ( val() null باز می گردد ).

امضا:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با DataSnapshot منتقل می شود.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

OnValue (پرس و جو ، پاسخ به تماس ، لغولک ، گزینه ها)

برای تغییر داده ها در یک مکان خاص گوش می دهد.

این روش اصلی برای خواندن داده ها از یک پایگاه داده است. پاسخ به تماس شما برای داده های اولیه و دوباره هر زمان که داده ها تغییر می کنند ، ایجاد می شود. برای متوقف کردن دریافت به روزرسانی ، از پاسخ به تماس برگشتی بازگردانده شده استفاده کنید. برای اطلاعات بیشتر به داده های بازیابی در وب مراجعه کنید.

یک رویداد onValue یک بار با داده های اولیه ذخیره شده در این مکان ایجاد می شود و هر بار که داده ها تغییر می کنند دوباره شروع می شوند. DataSnapshot که به تماس تلفنی منتقل می شود ، برای مکانی است که on() در آن نامیده می شود. تا زمانی که کل محتویات هماهنگ نشود ، شروع نمی شود. اگر مکان داده ای نداشته باشد ، با یک DataSnapshot خالی ( val() null باز می گردد ).

امضا:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو پرس و جو برای اجرا.
پاسخ به تماس (عکس فوری: DataSnapShot ) => ناشناخته پاسخ به تماس که هنگام وقوع رویداد مشخص شده آتش می گیرد. پاسخ به تماس با DataSnapshot منتقل می شود.
CancelCallback (خطا: خطا) => ناشناخته پاسخ به تماس اختیاری که اگر اشتراک رویداد شما همیشه لغو شود ، به شما اطلاع داده می شود زیرا مشتری شما مجوز خواندن این داده ها را ندارد (یا اجازه داده است اما اکنون آن را از دست داده است). این پاسخ به تماس با یک شیء Error منتقل می شود که نشان می دهد چرا این خرابی رخ داده است.
گزینه ها گوش دادن به شیئی که می تواند برای پیکربندی onlyOnce استفاده شود ، که پس از اولین دعوت خود ، شنونده را حذف می کند.

برمی گرداند:

لغو اشتراک

تابعی که می تواند برای حذف شنونده استفاده شود.

پرس و جو (پرس و جو، محدودیت های پرس و جو)

یک نمونه تغییر ناپذیر جدید از Query ایجاد می کند که گسترش می یابد و شامل محدودیت های پرس و جو اضافی نیز می شود.

امضا:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

مولفه های

پارامتر تایپ کنید شرح
پرس و جو پرس و جو نمونه پرس و جو برای استفاده به عنوان پایه ای برای محدودیت های جدید.
باز پرس و جو بازپرسی [] لیست QueryConstraint S برای اعمال.

برمی گرداند:

پرس و جو

استثناها

اگر هیچ یک از محدودیت های پرس و جو ارائه شده با محدودیت های موجود یا جدید قابل ترکیب نباشد.

عملکرد (Ref ، ...)

ondisconnect (Ref)

یک شیء OnDisconnect را برمی گرداند - برای اطلاعات بیشتر در مورد نحوه استفاده از آن ، به قابلیت های آفلاین در JavaScript مراجعه کنید.

امضا:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

مولفه های

پارامتر تایپ کنید شرح
مرجع پایگاه داده مرجع اضافه کردن OnDisconnect باعث می شود.

برمی گرداند:

در حال اتصال

حذف (Ref)

Removes the data at this Database location.

Any data at child locations will also be deleted.

The effect of the remove will be visible immediately and the corresponding event 'value' will be triggered. Synchronization of the remove to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

امضا:

export declare function remove(ref: DatabaseReference): Promise<void>;

مولفه های

پارامتر تایپ کنید شرح
مرجع DatabaseReference The location to remove.

برمی گرداند:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

امضا:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

مولفه های

پارامتر تایپ کنید شرح
مرجع DatabaseReference The location to atomically modify.
transactionUpdate (currentData: any) => unknown A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (ie you return with no arguments) the transaction will be aborted and the data at this location will not be modified.
گزینه ها TransactionOptions An options object to configure transactions.

برمی گرداند:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

امضا:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

مولفه های

پارامتر تایپ کنید شرح
مرجع DatabaseReference The location to write to.
ارزش ناشناخته The value to be written (string, number, boolean, object, array, or null).

برمی گرداند:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

امضا:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

مولفه های

پارامتر تایپ کنید شرح
مرجع DatabaseReference The location to write to.
اولویت رشته | شماره | خالی The priority to be written (string, number, or null).

برمی گرداند:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

امضا:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

مولفه های

پارامتر تایپ کنید شرح
مرجع DatabaseReference The location to write to.
ارزش ناشناخته The value to be written (string, number, boolean, object, array, or null).
اولویت رشته | شماره | خالی The priority to be written (string, number, or null).

برمی گرداند:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

امضا:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

مولفه های

پارامتر تایپ کنید شرح
مرجع DatabaseReference The location to write to.
ارزش های هدف - شی Object containing multiple values.

برمی گرداند:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

امضا:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر تایپ کنید شرح
ارزش شماره | رشته | boolean | خالی The value to end at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
کلید رشته The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

QueryConstraint

endBefore(value, key)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

امضا:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر تایپ کنید شرح
ارزش شماره | رشته | boolean | خالی The value to end before. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
کلید رشته The child key to end before, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

امضا:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر تایپ کنید شرح
ارزش شماره | رشته | boolean | خالی The value to match for. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
کلید رشته The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

امضا:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر تایپ کنید شرح
ارزش شماره | رشته | boolean | خالی The value to start after. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
کلید رشته The child key to start after. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

امضا:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

مولفه های

پارامتر تایپ کنید شرح
ارزش شماره | رشته | boolean | خالی The value to start at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
کلید رشته The child key to start at. This argument is only allowed if ordering by child, value, or priority.

برمی گرداند:

QueryConstraint

EventType

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

امضا:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

امضا:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

لغو اشتراک

A callback that can invoked to remove a listener.

امضا:

export declare type Unsubscribe = () => void;