B2BMagicLinks

interface B2BMagicLinks

MagicLinks interface that encompasses authentication functions as well as other related functionality

Types

Link copied to clipboard
data class AuthParameters(val token: String, val sessionDurationMinutes: UInt = Constants.DEFAULT_SESSION_TIME_MINUTES)

Data class used for wrapping parameters used with MagicLinks authentication

Link copied to clipboard
interface EmailMagicLinks

Provides all possible ways to call EmailMagicLinks endpoints

Functions

Link copied to clipboard
abstract suspend fun authenticate(parameters: B2BMagicLinks.AuthParameters): AuthResponse
abstract fun authenticate(parameters: B2BMagicLinks.AuthParameters, callback: (AuthResponse) -> Unit)

Wraps the magic link authenticate API endpoint which validates the magic link token passed in. If this method succeeds, the user will be logged in, granted an active session

Properties

Link copied to clipboard
abstract val email: B2BMagicLinks.EmailMagicLinks

Public variable that exposes an instance of EmailMagicLinks