Stay organized with collections
Save and categorize content based on your preferences.
Firebase.Firestore.LoadBundleTaskProgress
Summary
Inheritance
Inherits from: EventArgs
Properties
|
BytesLoaded = 0
|
long
The number of bytes that have been loaded.
|
DocumentsLoaded
|
int
The number of documents that have been loaded.
|
State = 0
|
The current state of the loading progress.
|
TotalBytes = 0
|
long
The total number of bytes in the bundle.
|
TotalDocuments = 0
|
int
The total number of documents in the bundle.
|
Public types
LoadBundleTaskState
LoadBundleTaskState
Represents the state of bundle loading tasks.
Both LoadBundleTaskState.Success and LoadBundleTaskState.Error are final states: the task will fail or complete and there will be no more updates after they are reported.
Properties
BytesLoaded
long BytesLoaded = 0
The number of bytes that have been loaded.
DocumentsLoaded
int DocumentsLoaded
The number of documents that have been loaded.
TotalBytes
long TotalBytes = 0
The total number of bytes in the bundle.
Zero if the bundle failed to parse.
TotalDocuments
int TotalDocuments = 0
The total number of documents in the bundle.
Zero if the bundle failed to parse.
Public functions
Equals
override bool Equals(
Object obj
)
GetHashCode
override int GetHashCode()
LoadBundleTaskProgress
LoadBundleTaskProgress(
int documentsLoaded,
int totalDocuments,
long bytesLoaded,
long totalBytes,
LoadBundleTaskState state
)
Creates a new instance of the class.
This is to support testing against progress updates.
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 2021-07-20 UTC.
[null,null,["Last updated 2021-07-20 UTC."],[],[],null,["# Firebase.Firestore.LoadBundleTaskProgress Class Reference\n\nFirebase.Firestore.LoadBundleTaskProgress\n=========================================\n\nSummary\n-------\n\n### Inheritance\n\nInherits from: EventArgs\n\n| ### Constructors and Destructors ||\n|---|---|\n| [LoadBundleTaskProgress](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1a3fc706bdecc0de6e207cabb59ced7ff0)`(int documentsLoaded, int totalDocuments, long bytesLoaded, long totalBytes, `[LoadBundleTaskState](/docs/reference/unity/class/firebase/firestore/load-bundle-task-progress#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1a3ced94039be5ccc15dcceee1740c2156)` state)` Creates a new instance of the class. ||\n\n| ### Public types ||\n|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|\n| [LoadBundleTaskState](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1a3ced94039be5ccc15dcceee1740c2156) | enum Represents the state of bundle loading tasks. |\n\n| ### Properties ||\n|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [BytesLoaded](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1a8e1f2f240a52dadbf25787c534dacd35)` = 0` | `long` The number of bytes that have been loaded. |\n| [DocumentsLoaded](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1ad14eb3e28964f8c5827fe77592bf8a26) | `int` The number of documents that have been loaded. |\n| [State](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1a043a7320f008eb0e46b12e37e0706453)` = 0` | [LoadBundleTaskState](/docs/reference/unity/class/firebase/firestore/load-bundle-task-progress#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1a3ced94039be5ccc15dcceee1740c2156) The current state of the loading progress. |\n| [TotalBytes](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1ae6118310f9317af22d325ff0104b9070)` = 0` | `long` The total number of bytes in the bundle. |\n| [TotalDocuments](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1a321e2f673b14d10dafb7d162dcaa9d4b)` = 0` | `int` The total number of documents in the bundle. |\n\n| ### Public functions ||\n|------------------------------------------------------------------------------------------------------------------------|-----------------|\n| [Equals](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1addbbc08b580e201392e2f1a74d9ac262)`(Object obj)` | `override bool` |\n| [GetHashCode](#class_firebase_1_1_firestore_1_1_load_bundle_task_progress_1a8777de63bdfd2c93455e2708d33e013d)`()` | `override int` |\n\nPublic types\n------------\n\n### LoadBundleTaskState\n\n```c#\n LoadBundleTaskState\n``` \nRepresents the state of bundle loading tasks.\n\nBoth LoadBundleTaskState.Success and LoadBundleTaskState.Error are final states: the task will fail or complete and there will be no more updates after they are reported.\n\nProperties\n----------\n\n### BytesLoaded\n\n```c#\nlong BytesLoaded = 0\n``` \nThe number of bytes that have been loaded. \n\n### DocumentsLoaded\n\n```c#\nint DocumentsLoaded\n``` \nThe number of documents that have been loaded. \n\n### State\n\n```c#\nLoadBundleTaskState State = 0\n``` \nThe current state of the loading progress. \n\n### TotalBytes\n\n```c#\nlong TotalBytes = 0\n``` \nThe total number of bytes in the bundle.\n\nZero if the bundle failed to parse. \n\n### TotalDocuments\n\n```c#\nint TotalDocuments = 0\n``` \nThe total number of documents in the bundle.\n\nZero if the bundle failed to parse.\n\nPublic functions\n----------------\n\n### Equals\n\n```c#\noverride bool Equals(\n Object obj\n)\n``` \n\n### GetHashCode\n\n```c#\noverride int GetHashCode()\n``` \n\n### LoadBundleTaskProgress\n\n```c#\n LoadBundleTaskProgress(\n int documentsLoaded,\n int totalDocuments,\n long bytesLoaded,\n long totalBytes,\n LoadBundleTaskState state\n)\n``` \nCreates a new instance of the class.\n\nThis is to support testing against progress updates."]]
