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

SetDeviceNameRequest

data class SetDeviceNameRequest(account: String, deviceName: String?) : SignaldRequestBodyV1<EmptyResponse>

set this device's name. This will show up on the mobile device on the same account under settings -> linked devices

Constructors

fun SetDeviceNameRequest(account: String, deviceName: String? = null)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): EmptyResponse

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

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): EmptyResponse

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

Properties

account

val account: String

The account to set the device name of

deviceName

val deviceName: String? = null

The device name

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