DeleteUsersResult interface
Stay organized with collections
Save and categorize content based on your preferences.
Represents the result of the BaseAuth.deleteUsers(). API.
Signature:
export interface DeleteUsersResult
Properties
| Property |
Type |
Description |
| errors |
FirebaseArrayIndexError[] |
A list of FirebaseArrayIndexError instances describing the errors that were encountered during the deletion. Length of this list is equal to the return value of DeleteUsersResult.failureCount. |
| failureCount |
number |
The number of user records that failed to be deleted (possibly zero). |
| successCount |
number |
The number of users that were deleted successfully (possibly zero). Users that did not exist prior to calling deleteUsers() are considered to be successfully deleted. |
DeleteUsersResult.errors
A list of FirebaseArrayIndexError instances describing the errors that were encountered during the deletion. Length of this list is equal to the return value of DeleteUsersResult.failureCount.
Signature:
errors: FirebaseArrayIndexError[];
DeleteUsersResult.failureCount
The number of user records that failed to be deleted (possibly zero).
Signature:
failureCount: number;
DeleteUsersResult.successCount
The number of users that were deleted successfully (possibly zero). Users that did not exist prior to calling deleteUsers() are considered to be successfully deleted.
Signature:
successCount: number;
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 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["Represents the result of the [BaseAuth.deleteUsers()](./firebase-admin.auth.baseauth.md#baseauthdeleteusers). API.\n\n**Signature:** \n\n export interface DeleteUsersResult \n\nProperties\n\nDeleteUsersResult.errors\n\nA list of `FirebaseArrayIndexError` instances describing the errors that were encountered during the deletion. Length of this list is equal to the return value of [DeleteUsersResult.failureCount](./firebase-admin.auth.deleteusersresult.md#deleteusersresultfailurecount).\n\n**Signature:** \n\n errors: FirebaseArrayIndexError[];\n\nDeleteUsersResult.failureCount\n\nThe number of user records that failed to be deleted (possibly zero).\n\n**Signature:** \n\n failureCount: number;\n\nDeleteUsersResult.successCount\n\nThe number of users that were deleted successfully (possibly zero). Users that did not exist prior to calling `deleteUsers()` are considered to be successfully deleted.\n\n**Signature:** \n\n successCount: number;"]]
