org.restonfire

Interface FirebaseRestEventStream

public interface FirebaseRestEventStream

A FirebaseRestEventStream represents a specific location within a Firebase database and allows for listening to change events like data being set or updated.

This interface is a mixture of Firebase's Java and Javascript API, using similar syntax as the Java (Android) API but returning a Promise to allow for a more functional implementation of asynchronous requests.

See Also:

JDeferred Library, for more detailed information about this streaming events.

Method Summary

Methods

Modifier and Type	Method and Description
FirebaseRestEventStream	child(java.lang.String path) Returns the streaming reference for the given child location of this FirebaseRestEventStream.
FirebaseRestEventStream	getParent() Returns the streaming reference for the parent location of this FirebaseRestEventStream.
java.lang.String	getReferenceUrl() Returns the fully qualified URL for this FirebaseRestEventStream instance.
FirebaseRestEventStream	getRoot() Returns the streaming reference for the root of this Firebase database.
org.jdeferred.Promise<java.lang.Void,FirebaseRuntimeException,StreamingEvent>	startListening() Starts listening for the events on the current document location of this database.
void	stopListening() Closes the event stream, which will resolve the promise created for this location.

Method Detail

getReferenceUrl

java.lang.String getReferenceUrl()

Returns the fully qualified URL for this FirebaseRestEventStream instance.

Returns:

The absolute URL of the current reference as a String.

startListening

org.jdeferred.Promise<java.lang.Void,FirebaseRuntimeException,StreamingEvent> startListening()

Starts listening for the events on the current document location of this database. The first event will occur immediately and contains the current value at the location. Any consecutive events depend on actual modifications applied to the current location or its children.

Individual events will be forwarded to the Promise.progress(ProgressCallback) function passing in an StreamingEvent object that contains the type, a relative path and the value of the changed location in Firebase.
The promise will be resolved once the stopListening() function is invoked.

If the stream was forced to close by a change of security rules or expiration of the access token, the promise will be rejected.

Returns:

A Promise for the active request.

Throws:

FirebaseInvalidStateException - The listener for the events has already been started.

FirebaseAccessException - The client does not have permission to read from this location.

FirebaseAuthenticationExpiredException - The session for the given access token has expired.

stopListening

void stopListening()

Closes the event stream, which will resolve the promise created for this location.

Throws:

FirebaseInvalidStateException - There is no event listener currently running.

getRoot

FirebaseRestEventStream getRoot()

Returns the streaming reference for the root of this Firebase database.

Returns:

The FirebaseRestEventStream representing the root of this Firebase database.

getParent

FirebaseRestEventStream getParent()

Returns the streaming reference for the parent location of this FirebaseRestEventStream.

Returns:

The FirebaseRestEventStream representing the parent location of this FirebaseRestEventStream.

child

FirebaseRestEventStream child(java.lang.String path)

Returns the streaming reference for the given child location of this FirebaseRestEventStream.

Parameters:

path - The child's name or path to the child relative to this reference.

Returns:

The FirebaseRestEventStream representing the child location.