DataSnapshot

class DataSnapshot

A DataSnapshot instance contains data from a Firebase Database location. Any time you read Database data, you receive the data as a DataSnapshot. DataSnapshots are passed to the methods in listeners that you attach with addValueEventListener, addChildEventListener, or addListenerForSingleValueEvent. They are efficiently-generated immutable copies of the data at a Firebase Database location. They can't be modified and will never change. To modify data at a location, use a DatabaseReference reference (e.g. with setValue).

Summary

Public functions
`DataSnapshot`	`child(path: String)` Get a DataSnapshot for the location at the specified relative path.
`Boolean`	`exists()` Returns true if the snapshot contains a non-null value.
`(Mutable)Iterable<DataSnapshot!>`	`getChildren()` Gives access to all of the immediate children of this snapshot.
`Long`	`getChildrenCount()`
`String?`	`getKey()`
`Any?`	`getPriority()` Returns the priority of the data contained in this snapshot as a native type.
`DatabaseReference`	`getRef()` Used to obtain a reference to the source location for this snapshot.
`Any?`	`getValue()` getValue() returns the data contained in this snapshot as native types.
`T?`	`<T> getValue(t: GenericTypeIndicator<T!>)` Due to the way that Java implements generics, it takes an extra step to get back a properly-typed Collection.
`Any?`	`getValue(useExportFormat: Boolean)` getValue() returns the data contained in this snapshot as native types.
`T?`	`<T> getValue(valueType: Class<T!>)` This method is used to marshall the data contained in this snapshot into a class of your choosing.
`Boolean`	`hasChild(path: String)` Can be used to determine if this DataSnapshot has data at a particular location
`Boolean`	`hasChildren()` Indicates whether this snapshot has any children
`String!`	`toString()`

Extension functions
`inline T?`	`<T : Any?> DataSnapshot.getValue()` Returns the content of the DataSnapshot converted to a POJO.
`inline T?`	`<T : Any?> DataSnapshot.getValue()` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

Public functions

child

fun child(path: String): DataSnapshot

Get a DataSnapshot for the 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'). If the child location has no data, an empty DataSnapshot is returned.

Parameters
`path: String`	A relative path to the location of child data

Returns
`DataSnapshot`	The DataSnapshot for the child location

exists

fun exists(): Boolean

Returns true if the snapshot contains a non-null value.

Returns
`Boolean`	True if the snapshot contains a non-null value, otherwise false

getChildren

fun getChildren(): (Mutable)Iterable<DataSnapshot!>

Gives access to all of the immediate children of this snapshot. Can be used in native for loops:

for (DataSnapshot child : parent.getChildren()) {
      ...
}

Returns
`(Mutable)Iterable<DataSnapshot!>`	The immediate children of this snapshot

getChildrenCount

fun getChildrenCount(): Long

Returns
`Long`	The number of immediate children in the this snapshot

getKey

fun getKey(): String?

Returns
`String?`	The key name for the source location of this snapshot or null if this snapshot points to the database root.

getPriority

fun getPriority(): Any?

Returns the priority of the data contained in this snapshot as a native type. Possible return types:

Double
String

Note that null is also allowed

Returns
`Any?`	the priority of the data contained in this snapshot as a native type

getRef

fun getRef(): DatabaseReference

Used to obtain a reference to the source location for this snapshot.

Returns
`DatabaseReference`	A DatabaseReference corresponding to the location that this snapshot came from

getValue

fun getValue(): Any?

getValue() returns the data contained in this snapshot as native types. The possible types returned are:

Boolean
String
Long
Double
Map<String, Object>
List<Object>

This list is recursive; the possible types for java.lang.Object in the above list is given by the same list. These types correspond to the types available in JSON.

Returns
`Any?`	The data contained in this snapshot as native types or null if there is no data at this location.

getValue

fun <T> getValue(t: GenericTypeIndicator<T!>): T?

Due to the way that Java implements generics, it takes an extra step to get back a properly-typed Collection. So, in the case where you want a java.util.List of Message instances, you will need to do something like the following:

    GenericTypeIndicator<List<Message>> t = new GenericTypeIndicator<List<Message>>() {};
    List<Message> messages = snapshot.getValue(t);

It is important to use a subclass of GenericTypeIndicator. See GenericTypeIndicator for more details

Parameters
`<T>`	The type to return. Implicitly defined from the `GenericTypeIndicator` passed in
`t: GenericTypeIndicator<T!>`	A subclass of `GenericTypeIndicator` indicating the type of generic collection to be returned.

Returns
`T?`	A properly typed collection, populated with the data from this snapshot, or null if there is no data at this location.

getValue

fun getValue(useExportFormat: Boolean): Any?

getValue() returns the data contained in this snapshot as native types. The possible types returned are:

Boolean
String
Long
Double
Map<String, Object>
List<Object>

This list is recursive; the possible types for java.lang.Object in the above list is given by the same list. These types correspond to the types available in JSON.

If useExportFormat is set to true, priority information will be included in the output. Priority information shows up as a .priority key in a map. For data that would not otherwise be a map, the map will also include a .value key with the data.

Parameters
`useExportFormat: Boolean`	Whether or not to include priority information

Returns
`Any?`	The data in native types, along with its priority, or null if there is no data at this location.

getValue

fun <T> getValue(valueType: Class<T!>): T?

This method is used to marshall the data contained in this snapshot into a class of your choosing. The class must fit 2 simple constraints:

The class must have a default constructor that takes no arguments
The class must define public getters for the properties to be assigned. Properties without a public getter will be set to their default value when an instance is deserialized

An example class might look like:

    class Message {
        private String author;
        private String text;

        private Message() {}

        public Message(String author, String text) {
            this.author = author;
            this.text = text;
        }

        public String getAuthor() {
            return author;
        }

        public String getText() {
            return text;
        }
    }


    // Later
    Message m = snapshot.getValue(Message.class);

Parameters
`<T>`	The type to return. Implicitly defined from the class passed in
`valueType: Class<T!>`	The class into which this snapshot should be marshalled

Returns
`T?`	An instance of the class passed in, populated with the data from this snapshot, or null if there is no data at this location.

hasChild

fun hasChild(path: String): Boolean

Can be used to determine if this DataSnapshot has data at a particular location

Parameters
`path: String`	A relative path to the location of child data

Returns
`Boolean`	Whether or not the specified child location has data

hasChildren

fun hasChildren(): Boolean

Indicates whether this snapshot has any children

Returns
`Boolean`	True if the snapshot has any children, otherwise false

toString

fun toString(): String!

Extension functions

getValue

inline fun <T : Any?> DataSnapshot.getValue(): T?

Returns the content of the DataSnapshot converted to a POJO.

Supports generics like List<> or Map<>. Use @JvmSuppressWildcards to force the compiler to use the type T, and not ? extends T.

getValue

inline fun <T : Any?> DataSnapshot.getValue(): T?

Returns the content of the DataSnapshot converted to a POJO.

Supports generics like List<> or Map<>. Use @JvmSuppressWildcards to force the compiler to use the type T, and not ? extends T.

Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-database-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.