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

UpdateContactRequest

data class UpdateContactRequest(account: String, address: JsonAddress, name: String?, color: String?, inboxPosition: Int?) : SignaldRequestBodyV1<Profile>

update information about a local contact

Constructors

fun UpdateContactRequest(account: String, address: JsonAddress, name: String? = null, color: String? = null, inboxPosition: Int? = null)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): Profile

open override fun submit(socketCommunicator: SocketCommunicator, id: String): Profile

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): Profile

open suspend override fun submitSuspend(socketCommunicator: SuspendSocketCommunicator, id: String): Profile

Properties

account

val account: String

Example: "0cc10e61-d64c-4dbc-b51c-334f7dd45a4a"

address

val address: JsonAddress

color

val color: String? = null

val id: String

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

inboxPosition

val inboxPosition: Int? = null

name

val name: String? = null

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