Firebase Class Reference

Inherits from	FQuery : NSObject
Declared in	Firebase.h

Overview

A Firebase reference represents a particular location in your Firebase database and can be used for reading or writing data to that Firebase database location.

This class is the starting point for all Firebase operations. After you’ve initialized it with initWithUrl: you can use it to read data (ie. observeEventType:withBlock:), write data (ie. setValue:), and to create new Firebase references (ie. child:).

Initializing a Firebase object

`– initWithUrl:`

Initialize this Firebase reference with an absolute URL.

- (id)initWithUrl:(NSString *)url

Parameters

`url`	The Firebase URL (ie: https://SampleChat.firebaseIO-demo.com)

Discussion

Initialize this Firebase reference with an absolute URL.

Declared In

Firebase.h

Getting references to children locations

`– childByAppendingPath:`

Get a Firebase reference for the database location at the specified relative path. The relative path can either be a simple child key (e.g. ‘fred’) or a deeper slash-separated path (e.g. ‘fred/name/first’).

- (Firebase *)childByAppendingPath:(NSString *)pathString

Parameters

`pathString`	A relative path from this location to the desired child location.

Return Value

A Firebase reference for the specified relative path.

Discussion

Declared In

Firebase.h

`– childByAutoId`

childByAutoId generates a new child location using a unique key and returns a Firebase reference to it. This is useful when the children of a Firebase database location represent a list of items.

- (Firebase *)childByAutoId

Return Value

A Firebase reference for the generated database location.

Discussion

childByAutoId generates a new child location using a unique key and returns a Firebase reference to it. This is useful when the children of a Firebase database location represent a list of items.

The unique key generated by childByAutoId: is prefixed with a client-generated timestamp so that the resulting list will be chronologically-sorted.

Declared In

Firebase.h

Writing data

`– setValue:`

Write data to this Firebase database location.

- (void)setValue:(id)value

Parameters

`value`	The value to be written.

Discussion

Write data to this Firebase database location.

This will overwrite any data at this location and all child locations.

Data types that can be set are:

NSString – @“Hello World”
NSNumber (also includes boolean) – @YES, @43, @4.333
NSDictionary – @{@“key”: @“value”, @“nested”: @{@“another”: @“value”} }
NSArray

The effect of the write will be visible immediately and the corresponding events will be triggered. Synchronization of the data to the Firebase database servers will also be started.

Passing null for the new value is equivalent to calling remove:; all data at this location or any child location will be deleted.

Note that setValue: will remove any priority stored at this location, so if priority is meant to be preserved, you should use setValue:andPriority:instead.

Server Values - Placeholder values you may write into a Firebase database as a value or priority that will automatically be populated before writing to the Firebase database.

kFirebaseServerValueTimestamp - The number of milliseconds since the Unix epoch

Declared In

Firebase.h

`– setValue:withCompletionBlock:`

The same as setValue: with a block that gets triggered after the write operation has been committed to the Firebase database.

- (void)setValue:(id)value withCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`value`	The value to be written.
`block`	The block to be called after the write has been committed to the Firebase database.

Discussion

The same as setValue: with a block that gets triggered after the write operation has been committed to the Firebase database.

Declared In

Firebase.h

`– setValue:andPriority:`

The same as setValue: with an additional priority to be attached to the data being written. Priorities are used to order items.

- (void)setValue:(id)value andPriority:(id)priority

Parameters

`value`	The value to be written.
`priority`	The priority to be attached to that data.

Discussion

The same as setValue: with an additional priority to be attached to the data being written. Priorities are used to order items.

Declared In

Firebase.h

`– setValue:andPriority:withCompletionBlock:`

The same as setValue:andPriority: with a block that gets triggered after the write operation has been committed to the Firebase database.

- (void)setValue:(id)value andPriority:(id)priority withCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`value`	The value to be written.
`priority`	The priority to be attached to that data.
`block`	The block to be called after the write has been committed to the Firebase database.

Discussion

The same as setValue:andPriority: with a block that gets triggered after the write operation has been committed to the Firebase database.

Declared In

Firebase.h

`– removeValue`

Remove the data at this Firebase database location. Any data at child locations will also be deleted.

- (void)removeValue

Discussion

Remove the data at this Firebase database location. Any data at child locations will also be deleted.

The effect of the delete will be visible immediately and the corresponding events will be triggered. Synchronization of the delete to the Firebase database will also be started.

remove: is equivalent to calling setValue:nil.

Declared In

Firebase.h

`– removeValueWithCompletionBlock:`

The same as remove: with a block that gets triggered after the remove operation has been committed to the Firebase database.

- (void)removeValueWithCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`block`	The block to be called after the remove has been committed to the Firebase database.

Discussion

The same as remove: with a block that gets triggered after the remove operation has been committed to the Firebase database.

Declared In

Firebase.h

`– setPriority:`

Set a priority for the data at this Firebase database location. Priorities can be used to provide a custom ordering for the children at a location (if no priorities are specified, the children are ordered by key).

- (void)setPriority:(id)priority

Parameters

`priority`	The priority to set at the specified location.

Discussion

You cannot set a priority on an empty location. For this reason setValue:andPriority: should be used when setting initial data with a specific priority and setPriority: should be used when updating the priority of existing data.

Children are sorted based on this priority using the following rules:

Children with no priority come first. Children with a number as their priority come next. They are sorted numerically by priority (small to large). Children with a string as their priority come last. They are sorted lexicographically by priority. Whenever two children have the same priority (including no priority), they are sorted by key. Numeric keys come first (sorted numerically), followed by the remaining keys (sorted lexicographically).

Note that priorities are parsed and ordered as IEEE 754 double-precision floating-point numbers. Keys are always stored as strings and are treated as numbers only when they can be parsed as a 32-bit integer.

Declared In

Firebase.h

`– setPriority:withCompletionBlock:`

The same as setPriority: with a block block that is called once the priority has been committed to the Firebase database.

- (void)setPriority:(id)priority withCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`priority`	The priority to set at the specified location.
`block`	The block that is triggered after the priority has been written on the servers.

Discussion

The same as setPriority: with a block block that is called once the priority has been committed to the Firebase database.

Declared In

Firebase.h

`– updateChildValues:`

Update changes the values of the keys specified in the dictionary without overwriting other keys at this location.

- (void)updateChildValues:(NSDictionary *)values

Parameters

`values`	A dictionary of the keys to change and their new values.

Discussion

Update changes the values of the keys specified in the dictionary without overwriting other keys at this location.

Declared In

Firebase.h

`– updateChildValues:withCompletionBlock:`

The same as update: with a block block that is called once the update has been committed to the Firebase database.

- (void)updateChildValues:(NSDictionary *)values withCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`values`	A dictionary of the keys to change and their new values.
`block`	The block that is triggered after the update has been written on the Firebase database.

Discussion

The same as update: with a block block that is called once the update has been committed to the Firebase database.

Declared In

Firebase.h

Attaching observers to read data

`– observeEventType:withBlock:`

observeEventType:withBlock: is used to listen for data changes at a particular location.

- (FirebaseHandle)observeEventType:(FEventType)eventType withBlock:(void ( ^ ) ( FDataSnapshot *snapshot ))block

Parameters

`eventType`	The type of event to listen for.
`block`	The block that should be called with initial data and updates as a FDataSnapshot.

Return Value

A handle used to unregister this block later using removeObserverWithHandle:

Discussion

observeEventType:withBlock: is used to listen for data changes at a particular location.

This is the primary way to read data from a Firebase database. Your block will be triggered for the initial data and again whenever the data changes.

Use removeObserverWithHandle: to stop receiving updates.

Supported events types for all realtime observers are specified in FEventType as:

typedef NS_ENUM(NSInteger, FEventType) {
  FEventTypeChildAdded,    // 0, fired when a new child node is added to a location
  FEventTypeChildRemoved,  // 1, fired when a child node is removed from a location
  FEventTypeChildChanged,  // 2, fired when a child node at a location changes
  FEventTypeChildMoved,    // 3, fired when a child node moves relative to the other child nodes at a location
  FEventTypeValue          // 4, fired when any data changes at a location and, recursively, any children
};

Declared In

Firebase.h

`– observeEventType:andPreviousSiblingKeyWithBlock:`

observeEventType:andPreviousSiblingKeyWithBlock: is used to listen for data changes at a particular location. This is the primary way to read data from a Firebase database. Your block will be triggered for the initial data and again whenever the data changes. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and FEventTypeChildChanged events, your block will be passed the key of the previous node by priority order.

- (FirebaseHandle)observeEventType:(FEventType)eventType andPreviousSiblingKeyWithBlock:(void ( ^ ) ( FDataSnapshot *snapshot , NSString *prevKey ))block

Parameters

`eventType`	The type of event to listen for.
`block`	The block that should be called with initial data and updates as a FDataSnapshot, as well as the previous child’s key.

Return Value

A handle used to unregister this block later using removeObserverWithHandle:

Discussion

Use removeObserverWithHandle: to stop receiving updates.

Declared In

Firebase.h

`– observeEventType:withBlock:withCancelBlock:`

observeEventType:withBlock: is used to listen for data changes at a particular location. This is the primary way to read data from a Firebase database. Your block will be triggered for the initial data and again whenever the data changes.

- (FirebaseHandle)observeEventType:(FEventType)eventType withBlock:(void ( ^ ) ( FDataSnapshot *snapshot ))block withCancelBlock:(void ( ^ ) ( NSError *error ))cancelBlock

Parameters

`eventType`	The type of event to listen for.
`block`	The block that should be called with initial data and updates as a FDataSnapshot.
`cancelBlock`	The block that should be called if this client no longer has permission to receive these events.

Return Value

A handle used to unregister this block later using removeObserverWithHandle:

Discussion

The cancelBlock will be called if you will no longer receive new events due to no longer having permission.

Use removeObserverWithHandle: to stop receiving updates.

Declared In

Firebase.h

`– observeEventType:andPreviousSiblingKeyWithBlock:withCancelBlock:`

- (FirebaseHandle)observeEventType:(FEventType)eventType andPreviousSiblingKeyWithBlock:(void ( ^ ) ( FDataSnapshot *snapshot , NSString *prevKey ))block withCancelBlock:(void ( ^ ) ( NSError *error ))cancelBlock

Parameters

`eventType`	The type of event to listen for.
`block`	The block that should be called with initial data and updates as a FDataSnapshot, as well as the previous child’s key.
`cancelBlock`	The block that should be called if this client no longer has permission to receive these events.

Return Value

A handle used to unregister this block later using removeObserverWithHandle:

Discussion

The cancelBlock will be called if you will no longer receive new events due to no longer having permission.

Use removeObserverWithHandle: to stop receiving updates.

Declared In

Firebase.h

`– observeSingleEventOfType:withBlock:`

This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned.

- (void)observeSingleEventOfType:(FEventType)eventType withBlock:(void ( ^ ) ( FDataSnapshot *snapshot ))block

Parameters

`eventType`	The type of event to listen for.
`block`	The block that should be called with initial data and updates as a FDataSnapshot.

Discussion

This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned.

Declared In

Firebase.h

`– observeSingleEventOfType:andPreviousSiblingKeyWithBlock:`

This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and FEventTypeChildChanged events, your block will be passed the key of the previous node by priority order.

- (void)observeSingleEventOfType:(FEventType)eventType andPreviousSiblingKeyWithBlock:(void ( ^ ) ( FDataSnapshot *snapshot , NSString *prevKey ))block

Parameters

`eventType`	The type of event to listen for.
`block`	The block that should be called with initial data and updates as a FDataSnapshot, as well as the previous child’s key.

Discussion

Declared In

Firebase.h

`– observeSingleEventOfType:withBlock:withCancelBlock:`

This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned.

- (void)observeSingleEventOfType:(FEventType)eventType withBlock:(void ( ^ ) ( FDataSnapshot *snapshot ))block withCancelBlock:(void ( ^ ) ( NSError *error ))cancelBlock

Parameters

`eventType`	The type of event to listen for.
`block`	The block that should be called with initial data and updates as a FDataSnapshot.
`cancelBlock`	The block that will be called if you don’t have permission to access this data.

Discussion

This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned.

The cancelBlock will be called if you do not have permission to read data at this location.

Declared In

Firebase.h

`– observeSingleEventOfType:andPreviousSiblingKeyWithBlock:withCancelBlock:`

- (void)observeSingleEventOfType:(FEventType)eventType andPreviousSiblingKeyWithBlock:(void ( ^ ) ( FDataSnapshot *snapshot , NSString *prevKey ))block withCancelBlock:(void ( ^ ) ( NSError *error ))cancelBlock

Parameters

`eventType`	The type of event to listen for.
`block`	The block that should be called with initial data and updates as a FDataSnapshot, as well as the previous child’s key.
`cancelBlock`	The block that will be called if you don’t have permission to access this data.

Discussion

The cancelBlock will be called if you do not have permission to read data at this location.

Declared In

Firebase.h

Detaching observers

`– removeObserverWithHandle:`

Detach a block previously attached with observeEventType:withBlock:.

- (void)removeObserverWithHandle:(FirebaseHandle)handle

Parameters

`handle`	The handle returned by the call to observeEventType:withBlock: which we are trying to remove.

Discussion

Detach a block previously attached with observeEventType:withBlock:.

Declared In

Firebase.h

`– keepSynced:`

By calling keepSynced:YES on a location, the data for that location will automatically be downloaded and kept in sync, even when no listeners are attached for that location. Additionally, while a location is kept synced, it will not be evicted from the persistent disk cache.

- (void)keepSynced:(BOOL)keepSynced

Parameters

`keepSynced`	Pass YES to keep this location synchronized, pass NO to stop synchronization.

Discussion

Declared In

Firebase.h

`– removeAllObservers`

Detach all blocks previously attached to this Firebase database location with observeEventType:withBlock:

- (void)removeAllObservers

Discussion

Detach all blocks previously attached to this Firebase database location with observeEventType:withBlock:

Declared In

Firebase.h

Querying and limiting

`– queryStartingAtPriority:`

This method is deprecated in favor of using queryStartingAtValue:. This can be used with queryOrderedByPriority to query by priority.

- (FQuery *)queryStartingAtPriority:(id)startPriority

Parameters

`startPriority`	The lower bound, inclusive, for the priority of data visible to the returned FQuery

Return Value

An FQuery instance, limited to data with priority greater than or equal to startPriority.

Discussion

This method is deprecated in favor of using queryStartingAtValue:. This can be used with queryOrderedByPriority to query by priority.

queryStartingAtPriority: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryStartingAtPriority: will respond to events at nodes with a priority greater than or equal to startPriority.

Declared In

Firebase.h

`– queryStartingAtPriority:andChildName:`

This method is deprecated in favor of using queryStartingAtValue:childKey:. This can be used with queryOrderedByPriority to query by priority.

- (FQuery *)queryStartingAtPriority:(id)startPriority andChildName:(NSString *)childName

Parameters

`startPriority`	The lower bound, inclusive, for the priority of data visible to the returned FQuery
`childName`	The lower bound, inclusive, for the name of nodes with priority equal to startPriority.

Return Value

An FQuery instance, limited to data with priority greater than or equal to startPriority.

Discussion

This method is deprecated in favor of using queryStartingAtValue:childKey:. This can be used with queryOrderedByPriority to query by priority.

queryStartingAtPriority:andChildName: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryStartingAtPriority:andChildName will respond to events at nodes with a priority greater than startPriority, or equal to startPriority and with a name greater than or equal to childName.

Declared In

Firebase.h

`– queryEndingAtPriority:`

This method is deprecated in favor of using queryEndingAtValue:. This can be used with queryOrderedByPriority to query by priority.

- (FQuery *)queryEndingAtPriority:(id)endPriority

Parameters

`endPriority`	The upper bound, inclusive, for the priority of data visible to the returned FQuery

Return Value

An FQuery instance, limited to data with priority less than or equal to endPriority.

Discussion

This method is deprecated in favor of using queryEndingAtValue:. This can be used with queryOrderedByPriority to query by priority.

queryEndingAtPriority: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryEndingAtPriority: will respond to events at nodes with a priority less than or equal to startPriority and with a name greater than or equal to childName.

Declared In

Firebase.h

`– queryEndingAtPriority:andChildName:`

This method is deprecated in favor of using queryEndingAtValue:childKey:. This can be used with queryOrderedByPriority to query by priority.

- (FQuery *)queryEndingAtPriority:(id)endPriority andChildName:(NSString *)childName

Parameters

`endPriority`	The upper bound, inclusive, for the priority of data visible to the returned FQuery
`childName`	The upper bound, inclusive, for the name of nodes with priority equal to endPriority.

Return Value

An FQuery instance, limited to data with priority less than endPriority or equal to endPriority and with a name less than or equal to childName.

Discussion

This method is deprecated in favor of using queryEndingAtValue:childKey:. This can be used with queryOrderedByPriority to query by priority.

queryEndingAtPriority:andChildName: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryEndingAtPriority:andChildName will respond to events at nodes with a priority less than endPriority, or equal to endPriority and with a name less than or equal to childName.

Declared In

Firebase.h

`– queryEqualToPriority:`

This method is deprecated in favor of using queryEqualToValue:. This can be used with queryOrderedByPriority to query by priority.

- (FQuery *)queryEqualToPriority:(id)priority

Parameters

`priority`	The priority that the data returned by this FQuery will have.

Return Value

An Fquery instance, limited to data with the supplied priority.

Discussion

This method is deprecated in favor of using queryEqualToValue:. This can be used with queryOrderedByPriority to query by priority.

queryEqualToPriority: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryEqualToPriority: will respond to events at nodes with a priority equal to supplied argument.

Declared In

Firebase.h

`– queryEqualToPriority:andChildName:`

This method is deprecated in favor of using queryEqualAtValue:childKey:. This can be used with queryOrderedByPriority to query by priority.

- (FQuery *)queryEqualToPriority:(id)priority andChildName:(NSString *)childName

Parameters

`priority`	The priority that the data returned by this FQuery will have.
`childName`	The name of nodes with the right priority.

Return Value

An FQuery instance, limited to data with the supplied priority and the name.

Discussion

This method is deprecated in favor of using queryEqualAtValue:childKey:. This can be used with queryOrderedByPriority to query by priority.

queryEqualToPriority:andChildName: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryEqualToPriority:andChildName will respond to events at nodes with a priority equal to the supplied argument with a name equal to childName. There will be at most one node that matches because child names are unique.

Declared In

Firebase.h

`– queryLimitedToNumberOfChildren:`

This method is deprecated in favor of using queryLimitedToFirst:limit or queryLimitedToLast:limit instead.

- (FQuery *)queryLimitedToNumberOfChildren:(NSUInteger)limit

Parameters

`limit`	The upper bound, inclusive, for the number of child nodes to receive events for.

Return Value

An FQuery instance, limited to at most limit child nodes.

Discussion

This method is deprecated in favor of using queryLimitedToFirst:limit or queryLimitedToLast:limit instead.

queryLimitedToNumberOfChildren: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryLimitedToNumberOfChildren: will respond to events from at most limit child nodes.

Declared In

Firebase.h

`– queryLimitedToFirst:`

queryLimitedToFirst: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryLimitedToFirst: will respond to at most the first limit child nodes.

- (FQuery *)queryLimitedToFirst:(NSUInteger)limit

Parameters

`limit`	The upper bound, inclusive, for the number of child nodes to receive events for.

Return Value

An FQuery instance, limited to at most limit child nodes.

Discussion

Declared In

Firebase.h

`– queryLimitedToLast:`

queryLimitedToLast: is used to generate a reference to a limited view of the data at this location. The FQuery instance returned by queryLimitedToLast: will respond to at most the last limit child nodes.

- (FQuery *)queryLimitedToLast:(NSUInteger)limit

Parameters

`limit`	The upper bound, inclusive, for the number of child nodes to receive events for.

Return Value

An FQuery instance, limited to at most limit child nodes.

Discussion

Declared In

Firebase.h

`– queryOrderedByChild:`

queryOrderBy: is used to generate a reference to a view of the data that’s been sorted by the values of a particular child key. This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:, or queryEqualToValue:.

- (FQuery *)queryOrderedByChild:(NSString *)key

Parameters

`key`	The child key to use in ordering data visible to the returned FQuery

Return Value

An FQuery instance, ordered by the values of the specified child key.

Discussion

Declared In

Firebase.h

`– queryOrderedByKey`

queryOrderedByKey: is used to generate a reference to a view of the data that’s been sorted by child key. This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:, or queryEqualToValue:.

- (FQuery *)queryOrderedByKey

Return Value

An FQuery instance, ordered by child keys.

Discussion

Declared In

Firebase.h

`– queryOrderedByPriority`

queryOrderedByPriority: is used to generate a reference to a view of the data that’s been sorted by child priority. This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:, or queryEqualToValue:.

`value`	The value that the data returned by this FQuery will have.
`childKey`	The name of nodes with the right value.

Return Value

An FQuery instance, limited to data with the supplied value and the key.

Discussion

Declared In

Firebase.h

Managing presence

`– onDisconnectSetValue:`

Ensure the data at this location is set to the specified value when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

- (void)onDisconnectSetValue:(id)value

Parameters

`value`	The value to be set after the connection is lost.

Discussion

Ensure the data at this location is set to the specified value when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

onDisconnectSetValue: is especially useful for implementing “presence” systems, where a value should be changed or cleared when a user disconnects so that he appears “offline” to other users.

Declared In

Firebase.h

`– onDisconnectSetValue:withCompletionBlock:`

Ensure the data at this location is set to the specified value when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

- (void)onDisconnectSetValue:(id)value withCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`value`	The value to be set after the connection is lost.
`block`	Block to be triggered when the operation has been queued up on the Firebase database.

Discussion

Ensure the data at this location is set to the specified value when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

The completion block will be triggered when the operation has been successfully queued up on the Firebase database.

Declared In

Firebase.h

`– onDisconnectSetValue:andPriority:`

Ensure the data at this location is set to the specified value and priority when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

- (void)onDisconnectSetValue:(id)value andPriority:(id)priority

Parameters

`value`	The value to be set after the connection is lost.
`priority`	The priority to be set after the connection is lost.

Discussion

Ensure the data at this location is set to the specified value and priority when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

Declared In

Firebase.h

`– onDisconnectSetValue:andPriority:withCompletionBlock:`

Ensure the data at this location is set to the specified value and priority when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

- (void)onDisconnectSetValue:(id)value andPriority:(id)priority withCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`value`	The value to be set after the connection is lost.
`priority`	The priority to be set after the connection is lost.
`block`	Block to be triggered when the operation has been queued up on the Firebase database.

Discussion

Ensure the data at this location is set to the specified value and priority when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

The completion block will be triggered when the operation has been successfully queued up on the Firebase database.

Declared In

Firebase.h

`– onDisconnectRemoveValue`

Ensure the data at this location is removed when the client is disconnected (due to closing the app, navigating to a new page, or network issues).

- (void)onDisconnectRemoveValue

Discussion

Ensure the data at this location is removed when the client is disconnected (due to closing the app, navigating to a new page, or network issues).

onDisconnectRemoveValue is especially useful for implementing “presence” systems.

Declared In

Firebase.h

`– onDisconnectRemoveValueWithCompletionBlock:`

Ensure the data at this location is removed when the client is disconnected (due to closing the app, navigating to a new page, or network issues).

- (void)onDisconnectRemoveValueWithCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`block`	Block to be triggered when the operation has been queued up on the Firebase database.

Discussion

Ensure the data at this location is removed when the client is disconnected (due to closing the app, navigating to a new page, or network issues).

onDisconnectRemoveValueWithCompletionBlock: is especially useful for implementing “presence” systems.

Declared In

Firebase.h

`– onDisconnectUpdateChildValues:`

Ensure the data has the specified child values updated when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

- (void)onDisconnectUpdateChildValues:(NSDictionary *)values

Parameters

`values`	A dictionary of child node keys and the values to set them to after the connection is lost.

Discussion

Ensure the data has the specified child values updated when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

Declared In

Firebase.h

`– onDisconnectUpdateChildValues:withCompletionBlock:`

Ensure the data has the specified child values updated when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

- (void)onDisconnectUpdateChildValues:(NSDictionary *)values withCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`values`	A dictionary of child node keys and the values to set them to after the connection is lost.
`block`	A block that will be called once the operation has been queued up on the Firebase database.

Discussion

Ensure the data has the specified child values updated when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

Declared In

Firebase.h

`– cancelDisconnectOperations`

Cancel any operations that are set to run on disconnect. If you previously called onDisconnectSetValue:, onDisconnectRemoveValue:, or onDisconnectUpdateChildValues:, and no longer want the values updated when the connection is lost, call cancelDisconnectOperations:

- (void)cancelDisconnectOperations

Discussion

Declared In

Firebase.h

`– cancelDisconnectOperationsWithCompletionBlock:`

- (void)cancelDisconnectOperationsWithCompletionBlock:(void ( ^ ) ( NSError *error , Firebase *ref ))block

Parameters

`block`	A block that will be triggered once the Firebase database has acknowledged the cancel request.

Discussion

Declared In

Firebase.h

Reading and observing authentication data

`authData`

Get the authentication data of the current user.

@property (nonatomic, strong, readonly) FAuthData *authData

Return Value

Authentication data of the current user.

Discussion

Get the authentication data of the current user.

Declared In

Firebase.h

`– observeAuthEventWithBlock:`

Observer block will be triggered whenever a user gets authenticated or logged out.

- (FirebaseHandle)observeAuthEventWithBlock:(void ( ^ ) ( FAuthData *authData ))block

Parameters

`block`	The block that should be called with initial authentication data and future updates.

Return Value

A handle used to unregister this block later with removeAuthEventObserverWithHandle:

Discussion

Observer block will be triggered whenever a user gets authenticated or logged out.

Authentication data is persisted across app restarts. If your have an old authentication, Firebase will attempt to resume your old session. This approach does not wait for a server roundtrip. Rather, it inspects the contents of the persisted JWT and assumes that the Firebase secret used to generate the token has not been revoked.

In the event that the Firebase secret used to generate the token has been revoked, observers will likely see one flicker / rapid flip-flop of authentication state once the server rejects the token.

Use removeAuthEventObserverWithHandle: to stop receiving updates.

Declared In

Firebase.h

`– removeAuthEventObserverWithHandle:`

Detach a block previously attached with observeAuthEventWithBlock:.

- (void)removeAuthEventObserverWithHandle:(FirebaseHandle)handle

Parameters

`handle`	The handle returned by the call to observeAuthEventWithBlock: which we are trying to remove.

Discussion

Detach a block previously attached with observeAuthEventWithBlock:.

Declared In

Firebase.h

User creation and modification

`– createUser:password:withCompletionBlock:`

Used to create a new user account with the given email and password combo. The results will be passed to the given block. Note that this method will not log the new user in.

- (void)createUser:(NSString *)email password:(NSString *)password withCompletionBlock:(void ( ^ ) ( NSError *error ))block

Parameters

`email`	The email for the account to be created.
`password`	The password for the account to be created.
`block`	The block to be called with the results of the operation.

Discussion

Used to create a new user account with the given email and password combo. The results will be passed to the given block. Note that this method will not log the new user in.

Declared In

Firebase.h

`– createUser:password:withValueCompletionBlock:`

Used to create a new user account with the given email and password combo. The results will be passed to the given block. Note that this method will not log the new user in. On success, invokes the result block with an dictionary of user data, including the user id.

- (void)createUser:(NSString *)email password:(NSString *)password withValueCompletionBlock:(void ( ^ ) ( NSError *error , NSDictionary *result ))block

Parameters

`email`	The email for the account to be created.
`password`	The password for the account to be created.
`block`	The block to be called with the results of the operation.

Discussion

Declared In

Firebase.h

`– removeUser:password:withCompletionBlock:`

Remove a user account with the given email and password.

- (void)removeUser:(NSString *)email password:(NSString *)password withCompletionBlock:(void ( ^ ) ( NSError *error ))block

Parameters

`email`	The email of the account to be removed.
`password`	The password for the account to be removed.
`block`	A block to receive the results of the operation.

Discussion

Remove a user account with the given email and password.

Declared In

Firebase.h

`– changePasswordForUser:fromOld:toNew:withCompletionBlock:`

Attempts to change the password for the account with the given credentials to the new password given. Results are reported to the supplied block.

- (void)changePasswordForUser:(NSString *)email fromOld:(NSString *)oldPassword toNew:(NSString *)newPassword withCompletionBlock:(void ( ^ ) ( NSError *error ))block

Parameters

`email`	The email for the account to be changed.
`oldPassword`	The old password for the account to be changed.
`newPassword`	The desired newPassword for the account.
`block`	A block to receive the results of the operation.

Discussion

Attempts to change the password for the account with the given credentials to the new password given. Results are reported to the supplied block.

Declared In

Firebase.h

`– changeEmailForUser:password:toNewEmail:withCompletionBlock:`

Attempts to change the email for the account with the given credentials to the new email given. Results are reported to the supplied block.

- (void)changeEmailForUser:(NSString *)email password:(NSString *)password toNewEmail:(NSString *)newEmail withCompletionBlock:(void ( ^ ) ( NSError *error ))block

Parameters

`email`	The email for the account to be changed.
`password`	The password for the account to be changed.
`newEmail`	The desired newEmail for the account.
`block`	A block to receive the results of the operation.

Discussion

Attempts to change the email for the account with the given credentials to the new email given. Results are reported to the supplied block.

Declared In

Firebase.h

`– resetPasswordForUser:withCompletionBlock:`

Send a password reset email to the owner of the account with the given email. Results are reported to the supplied block.

- (void)resetPasswordForUser:(NSString *)email withCompletionBlock:(void ( ^ ) ( NSError *error ))block

Parameters

`email`	The email of the account to be removed.
`block`	A block to receive the results of the operation.

Discussion

Send a password reset email to the owner of the account with the given email. Results are reported to the supplied block.

Declared In

Firebase.h

Authenticating

`– authAnonymouslyWithCompletionBlock:`

Attempts to log the user in anonymously. The block will receive the results of the attempt.

- (void)authAnonymouslyWithCompletionBlock:(void ( ^ ) ( NSError *error , FAuthData *authData ))block

Parameters

`block`	A block to receive the results of the authentication attempt.

Discussion

Attempts to log the user in anonymously. The block will receive the results of the attempt.

Declared In

Firebase.h

`– authUser:password:withCompletionBlock:`

Attempts to authenticate to Firebase with the given credentials. The block will receive the results of the attempt.

- (void)authUser:(NSString *)email password:(NSString *)password withCompletionBlock:(void ( ^ ) ( NSError *error , FAuthData *authData ))block

Parameters

`email`	The email of the account.
`password`	The password for the account.
`block`	A block to receive the results of the authentication attempt.

Discussion

Attempts to authenticate to Firebase with the given credentials. The block will receive the results of the attempt.

Declared In

Firebase.h

`– authWithCustomToken:withCompletionBlock:`

Authenticate to this Firebase app using the provided credentials.

- (void)authWithCustomToken:(NSString *)token withCompletionBlock:(void ( ^ ) ( NSError *error , FAuthData *authData ))block

Parameters

`token`	The Firebase Authentication JWT generated by a secure code on a remote server.
`block`	This block will be called with the results of the authentication attempt.

Discussion

Authenticate to this Firebase app using the provided credentials.

The completion block will be called with the results of the authenticated attempt. UnlikeauthWithCredential:withCompletionBlock:withCancelBlock:, no block will be called when the credentials become invalid.

Instead, please use observeAuthEventWithBlock: to observe if a user gets logged out.

Declared In

Firebase.h

`– authWithOAuthProvider:token:withCompletionBlock:`

Authenticate to the Firebase app with an OAuth token from a provider.

- (void)authWithOAuthProvider:(NSString *)provider token:(NSString *)oauthToken withCompletionBlock:(void ( ^ ) ( NSError *error , FAuthData *authData ))block

Parameters

`provider`	The provider, all lower case with no spaces.
`oauthToken`	The OAuth Token to authenticate with the provider.
`block`	A block to receive the results of the authentication attempt.

Discussion

Authenticate to the Firebase app with an OAuth token from a provider.

This method works with current OAuth 2.0 providers such as Facebook, Google+, and Github.

For other providers that Firebase supports which require additional parameters for login, such as Twitter, please use authWithOAuthProvider:parameters:withCompletionBlock:.

Declared In

Firebase.h

`– authWithOAuthProvider:parameters:withCompletionBlock:`

Authenticate to the Firebase app with an OAuth token from a provider.

- (void)authWithOAuthProvider:(NSString *)provider parameters:(NSDictionary *)parameters withCompletionBlock:(void ( ^ ) ( NSError *error , FAuthData *authData ))block

Parameters

`provider`	The provider, all lowercase with no spaces.
`parameters`	The parameters necessary to authenticate with the provider.
`block`	A block to receive the results of the authentication attempt.

Discussion

Authenticate to the Firebase app with an OAuth token from a provider.

This method is for OAuth providers that require extra parameters when authentication with the server, such as Twitter. The OAuth token should be included as a parameter.

Declared In

Firebase.h

`– makeReverseOAuthRequestTo:withCompletionBlock:`

Make a reverse OAuth Request to a provider.

- (void)makeReverseOAuthRequestTo:(NSString *)provider withCompletionBlock:(void ( ^ ) ( NSError *error , NSDictionary *json ))block

Parameters

`provider`	The provider, all lowercase with no spaces.
`block`	The block to receive the results of the reverse OAuth request.

Discussion

Make a reverse OAuth Request to a provider.

This method is for OAuth providers that require a reverse request be made first. The json output of this block.

Declared In

Firebase.h

`– unauth`

Removes any credentials associated with this Firebase app.

- (void)unauth

Discussion

Removes any credentials associated with this Firebase app.

Declared In

Firebase.h

`– authWithCredential:withCompletionBlock:withCancelBlock:`

This method is deprecated. Use authWithCustomToken:withCompletionBlock: instead.

- (void)authWithCredential:(NSString *)credential withCompletionBlock:(void ( ^ ) ( NSError *error , id data ))block withCancelBlock:(void ( ^ ) ( NSError *error ))cancelBlock

Parameters

`credential`	The Firebase Authentication JWT generated by a secure code on a remote server.
`block`	This block will be called with the results of the authentication attempt.
`cancelBlock`	This block will be called if at any time in the future the credentials become invalid.

Discussion

This method is deprecated. Use authWithCustomToken:withCompletionBlock: instead.

Authenticate to this Firebase app using the provided credentials. The completion block will be called with the results of the authenticated attempt, and the cancelBlock will be called if the credentials become invalid at some point after authentication has succeeded.

Declared In

Firebase.h

`– unauthWithCompletionBlock:`

This method is deprecated. Use unauth: instead.

- (void)unauthWithCompletionBlock:(void ( ^ ) ( NSError *error ))block

Parameters

`block`	This block will be called once the unauth has completed.

Discussion

This method is deprecated. Use unauth: instead.

Removes any credentials associated with this Firebase app. The callback block will be triggered after this operation has been acknowledged by the Firebase Authentication servers.

Declared In

Firebase.h

Manual Connection Management

`+ goOffline`

Manually disconnect the Firebase client from the database and disable automatic reconnection.

+ (void)goOffline

Discussion

Manually disconnect the Firebase client from the database and disable automatic reconnection.

The Firebase client automatically maintains a persistent connection to the Firebase server, which will remain active indefinitely and reconnect when disconnected. However, the goOffline( ) and goOnline( ) methods may be used to manually control the client connection in cases where a persistent connection is undesirable.

While offline, the Firebase client will no longer receive data updates from the database. However, all Firebase operations performed locally will continue to immediately fire events, allowing your application to continue behaving normally. Additionally, each operation performed locally will automatically be queued and retried upon reconnection to the Firebase server.

To reconnect to the Firebase server and begin receiving remote events, see goOnline( ). Once the connection is reestablished, the Firebase client will transmit the appropriate data and fire the appropriate events so that your client “catches up” automatically.

Note: Invoking this method will impact all Firebase connections.

Declared In

Firebase.h

`+ goOnline`

Manually reestablish a connection to the Firebase database and enable automatic reconnection.

+ (void)goOnline

Discussion

Manually reestablish a connection to the Firebase database and enable automatic reconnection.

This method should be used after invoking goOffline( ) to disable the active connection. Once reconnected, the Firebase client will automatically transmit the proper data and fire the appropriate events so that your client “catches up” automatically.

To disconnect from the Firebase servers, see goOffline( ).

Note: Invoking this method will impact all Firebase connections.

Declared In

Firebase.h

Transactions

`– runTransactionBlock:`

Performs an optimistic-concurrency transactional update to the data at this location. Your block will be called with an FMutableData instance that contains the current data at this location. Your block should update this data to the value you wish to write to this location, and then return an instance of FTransactionResult with the new data.

- (void)runTransactionBlock:(FTransactionResult *( ^ ) ( FMutableData *currentData ))block

Parameters

`block`	This block receives the current data at this location and must return an instance of FTransactionResult

Discussion

If, when the operation reaches the server, it turns out that this client had stale data, your block will be run again with the latest data from the server.

When your block is run, you may decide to abort the transaction by return [FTransactionResult abort].

Declared In

Firebase.h

`– runTransactionBlock:andCompletionBlock:`

- (void)runTransactionBlock:(FTransactionResult *( ^ ) ( FMutableData *currentData ))block andCompletionBlock:(void ( ^ ) ( NSError *error , BOOL committed , FDataSnapshot *snapshot ))completionBlock

Parameters

`block`	This block receives the current data at this location and must return an instance of FTransactionResult
`completionBlock`	This block will be triggered once the transaction is complete, whether it was successful or not. It will indicate if there was an error, whether or not the data was committed, and what the current value of the data at this location is.

Discussion

If, when the operation reaches the server, it turns out that this client had stale data, your block will be run again with the latest data from the server.

When your block is run, you may decide to abort the transaction by return [FTransactionResult abort].

Declared In

Firebase.h

`– runTransactionBlock:andCompletionBlock:withLocalEvents:`

- (void)runTransactionBlock:(FTransactionResult *( ^ ) ( FMutableData *currentData ))block andCompletionBlock:(void ( ^ ) ( NSError *error , BOOL committed , FDataSnapshot *snapshot ))completionBlock withLocalEvents:(BOOL)localEvents

Parameters

`block`	This block receives the current data at this location and must return an instance of FTransactionResult
`completionBlock`	This block will be triggered once the transaction is complete, whether it was successful or not. It will indicate if there was an error, whether or not the data was committed, and what the current value of the data at this location is.
`localEvents`	Set this to NO to suppress events raised for intermediate states, and only get events based on the final state of the transaction.

Discussion

If, when the operation reaches the server, it turns out that this client had stale data, your block will be run again with the latest data from the server.

When your block is run, you may decide to abort the transaction by return [FTransactionResult abort].

Since your block may be run multiple times, this client could see several immediate states that don’t exist on the server. You can suppress those immediate states until the server confirms the final state of the transaction.

Declared In

Firebase.h

Retrieving String Representation

`– description`

Gets the absolute URL of this Firebase database location.

- (NSString *)description

Return Value

The absolute URL of the referenced Firebase database location.

Discussion

Gets the absolute URL of this Firebase database location.

Declared In

Firebase.h

Firebase.h

Global configuration and settings

`+ setDispatchQueue:`

Set the default dispatch queue for event blocks. (Deprecated: This method is deprecated)

+ (void)setDispatchQueue:(dispatch_queue_t)queue

Parameters

`queue`	The queue to set as the default for running blocks for all Firebase event types.

Discussion

Set the default dispatch queue for event blocks.

Note: Please use [Firebase defaultConfig].callbackQueue instead.

Declared In

Firebase.h

`+ sdkVersion`

Retrieve the Firebase SDK version.

+ (NSString *)sdkVersion

Discussion

Retrieve the Firebase SDK version.

Declared In

Firebase.h

`+ defaultConfig`

Returns the default config object, used for configuring Firebase client behavior.

+ (FConfig *)defaultConfig

Discussion

Returns the default config object, used for configuring Firebase client behavior.

This can be modified until you create your first Firebase instance.

Declared In

Firebase.h

`+ setOption:to:`

This method is deprecated (Deprecated: This method is deprecated)

+ (void)setOption:(NSString *)option to:(id)value

Parameters

`option`	Option to set.
`value`	Value to set.

Discussion

Note: Please enable persistence by setting [Firebase defaultConfig].persistenceEnabled = YES instead.

Declared In

Firebase.h