firebase-firestore/com.google.firebase.firestore/QuerySnapshot

QuerySnapshot

actual class QuerySnapshot : Iterable<QueryDocumentSnapshot> (source)

The results of a Query, mirroring the Android SDK's QuerySnapshot: the documents and the changes since the previous snapshot.

actual class QuerySnapshot : Iterable<QueryDocumentSnapshot> (source)

expect class QuerySnapshot : Iterable<QueryDocumentSnapshot> (source)

The results of a Query, mirroring the Android SDK's QuerySnapshot: the documents and the changes since the previous snapshot.

actual class QuerySnapshot : Iterable<QueryDocumentSnapshot> (source)

actual class QuerySnapshot : Iterable<QueryDocumentSnapshot> (source)

Properties

documentChanges

actual val documentChanges: List<DocumentChange>

The changes since the previous snapshot, or every document as added for the first snapshot.

actual val documentChanges: List<DocumentChange>

The changes since the previous snapshot, or every document as added for the first snapshot.

expect val documentChanges: List<DocumentChange>

The changes since the previous snapshot, or every document as added for the first snapshot.

actual val documentChanges: List<DocumentChange>

The changes since the previous snapshot, or every document as added for the first snapshot.

actual val documentChanges: List<DocumentChange>

The changes since the previous snapshot, or every document as added for the first snapshot.

actual val documents: List<DocumentSnapshot>

The documents.

actual val documents: List<DocumentSnapshot>

The documents.

expect val documents: List<DocumentSnapshot>

The documents.

actual val documents: List<DocumentSnapshot>

The documents.

actual val documents: List<DocumentSnapshot>

The documents.

val ios: FIRQuerySnapshot

The underlying Firebase iOS SDK object.

actual val isEmpty: Boolean

Whether there are no documents.

actual val isEmpty: Boolean

Whether there are no documents.

expect val isEmpty: Boolean

Whether there are no documents.

actual val isEmpty: Boolean

Whether there are no documents.

actual val isEmpty: Boolean

Whether there are no documents.

val js: QuerySnapshot

The underlying Firebase JS SDK object.

val js: QuerySnapshot

The underlying Firebase JS SDK object.

actual val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

actual val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

expect val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

actual val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

actual val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

actual val query: Query

The query the results belong to.

actual val query: Query

The query the results belong to.

expect val query: Query

The query the results belong to.

actual val query: Query

The query the results belong to.

actual val query: Query

The query the results belong to.

Functions

open operator override fun equals(other: Any?): Boolean

open operator override fun equals(other: Any?): Boolean

open operator override fun equals(other: Any?): Boolean

getDocumentChanges

actual fun getDocumentChanges(metadataChanges: MetadataChanges): List<DocumentChange>

The changes since the previous snapshot, including metadata-only changes when metadataChanges is INCLUDE.

actual fun getDocumentChanges(metadataChanges: MetadataChanges): List<DocumentChange>

The changes since the previous snapshot, including metadata-only changes when metadataChanges is INCLUDE.

expect fun getDocumentChanges(metadataChanges: MetadataChanges): List<DocumentChange>

The changes since the previous snapshot, including metadata-only changes when metadataChanges is INCLUDE.

actual fun getDocumentChanges(metadataChanges: MetadataChanges): List<DocumentChange>

The changes since the previous snapshot, including metadata-only changes when metadataChanges is INCLUDE.

actual fun getDocumentChanges(metadataChanges: MetadataChanges): List<DocumentChange>

The changes since the previous snapshot, including metadata-only changes when metadataChanges is INCLUDE.

open override fun hashCode(): Int

open override fun hashCode(): Int

open override fun hashCode(): Int

actual open operator override fun iterator(): Iterator<QueryDocumentSnapshot>

actual open operator override fun iterator(): Iterator<QueryDocumentSnapshot>

expect open operator override fun iterator(): Iterator<QueryDocumentSnapshot>

actual open operator override fun iterator(): Iterator<QueryDocumentSnapshot>

actual open operator override fun iterator(): Iterator<QueryDocumentSnapshot>

actual fun size(): Int

The number of documents.

actual fun size(): Int

The number of documents.

expect fun size(): Int

The number of documents.

actual fun size(): Int

The number of documents.

actual fun size(): Int

The number of documents.

inline fun <T> QuerySnapshot.toObjects(): List<T>

The documents as T; on Apple platforms and JS casts of DocumentSnapshot.data.

inline fun <T> QuerySnapshot.toObjects(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): List<T>

The documents as T; on Apple platforms and JS casts of DocumentSnapshot.getData.

open override fun toString(): String

open override fun toString(): String

open override fun toString(): String