SimpleFirebase

java.lang.Object
- stanford.androidlib.data.firebase.SimpleFirebase

```
public final class SimpleFirebase
extends Object
```
This class provides a simplified interface to the Firebase remote database system. Methods require the context such as an Activity, so you must call SimpleFirebase.with(yourActivity) first.
By design of Firebase, most methods are asynchronous (get, set, signIn, push, watch); they return immediately and will notify your code when their results are available by contacting an appropriate listener.
The most common intended usage pattern is to make your activity implement GetListener, SetListener, SignInListener, etc. or to write small inner classes that implement these interfaces. We recommend you also implement ErrorListener so that you can see when operations fail on your database, or at least call setLogging(true) to turn on a default error listener.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SimpleFirebase.ErrorListener` An event listener that can respond to database errors.
`static interface`	`SimpleFirebase.GetListener` An event listener that can respond to the result of get() calls.
`static interface`	`SimpleFirebase.PushListener` An event listener that can respond to the result of push() or pushById() calls.
`static interface`	`SimpleFirebase.SetListener` An event listener that can respond to the result of set() calls.
`static interface`	`SimpleFirebase.SignInListener` An event listener that can respond to the result of signIn() calls.
`static interface`	`SimpleFirebase.TransactionListener` An event listener that can respond to the result of transaction() calls.
`static interface`	`SimpleFirebase.WatchListener` An event listener that can respond to the result of watch() calls.

Constructor Summary

Constructors
Constructor and Description

SimpleFirebase()

Constructors
Constructor and Description
`SimpleFirebase()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DatabaseReference`	`child(String queryText)` Returns a child of the overall database; equivalent to Firebase's child() method or the SimpleFirebase query() method.
`void`	`clearLastDatabaseError()` Clears this object's record of any past database error.
`SimpleFirebase`	`get(Query ref)` Initiates a request to retrieve the data at the given path in the database.
`SimpleFirebase`	`get(Query ref, SimpleFirebase.GetListener listener)` Initiates a request to retrieve the data at the given path in the database.
`SimpleFirebase`	`get(String path)` Initiates a request to retrieve the data at the given path in the database.
`SimpleFirebase`	`get(String path, SimpleFirebase.GetListener listener)` Initiates a request to retrieve the data at the given path in the database.
`FirebaseUser`	`getCurrentUser()` Returns the user who is currently signed in, or null if no user is signed in.
`boolean`	`hasLastDatabaseError()` Returns true if there has been a database error that has not been cleared.
`boolean`	`isSignedIn()` Returns true if a user is currently signed in.
`DatabaseError`	`lastDatabaseError()` Returns the last database error that occurred, or null if no error has occurred.
`SimpleFirebase`	`login(String username, String password)` Signs in with the given username and password; an alias for signIn().
`DatabaseReference`	`push(String path)` Adds a new object with a randomly-generated unique string key at the given path in the database, and returns that newly pushed object.
`SimpleFirebase`	`pushById(String path)` Adds a new object with a new unique integer ID key at the given path in the database.
`SimpleFirebase`	`pushById(String path, Object value)` Adds a new object with a new unique integer ID key at the given path in the database.
`SimpleFirebase`	`pushById(String path, Object value, SimpleFirebase.PushListener listener)` Adds a new object with a new unique integer ID key at the given path in the database.
`SimpleFirebase`	`pushById(String path, SimpleFirebase.PushListener listener)` Adds a new object with a new unique integer ID key at the given path in the database.
`DatabaseReference`	`query(String queryText)` Performs a query on the Firebase database.
`SimpleFirebase`	`set(String path, Object value)` Sets the given location in the database to store the given value.
`SimpleFirebase`	`set(String path, Object value, SimpleFirebase.SetListener listener)` Sets the given location in the database to store the given value.
`SimpleFirebase`	`set(String path, String key, Object value)` Sets the given location in the database to store the given value.
`SimpleFirebase`	`set(String path, String key, Object value, SimpleFirebase.SetListener listener)` Sets the given location in the database to store the given value.
`SimpleFirebase`	`setErrorListener(SimpleFirebase.ErrorListener listener)` Sets the given listener object to be notified of future database errors.
`SimpleFirebase`	`setLogging(boolean logging)` Sets whether the SimpleFirebase library should print log messages for debugging.
`SimpleFirebase`	`signIn(String email, String password)` Signs in with the given username and password.
`SimpleFirebase`	`signIn(String email, String password, SimpleFirebase.SignInListener listener)` Signs in with the given username and password.
`SimpleFirebase`	`signInAnonymously()` Signs in to the database anonymously.
`SimpleFirebase`	`signInAnonymously(SimpleFirebase.SignInListener listener)` Signs in to the database anonymously.
`SimpleFirebase`	`signInWithCredential(AuthCredential authCredential)` Signs in with the given username and password.
`SimpleFirebase`	`signInWithCredential(AuthCredential authCredential, SimpleFirebase.SignInListener listener)` Signs in with the given username and password.
`SimpleFirebase`	`signInWithCustomToken(String token)` Signs in to the database using the given custom token.
`SimpleFirebase`	`signInWithCustomToken(String token, SimpleFirebase.SignInListener listener)` Signs in to the database using the given custom token.
`SimpleFirebase`	`signOut()` Signs out of the database, if currently signed in.
`SimpleFirebase`	`transaction(String path)` Initiates a request to perform a transaction on the data at the given path in the database.
`SimpleFirebase`	`transaction(String path, SimpleFirebase.TransactionListener listener)` Initiates a request to perform a transaction on the data at the given path in the database.
`SimpleFirebase`	`watch(Query ref)` Initiates a request to retrieve the data at the given path in the database.
`SimpleFirebase`	`watch(Query ref, SimpleFirebase.GetListener listener)` Initiates a request to retrieve the data at the given path in the database.
`SimpleFirebase`	`watch(String path)` Initiates a request to retrieve the data at the given path in the database.
`SimpleFirebase`	`watch(String path, SimpleFirebase.GetListener listener)` Initiates a request to retrieve the data at the given path in the database.
`static SimpleFirebase`	`with(Context context)` Returns a new SimpleFirebase instance using the given activity or other context.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleFirebase
```
public SimpleFirebase()
```
- Method Detail
  - with
```
public static SimpleFirebase with(Context context)
```
    Returns a new SimpleFirebase instance using the given activity or other context.
  - child
```
public DatabaseReference child(String queryText)
```
    Returns a child of the overall database; equivalent to Firebase's child() method or the SimpleFirebase query() method.
    
    See Also:
    
    query(String)
  - clearLastDatabaseError
```
public void clearLastDatabaseError()
```
    Clears this object's record of any past database error. If there was no past error, has no effect.
  - get
```
public SimpleFirebase get(String path)
```
    Initiates a request to retrieve the data at the given path in the database. If the context passed to with() when creating this SimpleFirebase object implements the GetListener interface, it will be notified when the data arrives.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
  - get
```
public SimpleFirebase get(String path,
                          SimpleFirebase.GetListener listener)
```
    Initiates a request to retrieve the data at the given path in the database. The given GetListener will be notified when the data has arrived.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
    
    listener - object to notify when the data has arrived
  - get
```
public SimpleFirebase get(Query ref)
```
    Initiates a request to retrieve the data at the given path in the database. If the context passed to with() when creating this SimpleFirebase object implements the GetListener interface, it will be notified when the data arrives.
    
    Parameters:
    
    ref - a Query object containing an absolute database reference
  - get
```
public SimpleFirebase get(Query ref,
                          SimpleFirebase.GetListener listener)
```
    Initiates a request to retrieve the data at the given path in the database. The given GetListener will be notified when the data has arrived.
    
    Parameters:
    
    ref - a Query object containing an absolute database reference
    
    listener - object to notify when the data has arrived
  - getCurrentUser
```
public FirebaseUser getCurrentUser()
```
    Returns the user who is currently signed in, or null if no user is signed in.
  - hasLastDatabaseError
```
public boolean hasLastDatabaseError()
```
    Returns true if there has been a database error that has not been cleared.
  - isSignedIn
```
public boolean isSignedIn()
```
    Returns true if a user is currently signed in.
  - lastDatabaseError
```
public DatabaseError lastDatabaseError()
```
    Returns the last database error that occurred, or null if no error has occurred.
  - login
```
public SimpleFirebase login(String username,
                            String password)
```
    Signs in with the given username and password; an alias for signIn().
  - push
```
public DatabaseReference push(String path)
```
    Adds a new object with a randomly-generated unique string key at the given path in the database, and returns that newly pushed object.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
  - pushById
```
public SimpleFirebase pushById(String path)
```
    Adds a new object with a new unique integer ID key at the given path in the database. This call will query the given path to find the currently largest child ID, and set the newly added child to have an ID that is +1 higher than that largest child ID. If the context passed to with() when creating this SimpleFirebase object implements the PushListener interface, it will be notified when the new object's key is found and the new object has been created.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
  - pushById
```
public SimpleFirebase pushById(String path,
                               Object value)
```
    Adds a new object with a new unique integer ID key at the given path in the database. The object will be stored with the given initial value. If the context passed to with() when creating this SimpleFirebase object implements the PushListener interface, it will be notified when the new object's key is found and the new object has been created.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
    
    value - value to store at this path
  - pushById
```
public SimpleFirebase pushById(String path,
                               SimpleFirebase.PushListener listener)
```
    Adds a new object with a new unique integer ID key at the given path in the database. The object will be temporarily given a value of boolean 'false'. The given PushListener will be notified when the data has been created.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
    
    listener - object to notify when the data has arrived
  - pushById
```
public SimpleFirebase pushById(String path,
                               Object value,
                               SimpleFirebase.PushListener listener)
```
    Adds a new object with a new unique integer ID key at the given path in the database. The object will be stored with the given initial value. The given PushListener will be notified when the data has been created.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
    
    value - value to store at this path
    
    listener - object to notify when the data has arrived
  - query
```
public DatabaseReference query(String queryText)
```
    Performs a query on the Firebase database. Similar to the Firebase child() method. Common intended usage:
```
 SimpleFirebase fb = SimpleFirebase.with(this);
 fb.get(fb.query("foo/bar/baz")
     .orderByChild("quux")
     .limitToFirst(1));
 
```
    Parameters:
    
    queryText - absolute path in database such as "foo/bar/baz"
  - set
```
public SimpleFirebase set(String path,
                          Object value)
```
    Sets the given location in the database to store the given value. If the context passed to with() when creating this SimpleFirebase object implements the SetListener interface, it will be notified when the data has been synced.
    
    Parameters:
    
    path - an absolute database path such as "foo/bar/baz"
    
    value - the value to store there in the database
  - set
```
public SimpleFirebase set(String path,
                          String key,
                          Object value)
```
    Sets the given location in the database to store the given value. If the context passed to with() when creating this SimpleFirebase object implements the SetListener interface, it will be notified when the data has been synced.
    
    Parameters:
    
    path - an absolute database path such as "foo/bar/baz"
    
    key - child key name within that path, such as "quux" to indicate "foo/bar/baz/quux"
    
    value - the value to store there in the database
  - set
```
public SimpleFirebase set(String path,
                          Object value,
                          SimpleFirebase.SetListener listener)
```
    Sets the given location in the database to store the given value. The given SetListener will be notified when the data has been synced.
    
    Parameters:
    
    path - an absolute database path such as "foo/bar/baz"
    
    value - the value to store there in the database
  - set
```
public SimpleFirebase set(String path,
                          String key,
                          Object value,
                          SimpleFirebase.SetListener listener)
```
    Sets the given location in the database to store the given value. The given SetListener will be notified when the data has been synced.
    
    Parameters:
    
    path - an absolute database path such as "foo/bar/baz"
    
    key - child key name within that path, such as "quux" to indicate "foo/bar/baz/quux"
    
    value - the value to store there in the database
  - setErrorListener
```
public SimpleFirebase setErrorListener(SimpleFirebase.ErrorListener listener)
```
    Sets the given listener object to be notified of future database errors. Pass null to disable listening for database errors. If the context passed to with() implements ErrorListener, it will be automatically notified of database errors even if you don't call setErrorListener.
  - setLogging
```
public SimpleFirebase setLogging(boolean logging)
```
    Sets whether the SimpleFirebase library should print log messages for debugging.
  - signIn
```
public SimpleFirebase signIn(String email,
                             String password)
```
    Signs in with the given username and password. If the context passed to with() when creating this SimpleFirebase object implements the SignInListener interface, it will be notified when the sign-in is complete.
    
    Parameters:
    
    email - email address or user name such as "jsmith12"
    
    password - user password such as "abc123"
  - signIn
```
public SimpleFirebase signIn(String email,
                             String password,
                             SimpleFirebase.SignInListener listener)
```
    Signs in with the given username and password. The given SignInListener will be notified when the user has finished signing in.
    
    Parameters:
    
    email - email address or user name such as "jsmith12"
    
    password - user password such as "abc123"
  - signInAnonymously
```
public SimpleFirebase signInAnonymously()
```
    Signs in to the database anonymously. If the context passed to with() when creating this SimpleFirebase object implements the SignInListener interface, it will be notified when the sign-in is complete.
  - signInAnonymously
```
public SimpleFirebase signInAnonymously(SimpleFirebase.SignInListener listener)
```
    Signs in to the database anonymously. The given SignInListener will be notified when the user has finished signing in.
  - signInWithCredential
```
public SimpleFirebase signInWithCredential(AuthCredential authCredential)
```
    Signs in with the given username and password. If the context passed to with() when creating this SimpleFirebase object implements the SignInListener interface, it will be notified when the sign-in is complete.
  - signInWithCredential
```
public SimpleFirebase signInWithCredential(AuthCredential authCredential,
                                           SimpleFirebase.SignInListener listener)
```
    Signs in with the given username and password. The given SignInListener will be notified when the user has finished signing in.
  - signInWithCustomToken
```
public SimpleFirebase signInWithCustomToken(String token)
```
    Signs in to the database using the given custom token. If the context passed to with() when creating this SimpleFirebase object implements the SignInListener interface, it will be notified when the sign-in is complete.
  - signInWithCustomToken
```
public SimpleFirebase signInWithCustomToken(String token,
                                            SimpleFirebase.SignInListener listener)
```
    Signs in to the database using the given custom token. The given SignInListener will be notified when the user has finished signing in.
  - signOut
```
public SimpleFirebase signOut()
```
    Signs out of the database, if currently signed in. If not signed in, has no effect.
  - transaction
```
public SimpleFirebase transaction(String path)
```
    Initiates a request to perform a transaction on the data at the given path in the database. If the context passed to with() when creating this SimpleFirebase object implements the TransactionListener interface, it will be notified when the mutable data has arrived.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
  - transaction
```
public SimpleFirebase transaction(String path,
                                  SimpleFirebase.TransactionListener listener)
```
    Initiates a request to perform a transaction on the data at the given path in the database. The given TransactionListener will be notified when the mutable data has arrived.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
    
    listener - object to notify when the mutable data has arrived
  - watch
```
public SimpleFirebase watch(String path)
```
    Initiates a request to retrieve the data at the given path in the database.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
  - watch
```
public SimpleFirebase watch(String path,
                            SimpleFirebase.GetListener listener)
```
    Initiates a request to retrieve the data at the given path in the database.
    
    Parameters:
    
    path - absolute database path such as "foo/bar/baz"
    
    listener - object to notify when the data has arrived
  - watch
```
public SimpleFirebase watch(Query ref)
```
    Initiates a request to retrieve the data at the given path in the database. If the context passed to with() when creating this SimpleFirebase object implements the GetListener interface, it will be notified when the data arrives.
    
    Parameters:
    
    ref - a Query object representing an absolute database path
  - watch
```
public SimpleFirebase watch(Query ref,
                            SimpleFirebase.GetListener listener)
```
    Initiates a request to retrieve the data at the given path in the database.
    
    Parameters:
    
    ref - a Query object representing an absolute database path
    
    listener - object to notify when the data has arrived

Class SimpleFirebase

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleFirebase

Method Detail

with

child

clearLastDatabaseError

get

get

get

get

getCurrentUser

hasLastDatabaseError

isSignedIn

lastDatabaseError

login

push

pushById

pushById

pushById

pushById

query

set

set

set

set

setErrorListener

setLogging

signIn

signIn

signInAnonymously

signInAnonymously

signInWithCredential

signInWithCredential

signInWithCustomToken

signInWithCustomToken

signOut

transaction

transaction

watch

watch

watch

watch