yorkie/dev.yorkie.core/Client/DeactivateOptions

DeactivateOptions

data class DeactivateOptions(val keepalive: Boolean? = null, val synchronous: Boolean? = null)

DeactivateOptions are user-settable options used when deactivating clients.

Constructors

Link copied to clipboard
constructor(keepalive: Boolean? = null, synchronous: Boolean? = null)

Properties

Link copied to clipboard
val keepalive: Boolean? = null

keepalive is used to enable the keepalive option when deactivating. If true, the client will request deactivation immediately using fetch with the keepalive option enabled. This is useful for ensuring the deactivation request completes even if the page is being unloaded.

Link copied to clipboard
val synchronous: Boolean? = null

synchronous is used to enable the synchronous option when deactivating. If true, the server will wait for all pending operations to complete before deactivating.