public class

ListUsersPage

extends Object
implements Page<ResourceT>
java.lang.Object
   ↳ com.google.firebase.auth.ListUsersPage

Class Overview

Represents a page of ExportedUserRecord instances. Provides methods for iterating over the users in the current page, and calling up subsequent pages of users. Instances of this class are thread-safe and immutable.

Summary

Public Methods
ListUsersPage getNextPage()
Returns the next page of users.
String getNextPageToken()
Returns the string token that identifies the next page.
Iterable<ExportedUserRecord> getValues()
Returns an Iterable over the users in this page.
boolean hasNextPage()
Checks if there is another page of users available to retrieve.
Iterable<ExportedUserRecord> iterateAll()
Returns an Iterable that facilitates transparently iterating over all the users in the current Firebase project, starting from this page.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.google.api.gax.paging.Page

Public Methods

public ListUsersPage getNextPage ()

Returns the next page of users.

Returns
  • A new ListUsersPage instance, or null if there are no more pages.

public String getNextPageToken ()

Returns the string token that identifies the next page. Never returns null. Returns empty string if there are no more pages available to be retrieved.

Returns
  • A non-null string token (possibly empty, representing no more pages)

public Iterable<ExportedUserRecord> getValues ()

Returns an Iterable over the users in this page.

Returns
  • a Iterable<ExportedUserRecord> instance.

public boolean hasNextPage ()

Checks if there is another page of users available to retrieve.

Returns
  • true if another page is available, or false otherwise.

public Iterable<ExportedUserRecord> iterateAll ()

Returns an Iterable that facilitates transparently iterating over all the users in the current Firebase project, starting from this page. The Iterator instances produced by the returned Iterable never buffers more than one page of users at a time. It is safe to abandon the iterators (i.e. break the loops) at any time.

Returns
  • a new Iterable<ExportedUserRecord> instance.