Firebase.Firestore.LoadBundleTaskProgress

Summary

Inheritance

Inherits from: EventArgs

Public types
LoadBundleTaskState enum
Represents the state of bundle loading tasks.

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.

State

LoadBundleTaskState State = 0

The current state of the loading progress.

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.