ResolveAddressRequest

data class ResolveAddressRequest(account: String, partial: JsonAddress) : SignaldRequestBodyV1<JsonAddress>

Resolve a partial JsonAddress with only a number or UUID to one with both. Anywhere that signald accepts a JsonAddress will except a partial, this is a convenience function for client authors, mostly because signald doesn't resolve all the partials it returns.

Constructors

Link copied to clipboard
fun ResolveAddressRequest(account: String, partial: JsonAddress)

Functions

Link copied to clipboard
fun submit(socketCommunicator: SocketCommunicator): JsonAddress
open override fun submit(socketCommunicator: SocketCommunicator, id: String): JsonAddress
Link copied to clipboard
suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): JsonAddress
open suspend override fun submitSuspend(socketCommunicator: SuspendSocketCommunicator, id: String): JsonAddress

Properties

Link copied to clipboard
val account: String

The signal account to use

Link copied to clipboard
val id: String

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

Link copied to clipboard
val partial: JsonAddress

The partial address, missing fields

Link copied to clipboard
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