runtime/io.github.kikin81.atproto.runtime/XrpcClient

XrpcClient

class XrpcClient(baseUrl: String, val httpClient: HttpClient, val json: Json = DefaultJson, val authProvider: AuthProvider = NoAuth)

Ktor-backed XRPC client. Wraps a caller-supplied HttpClient so consumers control the engine, timeouts, retries, and logging. Generated XRPC bindings call query for GET /xrpc/<nsid> and procedure for POST /xrpc/<nsid>.

Auth is attached via a pluggable AuthProvider, never as a field on request DTOs. Override per-call with the auth parameter.

Parameters

baseUrl

Root URL of the PDS / AppView, e.g. https://bsky.social. No trailing /xrpc — the client appends it.

Constructors

XrpcClient

constructor(baseUrl: String, httpClient: HttpClient, json: Json = DefaultJson, authProvider: AuthProvider = NoAuth)

Types

Companion

object Companion

Properties

authProvider

val authProvider: AuthProvider

httpClient

val httpClient: HttpClient

json

val json: Json

Functions

procedure

suspend fun <P, R> procedure(nsid: String, params: P, paramsSerializer: KSerializer, responseSerializer: KSerializer<R>, errorMapper: XrpcErrorMapper = DefaultXrpcErrorMapper, auth: AuthProvider? = null, proxy: String? = null): R

Overload for procedures with no input body (e.g. deleteSession).

suspend fun <P, R> procedure(nsid: String, params: P, paramsSerializer: KSerializer, input: ByteArray, inputContentType: ContentType, responseSerializer: KSerializer<R>, errorMapper: XrpcErrorMapper = DefaultXrpcErrorMapper, auth: AuthProvider? = null, proxy: String? = null): R

Overload for procedures whose lexicon declares a non-JSON input.encoding (e.g. image/jpeg, video/mp4, or the wildcard */* used by com.atproto.repo.uploadBlob). The bytes are posted verbatim with the supplied inputContentType. Auth, DPoP, 401 retry, and error mapping behave identically to the JSON-body overload.

suspend fun <P, I, R> procedure(nsid: String, params: P, paramsSerializer: KSerializer, input: I, inputSerializer: KSerializer, responseSerializer: KSerializer<R>, encoding: String = ContentType.Application.Json.toString(), errorMapper: XrpcErrorMapper = DefaultXrpcErrorMapper, auth: AuthProvider? = null, proxy: String? = null): R

query

suspend fun <P, R> query(nsid: String, params: P, paramsSerializer: KSerializer, responseSerializer: KSerializer<R>, errorMapper: XrpcErrorMapper = DefaultXrpcErrorMapper, auth: AuthProvider? = null, proxy: String? = null): R