Skip to content

Add examples for new Flow operators in firestore-ktx #4078

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 29, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions docs/ktx/firestore.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,64 @@ val firestore = Firebase.firestore
val anotherFirestore = Firebase.firestore(Firebase.app("myApp"))
```

### Get a document

**Kotlin**
```kotlin
firestore.collection("cities")
.document("LON")
.addSnapshotListener { document: DocumentSnapshot?, error: ->
if (error != null) {
// Handle error
return@addSnapshotListener
}
if (document != null) {
// Use document
}
}
```

**Kotlin + KTX**
```kotlin
firestore.collection("cities")
.document("LON")
.snapshots()
.collect { document: DocumentSnapshot ->
// Use document
}
```

### Query documents

**Kotlin**
```kotlin
firestore.collection("cities")
.whereEqualTo("capital", true)
.addSnapshotListener { documents: QuerySnapshot?, error ->
if (error != null) {
// Handle error
return@addSnapshotListener
}
if (documents != null) {
for (document in documents) {
// Use document
}
}
}
```

**Kotlin + KTX**
```kotlin
firestore.collection("cities")
.whereEqualTo("capital", true)
.snapshots()
.collect { documents: QuerySnapshot ->
for (document in documents) {
// Use document
}
}
```

### Convert a DocumentSnapshot field to a POJO

**Kotlin**
Expand Down