firebase-dataconnect/com.google.firebase.dataconnect/OperationRef

OperationRef

interface OperationRef<Data, Variables>(source)

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.

Inheritors

MutationRef

QueryRef

Properties

callerSdkType

abstract val callerSdkType: FirebaseDataConnect.CallerSdkType

Which SDK created this reference.

dataConnect

abstract val dataConnect: FirebaseDataConnect

The instance this reference belongs to.

dataDeserializer

abstract val dataDeserializer: DeserializationStrategy<Data>

Decodes the data the operation returns.

dataSerializersModule

abstract val dataSerializersModule: SerializersModule?

The module dataDeserializer resolves contextual serializers from, if any.

operationName

abstract val operationName: String

The name of the operation in the connector.

variables

abstract val variables: Variables

The variables sent with the operation.

variablesSerializer

abstract val variablesSerializer: SerializationStrategy<Variables>

Encodes variables.

variablesSerializersModule

abstract val variablesSerializersModule: SerializersModule?

The module variablesSerializer resolves contextual serializers from, if any.

Functions

copy

@ExperimentalFirebaseDataConnect

abstract 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>

A copy of this reference with the given values replaced.

equals

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

execute

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

Executes the operation; throws DataConnectOperationException when the server reports errors.

hashCode

abstract override fun hashCode(): Int

toString

abstract override fun toString(): String

withDataDeserializer

@ExperimentalFirebaseDataConnect

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

A copy of this reference decoding its data with another deserializer.

withVariablesSerializer

@ExperimentalFirebaseDataConnect

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

A copy of this reference with other variables, and their serializer.