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

SetProfile

data class SetProfile(account: String, name: String?, avatarFile: String?, about: String?, emoji: String?, mobilecoinAddress: String?, visibleBadgeIds: List<String>?) : SignaldRequestBodyV1<EmptyResponse>

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

about

val about: String? = null

Change the 'about' profile field

account

val account: String

The phone number of the account to use

avatarFile

val avatarFile: String? = null

Path to new profile avatar file. If unset or null, unset the profile avatar

emoji

val emoji: String? = null

Change the profile emoji

val id: String

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

mobilecoinAddress

val mobilecoinAddress: String? = null

Change the profile payment address. Payment address must be a base64-encoded MobileCoin address. Note that this is not the traditional MobileCoin address encoding, which is custom. Clients are responsible for converting between MobileCoin's custom base58 on the user-facing side and base64 encoding on the signald side.

name

val name: String? = null

Change the profile name

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

visibleBadgeIds

val visibleBadgeIds: List<String>? = null

configure visible badge IDs