commonMain.dev.gitlive.firebase.firestore.internal.NativeQueryWrapper.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of firebase-firestore Show documentation

The Firebase Kotlin SDK is a Kotlin-first SDK for Firebase. It's API is similar to the Firebase Android SDK Kotlin Extensions but also supports multiplatform projects, enabling you to use Firebase directly from your common source targeting iOS, Android or JS.

There is a newer version: 2.1.0

Show newest version

package dev.gitlive.firebase.firestore.internal

import dev.gitlive.firebase.firestore.Direction
import dev.gitlive.firebase.firestore.EncodedFieldPath
import dev.gitlive.firebase.firestore.Filter
import dev.gitlive.firebase.firestore.NativeDocumentSnapshot
import dev.gitlive.firebase.firestore.NativeQuery
import dev.gitlive.firebase.firestore.QuerySnapshot
import dev.gitlive.firebase.firestore.Source
import kotlinx.coroutines.flow.Flow

internal expect open class NativeQueryWrapper internal constructor(native: NativeQuery) {

    open val native: NativeQuery

    fun limit(limit: Number): NativeQuery
    val snapshots: Flow
    fun snapshots(includeMetadataChanges: Boolean = false): Flow
    suspend fun get(source: Source = Source.DEFAULT): QuerySnapshot

    fun where(filter: Filter): NativeQuery

    fun orderBy(field: String, direction: Direction): NativeQuery
    fun orderBy(field: EncodedFieldPath, direction: Direction): NativeQuery

    fun startAfter(document: NativeDocumentSnapshot): NativeQuery
    fun startAfter(vararg fieldValues: Any): NativeQuery
    fun startAt(document: NativeDocumentSnapshot): NativeQuery
    fun startAt(vararg fieldValues: Any): NativeQuery

    fun endBefore(document: NativeDocumentSnapshot): NativeQuery
    fun endBefore(vararg fieldValues: Any): NativeQuery
    fun endAt(document: NativeDocumentSnapshot): NativeQuery
    fun endAt(vararg fieldValues: Any): NativeQuery
}