Portal Android SDK/io.portalhq.android.api/Api/ejectClient

ejectClient

@JvmOverloads
open fun ejectClient(traceId: String? = null): Result<Boolean>

Ejects the client from the system, removing their session.

Return

A Result<Boolean> indicating whether the ejection was successful.

Parameters

traceId

Optional trace ID forwarded as the X-Portal-Trace-Id header. When null, a new UUID is generated for this request.

Throws

on a backend HTTP 400 response. Wrap the call in try/catch — the signature is Result<Boolean> but no runCatching is used, so the throw still escapes uncaught.