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

GetProfileRequest

data class GetProfileRequest(account: String, async: Boolean?, address: JsonAddress) : SignaldRequestBodyV1<Profile>

Get all information available about a user

Constructors

GetProfileRequest

fun GetProfileRequest(account: String, async: Boolean? = null, address: JsonAddress)

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

the signald account to use

address

val address: JsonAddress

the address to look up

async

val async: Boolean? = null

if true, return results from local store immediately, refreshing from server in the background if needed. if false (default), block until profile can be retrieved from server

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