clientprotocol/org.inthewaves.kotlinsignald.clientprotocol.v1.structures/SignaldRequestBodyV1

SignaldRequestBodyV1

sealed class SignaldRequestBodyV1<ResponseData>

A base class for requests. This class is only used for serializing requests to the signald socket; the type of the responseWrapperSerializer property represents the response JSON structure.

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): ResponseData

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): ResponseData

Properties

val id: String

The id to include in the request. This is expected to be present in the response JSON.

version

val version: String

The version to include in the request. As this class won't be used to deserialize the response, the Required annotation is being used to force this field to be serialized