Index (firestore 6.4.0 API)

A B C D E F G L O P R S T U V
All Classes All Packages

A

areContentsTheSame(DocumentSnapshot, DocumentSnapshot) - Method in class com.firebase.ui.firestore.paging.DefaultSnapshotDiffCallback
areItemsTheSame(DocumentSnapshot, DocumentSnapshot) - Method in class com.firebase.ui.firestore.paging.DefaultSnapshotDiffCallback

B

build() - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder: Build a FirestoreRecyclerOptions from the provided arguments.
build() - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions.Builder: Build the FirestorePagingOptions object.
Builder() - Constructor for class com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder
Builder() - Constructor for class com.firebase.ui.firestore.paging.FirestorePagingOptions.Builder

C

CachingSnapshotParser<T> - Class in com.firebase.ui.firestore: Implementation of BaseCachingSnapshotParser for DocumentSnapshot.
CachingSnapshotParser(BaseSnapshotParser<DocumentSnapshot, T>) - Constructor for class com.firebase.ui.firestore.CachingSnapshotParser
ChangeEventListener - Interface in com.firebase.ui.firestore: Listener for changes to a FirestoreArray.
ClassSnapshotParser<T> - Class in com.firebase.ui.firestore: An implementation of SnapshotParser that converts DocumentSnapshot to a class using DocumentSnapshot.toObject(Class).
ClassSnapshotParser(Class<T>) - Constructor for class com.firebase.ui.firestore.ClassSnapshotParser
com.firebase.ui.firestore - package com.firebase.ui.firestore
com.firebase.ui.firestore.paging - package com.firebase.ui.firestore.paging
create() - Method in class com.firebase.ui.firestore.paging.FirestoreDataSource.Factory

D

DefaultSnapshotDiffCallback<T> - Class in com.firebase.ui.firestore.paging: Default diff callback implementation for Firestore snapshots.
DefaultSnapshotDiffCallback(SnapshotParser<T>) - Constructor for class com.firebase.ui.firestore.paging.DefaultSnapshotDiffCallback

E

ERROR - com.firebase.ui.firestore.paging.LoadingState: The most recent load encountered an error.

F

Factory(Query, Source) - Constructor for class com.firebase.ui.firestore.paging.FirestoreDataSource.Factory
FINISHED - com.firebase.ui.firestore.paging.LoadingState: The last page loaded had zero documents, and therefore no further pages will be loaded.
FirestoreArray<T> - Class in com.firebase.ui.firestore: Exposes a Firestore query as an observable list of objects.
FirestoreArray(Query, SnapshotParser<T>) - Constructor for class com.firebase.ui.firestore.FirestoreArray: Create a new FirestoreArray.
FirestoreArray(Query, MetadataChanges, SnapshotParser<T>) - Constructor for class com.firebase.ui.firestore.FirestoreArray
FirestoreDataSource - Class in com.firebase.ui.firestore.paging: Data source to power a FirestorePagingAdapter.
FirestoreDataSource(Query, Source) - Constructor for class com.firebase.ui.firestore.paging.FirestoreDataSource
FirestoreDataSource.Factory - Class in com.firebase.ui.firestore.paging
FirestorePagingAdapter<T,VH extends androidx.recyclerview.widget.RecyclerView.ViewHolder> - Class in com.firebase.ui.firestore.paging: Paginated RecyclerView Adapter for a Cloud Firestore query.
FirestorePagingAdapter(FirestorePagingOptions<T>) - Constructor for class com.firebase.ui.firestore.paging.FirestorePagingAdapter: Construct a new FirestorePagingAdapter from the given FirestorePagingOptions.
FirestorePagingOptions<T> - Class in com.firebase.ui.firestore.paging: Options to configure an FirestorePagingAdapter.
FirestorePagingOptions.Builder<T> - Class in com.firebase.ui.firestore.paging: Builder for FirestorePagingOptions.
FirestoreRecyclerAdapter<T,VH extends androidx.recyclerview.widget.RecyclerView.ViewHolder> - Class in com.firebase.ui.firestore: RecyclerView adapter that listens to a FirestoreArray and displays its data in real time.
FirestoreRecyclerAdapter(FirestoreRecyclerOptions<T>) - Constructor for class com.firebase.ui.firestore.FirestoreRecyclerAdapter: Create a new RecyclerView adapter that listens to a Firestore Query.
FirestoreRecyclerOptions<T> - Class in com.firebase.ui.firestore: Options to configure an FirestoreRecyclerAdapter.
FirestoreRecyclerOptions.Builder<T> - Class in com.firebase.ui.firestore: Builder for FirestoreRecyclerOptions.

G

getData() - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions
getDiffCallback() - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions
getId(DocumentSnapshot) - Method in class com.firebase.ui.firestore.CachingSnapshotParser
getItem(int) - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter: Gets the item at the specified position from the backing snapshot array.
getItemCount() - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter: Gets the size of snapshots in adapter.
getLastError() - Method in class com.firebase.ui.firestore.paging.FirestoreDataSource
getLoadingState() - Method in class com.firebase.ui.firestore.paging.FirestoreDataSource
getOwner() - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions: Get the (optional) LifecycleOwner.
getOwner() - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions
getPageQuery(Query, int) - Method in class com.firebase.ui.firestore.paging.PageKey
getParser() - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions
getSnapshots() - Method in class com.firebase.ui.firestore.FirestoreArray
getSnapshots() - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter: Returns the backing ObservableSnapshotArray used to populate this adapter.
getSnapshots() - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions: Get the ObservableSnapshotArray to observe.

L

loadAfter(PageKeyedDataSource.LoadParams<PageKey>, PageKeyedDataSource.LoadCallback<PageKey, DocumentSnapshot>) - Method in class com.firebase.ui.firestore.paging.FirestoreDataSource
loadBefore(PageKeyedDataSource.LoadParams<PageKey>, PageKeyedDataSource.LoadCallback<PageKey, DocumentSnapshot>) - Method in class com.firebase.ui.firestore.paging.FirestoreDataSource
LOADED - com.firebase.ui.firestore.paging.LoadingState: Not currently loading any pages, at least one page loaded.
LOADING_INITIAL - com.firebase.ui.firestore.paging.LoadingState: Loading initial data.
LOADING_MORE - com.firebase.ui.firestore.paging.LoadingState: Loading a page other than the first page.
LoadingState - Enum in com.firebase.ui.firestore.paging: Loading state exposed by FirestorePagingAdapter.
loadInitial(PageKeyedDataSource.LoadInitialParams<PageKey>, PageKeyedDataSource.LoadInitialCallback<PageKey, DocumentSnapshot>) - Method in class com.firebase.ui.firestore.paging.FirestoreDataSource

O

ObservableSnapshotArray<T> - Class in com.firebase.ui.firestore: Subclass of BaseObservableSnapshotArray for Firestore data.
ObservableSnapshotArray(SnapshotParser<T>) - Constructor for class com.firebase.ui.firestore.ObservableSnapshotArray
onBindViewHolder(VH, int) - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter
onBindViewHolder(VH, int) - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter
onBindViewHolder(VH, int, T) - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter
onBindViewHolder(VH, int, T) - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter
onChildChanged(ChangeEventType, DocumentSnapshot, int, int) - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter
onCreate() - Method in class com.firebase.ui.firestore.FirestoreArray
onDataChanged() - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter
onDestroy() - Method in class com.firebase.ui.firestore.FirestoreArray
onError(FirebaseFirestoreException) - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter
onError(Exception) - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter: Called whenever the Exception is caught.
onEvent(QuerySnapshot, FirebaseFirestoreException) - Method in class com.firebase.ui.firestore.FirestoreArray
onLoadingStateChanged(LoadingState) - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter: Called whenever the loading state of the adapter changes.

P

PageKey - Class in com.firebase.ui.firestore.paging: Key for Firestore pagination.
PageKey(DocumentSnapshot, DocumentSnapshot) - Constructor for class com.firebase.ui.firestore.paging.PageKey
parseSnapshot(DocumentSnapshot) - Method in class com.firebase.ui.firestore.ClassSnapshotParser

R

refresh() - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter: To attempt to refresh the list.
retry() - Method in class com.firebase.ui.firestore.paging.FirestoreDataSource
retry() - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter: If FirestorePagingAdapter.onLoadingStateChanged(LoadingState) indicates error state, call this method to attempt to retry the most recent failure.

S

setDiffCallback(DiffUtil.ItemCallback<DocumentSnapshot>) - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions.Builder: Sets an optional custom DiffUtil.ItemCallback to compare DocumentSnapshot objects.
setLifecycleOwner(LifecycleOwner) - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder: Set a LifecycleOwner for the adapter.
setLifecycleOwner(LifecycleOwner) - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions.Builder: Sets an optional LifecycleOwner to control the lifecycle of the adapter.
setQuery(Query, PagedList.Config, SnapshotParser<T>) - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions.Builder: Sets the query using Source.DEFAULT and a custom SnapshotParser.
setQuery(Query, PagedList.Config, Class<T>) - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions.Builder: Sets the query using Source.DEFAULT and a ClassSnapshotParser based on the given Class.
setQuery(Query, SnapshotParser<T>) - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder: Calls FirestoreRecyclerOptions.Builder.setQuery(Query, MetadataChanges, Class) with metadata changes excluded.
setQuery(Query, MetadataChanges, SnapshotParser<T>) - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder: Set the query to use (with options) and provide a custom SnapshotParser.
setQuery(Query, MetadataChanges, Class<T>) - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder: Set the query to use (with options) and provide a model class to which each snapshot will be converted.
setQuery(Query, Source, PagedList.Config, SnapshotParser<T>) - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions.Builder: Sets the Firestore query to paginate.
setQuery(Query, Source, PagedList.Config, Class<T>) - Method in class com.firebase.ui.firestore.paging.FirestorePagingOptions.Builder: Sets the query using a custom Source and a ClassSnapshotParser based on the given class.
setQuery(Query, Class<T>) - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder: Calls FirestoreRecyclerOptions.Builder.setQuery(Query, MetadataChanges, Class) with metadata changes excluded.
setSnapshotArray(ObservableSnapshotArray<T>) - Method in class com.firebase.ui.firestore.FirestoreRecyclerOptions.Builder: Directly set the ObservableSnapshotArray.
SnapshotParser<T> - Interface in com.firebase.ui.firestore: Base interface for a BaseSnapshotParser for DocumentSnapshot.
startListening() - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter: Start listening for database changes and populate the adapter.
startListening() - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter: Start listening to paging / scrolling events and populating adapter data.
stopListening() - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter: Stop listening for database changes and clear all items in the adapter.
stopListening() - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter: Unsubscribe from paging / scrolling events, no more data will be populated, but the existing data will remain.

T

toString() - Method in class com.firebase.ui.firestore.paging.PageKey

U

updateOptions(FirestoreRecyclerOptions<T>) - Method in class com.firebase.ui.firestore.FirestoreRecyclerAdapter: Re-initialize the Adapter with a new set of options.
updateOptions(FirestorePagingOptions<T>) - Method in class com.firebase.ui.firestore.paging.FirestorePagingAdapter: Re-initialize the Adapter with a new set of options.

V

valueOf(String) - Static method in enum com.firebase.ui.firestore.paging.LoadingState: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.firebase.ui.firestore.paging.LoadingState: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G L O P R S T U V
All Classes All Packages