GeneratedConnector

interface GeneratedConnector<T : GeneratedConnector<T>>


The interface to be implemented by the over-arching "connector" classes that are generated by the Firebase Tools code generation.

Safe for Concurrent Use

All methods and properties of GeneratedConnector are thread-safe and may be safely called and/or accessed concurrently from multiple threads and/or coroutines.

Stable for Inheritance

The GeneratedConnector interface is stable for inheritance in third-party libraries, as new methods will not be added to this interface and contracts of the existing methods will not be changed, except possibly during major version number changes.

Summary

Public functions

T

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.

operator Boolean
equals(other: Any?)

Compares this object with another object for equality.

Int

Calculates and returns the hash code for this object.

List<GeneratedMutation<T, *, *>>

Returns a list containing all GeneratedMutation objects defined as properties in this object in an unspecified order.

List<GeneratedOperation<T, *, *>>

Returns a list containing all GeneratedQuery and GeneratedMutation objects defined as properties in this object.

List<GeneratedQuery<T, *, *>>

Returns a list containing all GeneratedQuery objects defined as properties in this object in an unspecified order.

String

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

Public properties

FirebaseDataConnect

The FirebaseDataConnect instance used by this object.

Public functions

copy

@ExperimentalFirebaseDataConnect
fun copy(dataConnect: FirebaseDataConnect = this.dataConnect): T

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.

If this methods returns true then invoking any method or accessing any property on this should have the same side effects as accessing the same property or invoking the same method with the same arguments on other, respectively. The implementation checks for logical equality, rather than referential equality. A likely implementation looks like this:

override fun equals(other: Any?): Boolean =
other is DemoGeneratedConnectorImpl &&
other.dataConnect == dataConnect
Parameters
other: Any?

The object to compare to this for equality.

Returns
Boolean

true if, and only if, the given object is logically "equal" to this object.

hashCode

fun hashCode(): Int

Calculates and returns the hash code for this object.

Returns
Int

the hash code for this object.

mutations

@ExperimentalFirebaseDataConnect
fun mutations(): List<GeneratedMutation<T, *, *>>

Returns a list containing all GeneratedMutation objects defined as properties in this object in an unspecified order.

See also
operations
queries

operations

@ExperimentalFirebaseDataConnect
fun operations(): List<GeneratedOperation<T, *, *>>

Returns a list containing all GeneratedQuery and GeneratedMutation objects defined as properties in this object.

Namely, the returned list will contain exactly the elements returned from queries and mutations, in an unspecified order.

See also
queries
mutations

queries

@ExperimentalFirebaseDataConnect
fun queries(): List<GeneratedQuery<T, *, *>>

Returns a list containing all GeneratedQuery objects defined as properties in this object in an unspecified order.

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.

Returns
String

a string representation of this object.

Public properties

dataConnect

val dataConnectFirebaseDataConnect

The FirebaseDataConnect instance used by this object.