yorkie/dev.yorkie.core/Client/Options

Options

data class Options(val key: String = UUID.randomUUID().toString(), val apiKey: String? = null, val fetchAuthToken: suspend (shouldRefresh: Boolean) -> String? = null, val syncLoopDuration: Duration = 50.milliseconds, val reconnectStreamDelay: Duration = 1_000.milliseconds)

User-settable options used when defining Client.

Constructors

Options

constructor(key: String = UUID.randomUUID().toString(), apiKey: String? = null, fetchAuthToken: suspend (shouldRefresh: Boolean) -> String? = null, syncLoopDuration: Duration = 50.milliseconds, reconnectStreamDelay: Duration = 1_000.milliseconds)

Properties

apiKey

val apiKey: String? = null

API key of the project used to identify the project.

fetchAuthToken

val fetchAuthToken: suspend (shouldRefresh: Boolean) -> String? = null

fetchAuthToken provides a token for the auth webhook. When the webhook response status code is 401, this function is called to refresh the token. The reason parameter is the reason from the webhook response.

key

val key: String

Client key used to identify the client. If not set, a random key is generated.

reconnectStreamDelay

val reconnectStreamDelay: Duration

Delay of the reconnect stream. If the stream is disconnected, the client waits for the delay to reconnect the stream. The default value is 1000(ms).

syncLoopDuration

val syncLoopDuration: Duration

Duration of the sync loop. After each sync loop, the client waits for the duration to next sync. The default value is 50(ms).