ApiAuthenticator

Abstracts how the SDK authenticates with the API.

If an application has an existing authentication/authorisation workflow then an Adapter class can be used to integrate that workflow into the SDK to provide the necessary authentication

interface ApiAuthenticator<T : Any>

Parameters

T

The type of authentication details

Functions

authenticate
Link copied to clipboard

Called by the SDK to obtain authentication details eg: an access token

abstract fun authenticate(): ApiResult<T>
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String

Inheritors

EmptyTokenApiAuthenticator
Link copied to clipboard
ProvidedTokenAuthenticator
Link copied to clipboard
StoringApiAuthenticator
Link copied to clipboard