uk.ac.newcastle.team22.usb.firebase

Class FirebaseManager

java.lang.Object

uk.ac.newcastle.team22.usb.firebase.FirebaseManager

public class FirebaseManager
extends java.lang.Object

A class which manages interaction and the sharing of data between the application and Firebase.

Version:

1.0

Author:

Alexander MacLeod

Field Summary

Fields

Modifier and Type	Field and Description
static FirebaseManager	shared The shared instance of the Firebase manager.

Method Summary

Modifier and Type	Method and Description
void	authenticate(FirestoreCompletionHandler<java.lang.Void> handler) Authenticates the user so that they are able to interact with Firebase.
void	disableCache(FirestoreCompletionHandler<java.lang.Void> handler) Disables the Firestore cache.
void	enableCache(FirestoreCompletionHandler<java.lang.Void> handler) Enables the Firestore cache.
<T extends FirestoreConstructable> void	getDocuments(FirestoreDatabaseCollection collection, java.lang.String path, FirestoreCompletionHandler<java.util.List<T>> handler) Retrieves documents contained within a Firestore collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

shared

public static FirebaseManager shared

The shared instance of the Firebase manager.

Method Detail

getDocuments

public <T extends FirestoreConstructable> void getDocuments(FirestoreDatabaseCollection collection,
                                                            java.lang.String path,
                                                            FirestoreCompletionHandler<java.util.List<T>> handler)

Retrieves documents contained within a Firestore collection.

Parameters:

collection - The collection of documents to retrieve.

handler - The completion handler called once the Firestore operation has finished.

enableCache

public void enableCache(FirestoreCompletionHandler<java.lang.Void> handler)

Enables the Firestore cache. By enabling the cache, network access is disabled. While the cache is enabled, all snapshot listeners and document requests retrieve results from the cache. Write operations are queued until network access is re-enabled. See Firestore Data Model for more information on Firestore caching.

Parameters:

handler - The completion handler called once the cache has been enabled.

disableCache

public void disableCache(FirestoreCompletionHandler<java.lang.Void> handler)

Disables the Firestore cache. By disabling the cache, network access is enabled. It is not guaranteed that new data will be returned from Firestore operations. See Firestore Data Model for more information on Firestore caching.

Parameters:

handler - The completion handler called once the cache has been disabled.

authenticate

public void authenticate(FirestoreCompletionHandler<java.lang.Void> handler)

Authenticates the user so that they are able to interact with Firebase.

Parameters:

handler - The completion handler called once the user has been authenticated.