QuerySubscriptionResult

interface QuerySubscriptionResult<Data : Any?, Variables : Any?>


The result of a query's execution, as notified to a QuerySubscription.

Safe for Concurrent Use

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

Not Stable for Inheritance

The QuerySubscriptionResult interface is not stable for inheritance in third-party libraries, as new methods might be added to this interface or contracts of the existing methods can be changed.

Summary

Public functions

operator Boolean
equals(other: Any?)

Compares this object with another object for equality.

Int

Calculates and returns the hash code for this object.

String

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

Public properties

QueryRef<Data, Variables>

The query that was executed, whose result is captured in this object.

Result<QueryResult<Data, Variables>>

The result of the query execution: a successful result if the query was executed successfully, or a failure if the query's execution failed.

Public functions

equals

operator fun equals(other: Any?): Boolean

Compares this object with another object for equality.

Parameters
other: Any?

The object to compare to this for equality.

Returns
Boolean

true if, and only if, the other object is an instance of the same implementation of QuerySubscriptionResult whose public properties compare equal using the == operator to the corresponding properties of this object.

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.

Returns
Int

the hash code for this object, that incorporates the values of this object's public properties.

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, which includes the class name and the values of all public properties.

Public properties

query

val queryQueryRef<Data, Variables>

The query that was executed, whose result is captured in this object.

result

val resultResult<QueryResult<Data, Variables>>

The result of the query execution: a successful result if the query was executed successfully, or a failure if the query's execution failed.