Types

Link copied to clipboard
@Serializable
@SerialName(value = "ClearStatus")
class ClearStatus : ServerRequest

Send a request to the server to inform all of its clients to hide any status message that may be showing.

Link copied to clipboard
@Serializable
@SerialName(value = "IncrementVersion")
class IncrementVersion : ServerRequest

Send a request to the server asking it to increment a monotonically increasing version count.

Link copied to clipboard
@Serializable
@SerialName(value = "PauseClientEvents")
@ApiStatus.AvailableSince(value = "0.23.0")
class PauseClientEvents : ServerRequest

Send a request to the server asking it to stop sending out events to its clients.

Link copied to clipboard
@Serializable
@SerialName(value = "ResumeClientEvents")
@ApiStatus.AvailableSince(value = "0.23.0")
class ResumeClientEvents : ServerRequest

Send a request to the server asking it to resume sending out events to its clients.

Link copied to clipboard
@Serializable
@SerialName(value = "SetStatus")
class SetStatus(val message: String, val isError: Boolean = false, var timeoutMs: Long? = null) : ServerRequest

Send a request to the server with a status message that it should broadcast to its clients.

Link copied to clipboard
@Serializable
@SerialName(value = "Stop")
class Stop : ServerRequest

Ask the server to stop running.