Portal Android SDK/io.portalhq.android.utils.credentials

Package-level declarations

Types

Link copied to clipboard
interface PortalCredentials

Supplies the credential io.portalhq.android.Portal authenticates its API calls with.

Link copied to clipboard
class StaticCredentials(val value: String) : PortalCredentials

Wraps a custodian-issued Client API Key as a PortalCredentials.

Functions

Link copied to clipboard
fun invalidateCredentials(credentials: PortalCredentials)

Invalidates credentials in response to a 401.

Link copied to clipboard
fun reportUnauthorized(credentials: PortalCredentials)

The 401 path every Portal-authenticated requester routes through: invalidate the credential, then tell the host its session ended.

Link copied to clipboard
fun resolveCredentials(apiKey: String?, credentials: PortalCredentials?): PortalCredentials

Resolves the single credential source a component was constructed with.

Link copied to clipboard
fun resolveCredentialToken(credentials: PortalCredentials): String

The SDK's credential boundary: resolves a token, normalizing every failure to PortalException.Credentials.PortalCredentialError since a host-supplied PortalCredentials can throw anything.

Link copied to clipboard
fun staticApiKeyOf(credentials: PortalCredentials): String

The raw Client API Key behind credentials, or "" when it is not a static key — never a wrong or stale token.