DeleteUsersResult interface

Represents the result of theBaseAuth.deleteUsers(). API.

Signature:

exportinterfaceDeleteUsersResult

Properties

PropertyTypeDescription
errorsFirebaseArrayIndexError[]A list ofFirebaseArrayIndexError instances describing the errors that were encountered during the deletion. Length of this list is equal to the return value ofDeleteUsersResult.failureCount.
failureCountnumberThe number of user records that failed to be deleted (possibly zero).
successCountnumberThe number of users that were deleted successfully (possibly zero). Users that did not exist prior to callingdeleteUsers() are considered to be successfully deleted.

DeleteUsersResult.errors

A list ofFirebaseArrayIndexError instances describing the errors that were encountered during the deletion. Length of this list is equal to the return value ofDeleteUsersResult.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 callingdeleteUsers() are considered to be successfully deleted.

Signature:

successCount:number;

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-29 UTC.