OperationRef

copy

@ExperimentalFirebaseDataConnect
fun copy(
    operationName: String = this.operationName,
    variables: Variables = this.variables,
    dataDeserializer: DeserializationStrategy<Data> = this.dataDeserializer,
    variablesSerializer: SerializationStrategy<Variables> = this.variablesSerializer,
    callerSdkType: FirebaseDataConnect.CallerSdkType = this.callerSdkType,
    dataSerializersModule: SerializersModule? = this.dataSerializersModule,
    variablesSerializersModule: SerializersModule? = this.variablesSerializersModule
): OperationRef<Data, Variables>

Creates and returns a new object that is a copy of this object, but with the properties whose names corresponding to the given arguments changed to the respective argument's value.

This function is essentially the same as the copy() method that is generated by the Kotlin compiler for data class classes.

equals

operator fun equals(other: Any?): Boolean

Compares this object with another object for equality.

execute

suspend fun execute(): OperationResult<Data, Variables>

Executes this operation and returns the result.

An exception is thrown if the operation fails for any reason, including

• The FirebaseDataConnect object has been closed.

• The Firebase Data Connect server is unreachable.

• Authentication with the Firebase Data Connect server fails.

• The variables are rejected by the Firebase Data Connect server.

• The data response sent by the Firebase Data Connect server cannot be deserialized.

hashCode

fun hashCode(): Int

Calculates and returns the hash code for this object.

The hash code is not guaranteed to be stable across application restarts.

toString

fun toString(): String

Returns a string representation of this object, useful for debugging.

The string representation is not guaranteed to be stable and may change without notice at any time. Therefore, the only recommended usage of the returned string is debugging and/or logging. Namely, parsing the returned string or storing the returned string in non-volatile storage should generally be avoided in order to be robust in case that the string representation changes.

withDataDeserializer

@ExperimentalFirebaseDataConnect
fun <NewData : Any?> withDataDeserializer(
    dataDeserializer: DeserializationStrategy<NewData>,
    dataSerializersModule: SerializersModule? = this.dataSerializersModule
): OperationRef<NewData, Variables>

Creates and returns a new object that is a copy of this object, just like copy, except that the dataDeserializer can be a different type than Data.

withVariablesSerializer

@ExperimentalFirebaseDataConnect
fun <NewVariables : Any?> withVariablesSerializer(
    variables: NewVariables,
    variablesSerializer: SerializationStrategy<NewVariables>,
    variablesSerializersModule: SerializersModule? = this.variablesSerializersModule
): OperationRef<Data, NewVariables>

Creates and returns a new object that is a copy of this object, just like copy, except that the variables and variablesSerializer can be a different type than Variables.

callerSdkType

val callerSdkType: FirebaseDataConnect.CallerSdkType

The FirebaseDataConnect.CallerSdkType that will be associated with all operations performed by this object for analytics purposes.

dataConnect

val dataConnect: FirebaseDataConnect

The FirebaseDataConnect with which this object is associated.

dataDeserializer

val dataDeserializer: DeserializationStrategy<Data>

The deserializer to use to deserialize the response data for this operation.

Typically, the deserializer will be generated by Kotlin's serialization plugin for a class annotated with kotlinx.serialization.Serializable.

For example, a query defined as

query GetPersonById($id: UUID!) { person(id: $id) { name age } }

could define its data class could as follows:

@Serializable
data class GetPersonByIdData(val person: Person?) {
  @Serializable
  data class Person(val name: String, val age: Int?)
}

and the deserializer could be retrieved by calling kotlinx.serialization.serializer as follows:

serializer<GetPersonByIdData>()

dataSerializersModule

val dataSerializersModule: SerializersModule?

A SerializersModule to use when decoding the response data using dataDeserializer. May be null, to not use a SerializersModule.

operationName

val operationName: String

The name of the operation, as defined in GraphQL.

For example, a query defined as

query GetPersonById($id: UUID!) { person(id: $id) { name age } }

would have the operation name "GetPersonById" and a mutation defined as

mutation InsertPerson($name: String!, $age: Int) {...}

would have the operation name "InsertPerson"

variables

val variables: Variables

The variables for the operation.

The variables will be serialized using variablesSerializer and must produce a map whose keys are strings whose values are the names of the variables as defined in GraphQL, and whose values are the corresponding values.

For example, a query defined as

query GetPersonById($id: UUID!) { person(id: $id) { name age } }

would have a variable named "id" whose value is a java.util.UUID instance and a mutation defined as

mutation InsertPerson($name: String!, $age: Int) {...}

would have two variables named "name" and "age" whose values are String and Int? values, respectively.

variablesSerializer

val variablesSerializer: SerializationStrategy<Variables>

The serializer to use to serialize the variables for this operation.

Typically, the serializer will be generated by Kotlin's serialization plugin for a class annotated with kotlinx.serialization.Serializable.

For example, a mutation defined as

mutation InsertPerson($name: String!, $age: Int) {...}

could define its variables class could as follows:

@Serializable
data class InsertPersonVariables(val name: String, val age: Int?)

and the serializer could be retrieved by calling kotlinx.serialization.serializer as follows:

serializer<InsertPersonVariables>()

variablesSerializersModule

val variablesSerializersModule: SerializersModule?

A SerializersModule to use when encoding the variables using variablesSerializer. May be null, to not use a SerializersModule.