DeleteUsersResult
Stay organized with collections
Save and categorize content based on your preferences.
Public Method Summary
|
List<ErrorInfo>
|
getErrors()
A list of ErrorInfo instances describing the errors that were encountered during
the deletion.
|
|
int
|
getFailureCount()
Returns the number of users that failed to be deleted (possibly zero).
|
|
int
|
getSuccessCount()
Returns the number of users that were deleted successfully (possibly zero).
|
Inherited Method Summary
From class
java.lang.Object
|
Object
|
clone()
|
|
boolean
|
equals(Object arg0)
|
|
void
|
finalize()
|
|
final
Class<?>
|
getClass()
|
|
int
|
hashCode()
|
|
final
void
|
notify()
|
|
final
void
|
notifyAll()
|
|
String
|
toString()
|
|
final
void
|
wait(long arg0, int arg1)
|
|
final
void
|
wait(long arg0)
|
|
final
void
|
wait()
|
Public Methods
public
List<ErrorInfo>
getErrors
()
A list of ErrorInfo instances describing the errors that were encountered during
the deletion. Length of this list is equal to the return value of
getFailureCount().
Returns
- A non-null list (possibly empty).
public
int
getFailureCount
()
Returns the number of users that failed to be deleted (possibly zero).
public
int
getSuccessCount
()
Returns the number of users that were deleted successfully (possibly zero). Users that did not
exist prior to calling deleteUsersAsync(List) are considered to be
successfully deleted.
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-04-28 UTC.
[null,null,["Last updated 2021-04-28 UTC."],[],[],null,["# DeleteUsersResult\n\npublic final class **DeleteUsersResult** extends Object \nRepresents the result of the [deleteUsersAsync(List)](/docs/reference/admin/java/reference/com/google/firebase/auth/AbstractFirebaseAuth#deleteUsersAsync(java.util.List\u003cjava.lang.String\u003e)) API. \n\n### Public Method Summary\n\n|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| List\\\u003c[ErrorInfo](/docs/reference/admin/java/reference/com/google/firebase/auth/ErrorInfo)\\\u003e | [getErrors](/docs/reference/admin/java/reference/com/google/firebase/auth/DeleteUsersResult#getErrors())() A list of [ErrorInfo](/docs/reference/admin/java/reference/com/google/firebase/auth/ErrorInfo) instances describing the errors that were encountered during the deletion. |\n| int | [getFailureCount](/docs/reference/admin/java/reference/com/google/firebase/auth/DeleteUsersResult#getFailureCount())() Returns the number of users that failed to be deleted (possibly zero). |\n| int | [getSuccessCount](/docs/reference/admin/java/reference/com/google/firebase/auth/DeleteUsersResult#getSuccessCount())() Returns the number of users that were deleted successfully (possibly zero). |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| Object | clone() |\n| boolean | equals(Object arg0) |\n| void | finalize() |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Methods\n--------------\n\n#### public List\\\u003c[ErrorInfo](/docs/reference/admin/java/reference/com/google/firebase/auth/ErrorInfo)\\\u003e\n**getErrors**\n()\n\nA list of [ErrorInfo](/docs/reference/admin/java/reference/com/google/firebase/auth/ErrorInfo) instances describing the errors that were encountered during\nthe deletion. Length of this list is equal to the return value of\n[getFailureCount()](/docs/reference/admin/java/reference/com/google/firebase/auth/DeleteUsersResult#getFailureCount()). \n\n##### Returns\n\n- A non-null list (possibly empty). \n\n#### public int\n**getFailureCount**\n()\n\nReturns the number of users that failed to be deleted (possibly zero). \n\n#### public int\n**getSuccessCount**\n()\n\nReturns the number of users that were deleted successfully (possibly zero). Users that did not\nexist prior to calling [deleteUsersAsync(List)](/docs/reference/admin/java/reference/com/google/firebase/auth/AbstractFirebaseAuth#deleteUsersAsync(java.util.List\u003cjava.lang.String\u003e)) are considered to be\nsuccessfully deleted."]]
