kotlin-components-docs/mozilla.appservices.relay/RelayClientInterface

RelayClientInterface

interface RelayClientInterface

Represents a client for the Relay API.

Use this struct to connect and authenticate with a Relay server, managing authorization to call protected endpoints.

Authorization

Clients should use the fxa_client::FirefoxAccount::getAccessToken() function to obtain a relay-scoped access token (scope: https://identity.mozilla.com/apps/relay).
Then, construct the `RelayClient` with the access token. All requests will then be authenticated to the Relay server via Authorization: Bearer {fxa-access-token}.
The Relay server verifies this token with the FxA OAuth /verify endpoint.
Clients are responsible for getting a new access token when needed.

Inheritors

Types

object Companion

Functions

abstract fun acceptTerms()

Creates a Relay user record in the Relay service database.

abstract fun createAddress(description: String, generatedFor: String, usedOn: String): RelayAddress

Creates a new Relay mask (alias) with the specified metadata.

abstract fun fetchAddresses(): List<RelayAddress>

Retrieves all Relay addresses associated with the current account.