firebase-dataconnect/com.google.firebase.dataconnect

Package-level declarations

Types

@Serializable(with = AnyValueSerializer::class)

The value of a Data Connect Any scalar: a String, a Boolean, a Double, a List of such values (or null) or a Map from String to such values (or null). A null scalar is represented by null rather than by an AnyValue.

AuthUserChangedException

open class AuthUserChangedException(message: String, cause: Throwable? = null) : DataConnectException

Thrown when the signed-in Firebase Authentication user changed while an operation was in progress, so its result belongs to a different user and is discarded; run the operation again.

CacheSettings

class CacheSettings(val storage: CacheSettings.Storage = Storage.PERSISTENT, val maxAge: Duration = Duration.ZERO)

The settings of the query result cache, see DataConnectSettings.cacheSettings.

ConnectorConfig

class ConnectorConfig(val connector: String, val location: String, val serviceId: String)

Identifies a Data Connect connector: the connector of the service serviceId in the region location.

DataConnectException

open class DataConnectException(message: String, cause: Throwable? = null) : Exception

The base class of the exceptions thrown by Firebase Data Connect.

DataConnectOperationException

open class DataConnectOperationException(message: String, cause: Throwable? = null, val response: DataConnectOperationFailureResponse<*>) : DataConnectException

Thrown when the execution of an operation fails: the server reported errors for it, or the data it returned could not be decoded. response carries the errors, the raw data and the decoded data when decoding succeeded.

DataConnectOperationFailureResponse

interface DataConnectOperationFailureResponse<Data>

The details of a failed operation, see DataConnectOperationException.response.

DataConnectPathSegment

sealed interface DataConnectPathSegment

One segment of the path of a field in the data of an operation, see DataConnectOperationFailureResponse.ErrorInfo.path.

DataConnectSettings

class DataConnectSettings(val host: String = "firebasedataconnect.googleapis.com", val sslEnabled: Boolean = true, val cacheSettings: CacheSettings? = null)

The settings of a FirebaseDataConnect instance: the host it connects to, whether over TLS, and its query cache.

DataSource

enum DataSource : Enum<DataSource>

Where a QueryResult's data came from.

EnumValue

sealed interface EnumValue<out T : Enum<out T>>

The value of a Data Connect enum field: Known when the server's value is one of the Enum constants this code was compiled with, Unknown (carrying the string) when the enum gained a value since. Serialized by com.google.firebase.dataconnect.serializers.EnumValueSerializer.

ExperimentalFirebaseDataConnect

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This declaration is "experimental": its signature and/or semantics may change in backwards-incompatible ways at any time without notice, up to and including complete removal. If you have a use case that relies on this declaration please open a "feature request" issue at https://github.com/firebase/firebase-android-sdk requesting this declaration's promotion from "experimental" to "fully-supported".")

annotation class ExperimentalFirebaseDataConnect

Marks a Firebase Data Connect declaration as experimental, as the Firebase Android SDK does: its signature and/or semantics may change in backwards-incompatible ways at any time without notice, up to and including complete removal.

FirebaseDataConnect

interface FirebaseDataConnect : AutoCloseable

The entry point of Firebase Data Connect: creates QueryRefs and MutationRefs for the operations of the connector config of app. Obtained with FirebaseDataConnect.Companion.getInstance; one instance exists per app and connector until it is closed.

LocalDate

@Serializable(with = LocalDateSerializer::class)

class LocalDate(val year: Int, val month: Int, val day: Int)

A calendar date without a time zone, the Kotlin form of the Data Connect Date scalar. month and day are 1-based; the values are not validated, so that dates from a server can be represented as sent.

LogLevel

enum LogLevel : Enum<LogLevel>

How much Firebase Data Connect logs, see FirebaseDataConnect.Companion.logLevel.

MutationRef

interface MutationRef<Data, Variables> : OperationRef<Data, Variables>

A reference to a mutation, see FirebaseDataConnect.mutation.

MutationResult

interface MutationResult<Data, Variables> : OperationResult<Data, Variables>

The result of executing a MutationRef.

OperationRef

interface OperationRef<Data, Variables>

A reference to an operation of a connector with a fixed set of variables: execute sends it and decodes its data. A reference is immutable; copy, withVariablesSerializer and withDataDeserializer derive new ones.

OperationResult

interface OperationResult<Data, Variables>

The result of executing an OperationRef: the decoded data.

OptionalVariable

@Serializable(with = OptionalVariable.Serializer::class)

sealed interface OptionalVariable<out T>

A variable of an operation that may be left undefined, which is distinct from null: an Undefined variable is not sent to the server at all (and takes the operation's default), a Value is sent even when it holds null.

QueryRef

interface QueryRef<Data, Variables> : OperationRef<Data, Variables>

A reference to a query, see FirebaseDataConnect.query; its results can be cached and subscribed to.

QueryResult

interface QueryResult<Data, Variables> : OperationResult<Data, Variables>

The result of executing a QueryRef.

QuerySubscription

interface QuerySubscription<Data, Variables>

A subscription to the results of a query: flow emits the cached result, if any, when collected, then the result of every execution of an equivalent query (same operation and variables) on the same FirebaseDataConnect instance.

QuerySubscriptionResult

interface QuerySubscriptionResult<Data, Variables>

One emission of QuerySubscription.flow: the result of an execution, successful or not.

Properties

logLevel

actual val FirebaseDataConnect.Companion.logLevel: MutableStateFlow<LogLevel>

The log level of every instance; set it to change it.

expect val FirebaseDataConnect.Companion.logLevel: MutableStateFlow<LogLevel>

The log level of every instance; set it to change it.

actual val FirebaseDataConnect.Companion.logLevel: MutableStateFlow<LogLevel>

The log level of every instance; set it to change it.

Functions

copy

fun CacheSettings.copy(storage: CacheSettings.Storage = this.storage, maxAge: Duration = this.maxAge): CacheSettings

fun DataConnectSettings.copy(host: String = this.host, sslEnabled: Boolean = this.sslEnabled, cacheSettings: CacheSettings? = this.cacheSettings): DataConnectSettings

A copy of these settings with the given values replaced.

fun ConnectorConfig.copy(connector: String = this.connector, location: String = this.location, serviceId: String = this.serviceId): ConnectorConfig

A copy of this config with the given values replaced.

fun LocalDate.copy(year: Int = this.year, month: Int = this.month, day: Int = this.day): LocalDate

A copy of this date with the given values replaced.

decode

inline fun <T> AnyValue.decode(): T

Decodes this value with the serializer of T.

fun <T> AnyValue.decode(deserializer: DeserializationStrategy<T>, serializersModule: SerializersModule? = null): T

Decodes this value with deserializer.

encode

inline fun <T> AnyValue.Companion.encode(value: T): AnyValue

Encodes value with the serializer of T.

fun <T> AnyValue.Companion.encode(value: T, serializer: SerializationStrategy<T>, serializersModule: SerializersModule? = null): AnyValue

Encodes value with serializer; a null result is an error, as AnyValue never holds null.

fromAny

fun AnyValue.Companion.fromAny(value: Any): AnyValue

Wraps a plain value; throws IllegalArgumentException for a type that an Any scalar cannot hold.

@JvmName(name = "fromNullableAny")

fun AnyValue.Companion.fromAny(value: Any?): AnyValue?

fromAny for a nullable value: null for null.

getInstance

actual fun FirebaseDataConnect.Companion.getInstance(config: ConnectorConfig, settings: DataConnectSettings): FirebaseDataConnect

The instance for the default app and config, see getInstance.

actual fun FirebaseDataConnect.Companion.getInstance(app: FirebaseApp, config: ConnectorConfig, settings: DataConnectSettings): FirebaseDataConnect

The instance for app and config, created with settings if it does not exist yet. Throws IllegalArgumentException if an instance for the same app and connector exists with different settings.

expect fun FirebaseDataConnect.Companion.getInstance(config: ConnectorConfig, settings: DataConnectSettings = DataConnectSettings()): FirebaseDataConnect

The instance for the default app and config, see getInstance.

expect fun FirebaseDataConnect.Companion.getInstance(app: FirebaseApp, config: ConnectorConfig, settings: DataConnectSettings = DataConnectSettings()): FirebaseDataConnect

The instance for app and config, created with settings if it does not exist yet. Throws IllegalArgumentException if an instance for the same app and connector exists with different settings.

actual fun FirebaseDataConnect.Companion.getInstance(config: ConnectorConfig, settings: DataConnectSettings): FirebaseDataConnect

The instance for the default app and config, see getInstance.

actual fun FirebaseDataConnect.Companion.getInstance(app: FirebaseApp, config: ConnectorConfig, settings: DataConnectSettings): FirebaseDataConnect

The instance for app and config, created with settings if it does not exist yet. Throws IllegalArgumentException if an instance for the same app and connector exists with different settings.

toDataConnectLocalDate

fun LocalDate.toDataConnectLocalDate(): LocalDate

This kotlinx.datetime.LocalDate as a Data Connect LocalDate.

toKotlinxLocalDate

fun LocalDate.toKotlinxLocalDate(): LocalDate

This date as a kotlinx.datetime.LocalDate, which validates it.