soil-query-core/soil.query/SubscriptionEffectClient

SubscriptionEffectClient

interface SubscriptionEffectClient : SubscriptionReadonlyClient

Interface for causing side effects on Subscription under the control of SubscriptionClient.

Inheritors

Functions

Link copied to clipboard
abstract fun <T> getSubscriptionData(id: SubscriptionId<T>): T?

Retrieves data of the SubscriptionKey associated with the id.

Link copied to clipboard
abstract fun removeSubscriptions(filter: RemoveSubscriptionsFilter)

Removes the subscriptions by the specified RemoveSubscriptionsFilter.

Link copied to clipboard
abstract fun <U : UniqueId> removeSubscriptionsBy(vararg ids: U)

Removes the subscriptions by the specified UniqueId.

Link copied to clipboard
abstract fun resumeSubscriptions(filter: ResumeSubscriptionsFilter)

Resumes the subscriptions by the specified ResumeSubscriptionsFilter.

Link copied to clipboard
abstract fun <U : UniqueId> resumeSubscriptionsBy(vararg ids: U)

Resumes the subscriptions by the specified UniqueId.

Link copied to clipboard
abstract fun <T> updateSubscriptionData(id: SubscriptionId<T>, edit: T.() -> T)

Updates the data of the SubscriptionKey associated with the id.