Index (rest-on-fire 0.5.0 API)

B C E F G I L O P Q R S T U V W

B

BaseFirebaseRestDatabaseFactory - Class in org.restonfire: FirebaseRestDatabaseFactory implementation using AsyncHttpClient as the HTTP transport library.
BaseFirebaseRestDatabaseFactory(AsyncHttpClient, Gson) - Constructor for class org.restonfire.BaseFirebaseRestDatabaseFactory: Base factory which requires the AsyncHttpClient and Gson dependencies to be injected.

C

child(String) - Method in interface org.restonfire.FirebaseRestEventStream: Returns the streaming reference for the given child location of this FirebaseRestEventStream.
child(String) - Method in interface org.restonfire.FirebaseRestReference: Returns the reference for the given child location of this FirebaseRestReference.
clear() - Method in interface org.restonfire.FirebaseRestQuery: Removes all previously provided sorting and filtering values.
create(String, String) - Method in class org.restonfire.BaseFirebaseRestDatabaseFactory
create(String, String) - Method in interface org.restonfire.FirebaseRestDatabaseFactory: Factory method to create a new instance of a FirebaseRestDatabase for the given URL, using the provided access token as the auth query parameter.

E

endAt(Object) - Method in interface org.restonfire.FirebaseRestQuery: Return items less than or equal to the specified key, value, or priority, depending on the order-by method chosen.
equalTo(Object) - Method in interface org.restonfire.FirebaseRestQuery: Return items equal to the specified key, value, or priority, depending on the order-by method chosen.
ERROR_MESSAGE - Static variable in exception org.restonfire.exceptions.FirebaseAccessException

F

FirebaseAccessException - Exception in org.restonfire.exceptions: Exception thrown if the operation on a Firebase reference was not permitted under the current security rules.
FirebaseAccessException(Response) - Constructor for exception org.restonfire.exceptions.FirebaseAccessException
FirebaseAccessException(HttpResponseStatus) - Constructor for exception org.restonfire.exceptions.FirebaseAccessException
FirebaseAccessException(String) - Constructor for exception org.restonfire.exceptions.FirebaseAccessException
FirebaseAuthenticationExpiredException - Exception in org.restonfire.exceptions: Created by jfischer on 2016-05-06.
FirebaseAuthenticationExpiredException(String) - Constructor for exception org.restonfire.exceptions.FirebaseAuthenticationExpiredException
FirebaseInvalidStateException - Exception in org.restonfire.exceptions: Created by jfischer on 2016-05-08.
FirebaseInvalidStateException(FirebaseRuntimeException.ErrorCode, String) - Constructor for exception org.restonfire.exceptions.FirebaseInvalidStateException
FirebaseRestDatabase - Interface in org.restonfire: A FirebaseRestDatabase is a base representation of a Firebase database.
FirebaseRestDatabaseFactory - Interface in org.restonfire: A factory to create FirebaseRestDatabase instances.
FirebaseRestEventStream - Interface in org.restonfire: 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.
FirebaseRestException - Exception in org.restonfire.exceptions: A request to Firebase's REST API failed with an unexpected status code.
FirebaseRestException(FirebaseRuntimeException.ErrorCode, Response) - Constructor for exception org.restonfire.exceptions.FirebaseRestException
FirebaseRestException(FirebaseRuntimeException.ErrorCode, HttpResponseStatus) - Constructor for exception org.restonfire.exceptions.FirebaseRestException
FirebaseRestException(FirebaseRuntimeException.ErrorCode, String, Throwable) - Constructor for exception org.restonfire.exceptions.FirebaseRestException
FirebaseRestQuery - Interface in org.restonfire: A FirebaseRestQuery is create by a FirebaseRestReference and represents the same location as the creating REST reference.
FirebaseRestReference - Interface in org.restonfire: A FirebaseRestReference represents a specific location within a Firebase database and allows for operations to be executed on this location using Firebase's REST API.

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.
FirebaseRuntimeException - Exception in org.restonfire.exceptions: Base exception of all Firebase related exceptions thrown by this API.
FirebaseRuntimeException(FirebaseRuntimeException.ErrorCode, String) - Constructor for exception org.restonfire.exceptions.FirebaseRuntimeException
FirebaseRuntimeException(FirebaseRuntimeException.ErrorCode, String, Throwable) - Constructor for exception org.restonfire.exceptions.FirebaseRuntimeException
FirebaseRuntimeException.ErrorCode - Enum in org.restonfire.exceptions: Enum describing the different errors that can occur within this library.
FirebaseSecurityRules - Class in org.restonfire.responses: POJO representing the Firebase rules model consisting of a single property named "rules", which contains a map of nested key-value pairs.
FirebaseSecurityRules() - Constructor for class org.restonfire.responses.FirebaseSecurityRules
FirebaseSecurityRules(Map<String, Object>) - Constructor for class org.restonfire.responses.FirebaseSecurityRules
FirebaseSecurityRulesReference - Interface in org.restonfire: FirebaseSecurityRulesReference allows for updating of Firebase's security rules.

G

get() - Method in interface org.restonfire.FirebaseSecurityRulesReference: Retrieves the rules currently configured for the FirebaseRestDatabase.
getData() - Method in class org.restonfire.responses.StreamingEventData
getErrorCode() - Method in exception org.restonfire.exceptions.FirebaseRuntimeException
getEventData() - Method in class org.restonfire.responses.StreamingEvent: Returns the StreamingEventData without additional type context information.
getEventData(TypeToken<StreamingEventData<T>>) - Method in class org.restonfire.responses.StreamingEvent: Returns the StreamingEventData without additional type context information.
getEventStream(String) - Method in interface org.restonfire.FirebaseRestDatabase: Returns a FirebaseRestEventStream object representing the provided location of the namespace.
getEventType() - Method in class org.restonfire.responses.StreamingEvent: Returns the StreamingEvent.EventType for the individual event.
getName() - Method in class org.restonfire.responses.PushResponse
getParent() - Method in interface org.restonfire.FirebaseRestEventStream: Returns the streaming reference for the parent location of this FirebaseRestEventStream.
getParent() - Method in interface org.restonfire.FirebaseRestReference: Returns the reference for the parent location of this FirebaseRestReference.
getPath() - Method in class org.restonfire.responses.StreamingEventData
getReference(String) - Method in interface org.restonfire.FirebaseRestDatabase: Returns a FirebaseRestReference object representing the provided location of the database.
getReferenceUrl() - Method in interface org.restonfire.FirebaseRestEventStream: Returns the fully qualified URL for this FirebaseRestEventStream instance.
getReferenceUrl() - Method in interface org.restonfire.FirebaseRestReference: Returns the fully qualified URL for this FirebaseRestReference instance.
getRoot() - Method in interface org.restonfire.FirebaseRestEventStream: Returns the streaming reference for the root of this Firebase database.
getRoot() - Method in interface org.restonfire.FirebaseRestReference: Returns the reference for the root of this Firebase database.
getRules() - Method in class org.restonfire.responses.FirebaseSecurityRules: Returns the representation of the Firebase in form of a map.
getSecurityRules() - Method in interface org.restonfire.FirebaseRestDatabase: Returns a FirebaseSecurityRulesReference object for this namespaces.
getSerialzedEventData() - Method in class org.restonfire.responses.StreamingEvent: Returns the raw string of the data value as it was returned by the REST API.
getValue(Class<T>) - Method in interface org.restonfire.FirebaseRestReference: Retrieves the value for this reference URL from Firebase.

The promise returned will be rejected with the following two exceptions:
org.restonfire.exceptions.FirebaseAccessException - A FirebaseRuntimeException in the case that access to the data for this reference was denied.

I

INDEX_KEY - Static variable in class org.restonfire.responses.FirebaseSecurityRules: The key to be used when setting an index.

L

limitToFirst(int) - Method in interface org.restonfire.FirebaseRestQuery: Sets the maximum number of items to return from the beginning of the ordered list of results.
limitToLast(int) - Method in interface org.restonfire.FirebaseRestQuery: Sets the maximum number of items to return from the end of the ordered list of results.

O

orderByChild(String) - Method in interface org.restonfire.FirebaseRestQuery: Order results by the value of a specified child name.
orderByKey() - Method in interface org.restonfire.FirebaseRestQuery: Order results by child keys.
orderByPriority() - Method in interface org.restonfire.FirebaseRestQuery: Order results by the assigned priority.
orderByValue() - Method in interface org.restonfire.FirebaseRestQuery: Order results by child values.
org.restonfire - package org.restonfire
org.restonfire.exceptions - package org.restonfire.exceptions
org.restonfire.responses - package org.restonfire.responses

P

push() - Method in interface org.restonfire.FirebaseRestReference: Creates a new child property under the current location.
PushResponse - Class in org.restonfire.responses: Simple Pojo for serialization/deseriazation of the Firebase push responses for REST requests.
PushResponse(String) - Constructor for class org.restonfire.responses.PushResponse

Q

query() - Method in interface org.restonfire.FirebaseRestReference: Returns a FirebaseRestQuery object, which can be used to apply a large number of filters when retrieving values for this location.

R

READ_KEY - Static variable in class org.restonfire.responses.FirebaseSecurityRules: The key to be used for setting read access.
removeValue() - Method in interface org.restonfire.FirebaseRestReference: Removes the value for this reference URL from Firebase.
run(Class<T>) - Method in interface org.restonfire.FirebaseRestQuery: Executes the query with the previously provided sorting and filtering arguments.

S

ServerValues - Class in org.restonfire: This class contains all Firebase server values such as a timestamp.
set(FirebaseSecurityRules) - Method in interface org.restonfire.FirebaseSecurityRulesReference: Replaces the existing security rules with the ones provided when invoking this method.
setValue(T) - Method in interface org.restonfire.FirebaseRestReference: Sets the value in Firebase for this reference URL.
startAt(Object) - Method in interface org.restonfire.FirebaseRestQuery: Return items greater than or equal to the specified key, value, or priority, depending on the order-by method chosen.
startListening() - Method in interface org.restonfire.FirebaseRestEventStream: Starts listening for the events on the current document location of this database.
stopListening() - Method in interface org.restonfire.FirebaseRestEventStream: Closes the event stream, which will resolve the promise created for this location.
StreamingEvent - Class in org.restonfire.responses: Simple Pojo for deseriazation of the Firebase streaming event using REST.
StreamingEvent(Gson, StreamingEvent.EventType, String) - Constructor for class org.restonfire.responses.StreamingEvent
StreamingEvent.EventType - Enum in org.restonfire.responses: Enum describing the different event types to be returned by the Firebase streaming service.
StreamingEventData<T> - Class in org.restonfire.responses: Simple Pojo for deseriazation of the Firebase REST event data.
StreamingEventData() - Constructor for class org.restonfire.responses.StreamingEventData
StreamingEventData(String, T) - Constructor for class org.restonfire.responses.StreamingEventData

T

TIMESTAMP - Static variable in class org.restonfire.ServerValues: A server timestamp value.

U

updateValue(T) - Method in interface org.restonfire.FirebaseRestReference: Updates the value in Firebase for this reference URL.

V

VALIDATE_KEY - Static variable in class org.restonfire.responses.FirebaseSecurityRules: The key to be used for validating new inputs.
valueOf(String) - Static method in enum org.restonfire.exceptions.FirebaseRuntimeException.ErrorCode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.restonfire.responses.StreamingEvent.EventType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.restonfire.exceptions.FirebaseRuntimeException.ErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.restonfire.responses.StreamingEvent.EventType: Returns an array containing the constants of this enum type, in the order they are declared.

W

WRITE_KEY - Static variable in class org.restonfire.responses.FirebaseSecurityRules: The key to be used for setting write access.

B C E F G I L O P Q R S T U V W