Stay organized with collections
Save and categorize content based on your preferences.
firebase::firestore::LoadBundleTaskProgress
#include <load_bundle_task_progress.h>
Represents a progress update or the final state from loading bundles.
Summary
Public types
|
State
|
enum Represents the state of bundle loading tasks. |
Public functions
|
bytes_loaded() const
|
int64_t
Returns how many bytes have been loaded.
|
documents_loaded() const
|
int32_t
Returns how many documents have been loaded.
|
state() const
|
Returns the current state of the loading progress.
|
total_bytes() const
|
int64_t
Returns the total number of bytes in the bundle.
|
total_documents() const
|
int32_t
Returns the total number of documents in the bundle.
|
Public types
State
State
Represents the state of bundle loading tasks.
Both kSuccess and kError are final states: the task will abort or complete and there will be no more updates after they are reported.
Public functions
LoadBundleTaskProgress
LoadBundleTaskProgress()=default
LoadBundleTaskProgress
LoadBundleTaskProgress(
int32_t documents_loaded,
int32_t total_documents,
int64_t bytes_loaded,
int64_t total_bytes,
State state
)
bytes_loaded
int64_t bytes_loaded() const
Returns how many bytes have been loaded.
documents_loaded
int32_t documents_loaded() const
Returns how many documents have been loaded.
state
State state() const
Returns the current state of the loading progress.
total_bytes
int64_t total_bytes() const
Returns the total number of bytes in the bundle.
Returns 0 if the bundle failed to parse.
total_documents
int32_t total_documents() const
Returns the total number of documents in the bundle.
Returns 0 if the bundle failed to parse.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-01-23 UTC.
[null,null,["Last updated 2024-01-23 UTC."],[],[],null,["# firebase::firestore::LoadBundleTaskProgress Class Reference\n\nfirebase::firestore::LoadBundleTaskProgress\n===========================================\n\n\n`#include \u003cload_bundle_task_progress.h\u003e`\n\nRepresents a progress update or the final state from loading bundles.\n\nSummary\n-------\n\n| ### Constructors and Destructors ||\n|---|---|\n| [LoadBundleTaskProgress](#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1af77ef737d4161af6057fe3dc75dea8fe)`()` ||\n| [LoadBundleTaskProgress](#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1a8c7ff9781dd9490b14fa61fe2e3c3444)`(int32_t documents_loaded, int32_t total_documents, int64_t bytes_loaded, int64_t total_bytes, `[State](/docs/reference/cpp/class/firebase/firestore/load-bundle-task-progress#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1a430b4e8cd45932452037b66885bd9d07)` state)` Construct a [LoadBundleTaskProgress](/docs/reference/cpp/class/firebase/firestore/load-bundle-task-progress#classfirebase_1_1firestore_1_1_load_bundle_task_progress) with specific state. ||\n\n| ### Public types ||\n|-------------------------------------------------------------------------------------------------------|----------------------------------------------------|\n| [State](#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1a430b4e8cd45932452037b66885bd9d07) | enum Represents the state of bundle loading tasks. |\n\n| ### Public functions ||\n|-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [bytes_loaded](#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1adb5df37968d7776708d0c94c1dd8f6df)`() const ` | `int64_t` Returns how many bytes have been loaded. |\n| [documents_loaded](#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1a64671d665b3a660b67bce09a765eb506)`() const ` | `int32_t` Returns how many documents have been loaded. |\n| [state](#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1aa3e4dae1ed7e69b9437d53ea84802a67)`() const ` | [State](/docs/reference/cpp/class/firebase/firestore/load-bundle-task-progress#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1a430b4e8cd45932452037b66885bd9d07) Returns the current state of the loading progress. |\n| [total_bytes](#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1aeebe37be4ae3d25419d662023798e80b)`() const ` | `int64_t` Returns the total number of bytes in the bundle. |\n| [total_documents](#classfirebase_1_1firestore_1_1_load_bundle_task_progress_1aa11aaa424493fede2bfcc6eeae4c3e79)`() const ` | `int32_t` Returns the total number of documents in the bundle. |\n\nPublic types\n------------\n\n### State\n\n```c++\n State\n``` \nRepresents the state of bundle loading tasks.\n\nBoth `kSuccess` and `kError` are final states: the task will abort or complete and there will be no more updates after they are reported.\n\nPublic functions\n----------------\n\n### LoadBundleTaskProgress\n\n```c++\n LoadBundleTaskProgress()=default\n``` \n\n### LoadBundleTaskProgress\n\n```c++\n LoadBundleTaskProgress(\n int32_t documents_loaded,\n int32_t total_documents,\n int64_t bytes_loaded,\n int64_t total_bytes,\n State state\n)\n``` \nConstruct a [LoadBundleTaskProgress](/docs/reference/cpp/class/firebase/firestore/load-bundle-task-progress#classfirebase_1_1firestore_1_1_load_bundle_task_progress) with specific state. \n\n### bytes_loaded\n\n```c++\nint64_t bytes_loaded() const \n``` \nReturns how many bytes have been loaded. \n\n### documents_loaded\n\n```c++\nint32_t documents_loaded() const \n``` \nReturns how many documents have been loaded. \n\n### state\n\n```c++\nState state() const \n``` \nReturns the current state of the loading progress. \n\n### total_bytes\n\n```c++\nint64_t total_bytes() const \n``` \nReturns the total number of bytes in the bundle.\n\nReturns 0 if the bundle failed to parse. \n\n### total_documents\n\n```c++\nint32_t total_documents() const \n``` \nReturns the total number of documents in the bundle.\n\nReturns 0 if the bundle failed to parse."]]
