LoadBundleTask class
Stay organized with collections
Save and categorize content based on your preferences.
Represents the task of loading a Firestore bundle. It provides progress of bundle loading, as well as task completion and error events.
The API is compatible with Promise<LoadBundleTaskProgress>.
Signature:
export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress>
Implements: PromiseLike<LoadBundleTaskProgress>
Methods
LoadBundleTask.catch()
Implements the Promise<LoadBundleTaskProgress>.catch interface.
Signature:
catch<R>(onRejected: (a: Error) => R | PromiseLike<R>): Promise<R | LoadBundleTaskProgress>;
Parameters
| Parameter |
Type |
Description |
| onRejected |
(a: Error) => R | PromiseLike<R> |
Called when an error occurs during bundle loading. |
Returns:
Promise<R | LoadBundleTaskProgress>
LoadBundleTask.onProgress()
Registers functions to listen to bundle loading progress events.
Signature:
onProgress(next?: (progress: LoadBundleTaskProgress) => unknown, error?: (err: Error) => unknown, complete?: () => void): void;
Parameters
| Parameter |
Type |
Description |
| next |
(progress: LoadBundleTaskProgress) => unknown |
Called when there is a progress update from bundle loading. Typically next calls occur each time a Firestore document is loaded from the bundle. |
| error |
(err: Error) => unknown |
Called when an error occurs during bundle loading. The task aborts after reporting the error, and there should be no more updates after this. |
| complete |
() => void |
Called when the loading task is complete. |
Returns:
void
LoadBundleTask.then()
Implements the Promise<LoadBundleTaskProgress>.then interface.
Signature:
then<T, R>(onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>, onRejected?: (a: Error) => R | PromiseLike<R>): Promise<T | R>;
Parameters
| Parameter |
Type |
Description |
| onFulfilled |
(a: LoadBundleTaskProgress) => T | PromiseLike<T> |
Called on the completion of the loading task with a final LoadBundleTaskProgress update. The update will always have its taskState set to "Success". |
| onRejected |
(a: Error) => R | PromiseLike<R> |
Called when an error occurs during bundle loading. |
Returns:
Promise<T | R>
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-19 UTC.
[null,null,["Last updated 2024-01-19 UTC."],[],[],null,["# LoadBundleTask class\n\nRepresents the task of loading a Firestore bundle. It provides progress of bundle loading, as well as task completion and error events.\n\nThe API is compatible with `Promise\u003cLoadBundleTaskProgress\u003e`.\n\n**Signature:** \n\n export declare class LoadBundleTask implements PromiseLike\u003cLoadBundleTaskProgress\u003e \n\n**Implements:** PromiseLike\\\u003c[LoadBundleTaskProgress](./firestore_.loadbundletaskprogress.md#loadbundletaskprogress_interface)\\\u003e\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|----------------------------------------------------------------------------------------------|-----------|-------------------------------------------------------------------|\n| [catch(onRejected)](./firestore_.loadbundletask.md#loadbundletaskcatch) | | Implements the `Promise\u003cLoadBundleTaskProgress\u003e.catch` interface. |\n| [onProgress(next, error, complete)](./firestore_.loadbundletask.md#loadbundletaskonprogress) | | Registers functions to listen to bundle loading progress events. |\n| [then(onFulfilled, onRejected)](./firestore_.loadbundletask.md#loadbundletaskthen) | | Implements the `Promise\u003cLoadBundleTaskProgress\u003e.then` interface. |\n\nLoadBundleTask.catch()\n----------------------\n\nImplements the `Promise\u003cLoadBundleTaskProgress\u003e.catch` interface.\n\n**Signature:** \n\n catch\u003cR\u003e(onRejected: (a: Error) =\u003e R | PromiseLike\u003cR\u003e): Promise\u003cR | LoadBundleTaskProgress\u003e;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|------------|--------------------------------------|----------------------------------------------------|\n| onRejected | (a: Error) =\\\u003e R \\| PromiseLike\\\u003cR\\\u003e | Called when an error occurs during bundle loading. |\n\n**Returns:**\n\nPromise\\\u003cR \\| [LoadBundleTaskProgress](./firestore_.loadbundletaskprogress.md#loadbundletaskprogress_interface)\\\u003e\n\nLoadBundleTask.onProgress()\n---------------------------\n\nRegisters functions to listen to bundle loading progress events.\n\n**Signature:** \n\n onProgress(next?: (progress: LoadBundleTaskProgress) =\u003e unknown, error?: (err: Error) =\u003e unknown, complete?: () =\u003e void): void;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-----------|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| next | (progress: [LoadBundleTaskProgress](./firestore_.loadbundletaskprogress.md#loadbundletaskprogress_interface)) =\\\u003e unknown | Called when there is a progress update from bundle loading. Typically `next` calls occur each time a Firestore document is loaded from the bundle. |\n| error | (err: Error) =\\\u003e unknown | Called when an error occurs during bundle loading. The task aborts after reporting the error, and there should be no more updates after this. |\n| complete | () =\\\u003e void | Called when the loading task is complete. |\n\n**Returns:**\n\nvoid\n\nLoadBundleTask.then()\n---------------------\n\nImplements the `Promise\u003cLoadBundleTaskProgress\u003e.then` interface.\n\n**Signature:** \n\n then\u003cT, R\u003e(onFulfilled?: (a: LoadBundleTaskProgress) =\u003e T | PromiseLike\u003cT\u003e, onRejected?: (a: Error) =\u003e R | PromiseLike\u003cR\u003e): Promise\u003cT | R\u003e;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-------------|----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| onFulfilled | (a: [LoadBundleTaskProgress](./firestore_.loadbundletaskprogress.md#loadbundletaskprogress_interface)) =\\\u003e T \\| PromiseLike\\\u003cT\\\u003e | Called on the completion of the loading task with a final `LoadBundleTaskProgress` update. The update will always have its `taskState` set to `\"Success\"`. |\n| onRejected | (a: Error) =\\\u003e R \\| PromiseLike\\\u003cR\\\u003e | Called when an error occurs during bundle loading. |\n\n**Returns:**\n\nPromise\\\u003cT \\| R\\\u003e"]]
