Stytch Android/com.stytch.sdk.common

Package-level declarations

This package contains resources shared between our B2B and Consumer SDKs, including helpful typealiases, utility functions, data models, and internal support code.

Types

BaseResponse

typealias BaseResponse = StytchResult<BasicData>

Type alias for StytchResult used for basic responses

DeeplinkHandledStatus

interface DeeplinkHandledStatus

A class representing the three states of a deeplink handled by StytchClient.handle() / StytchB2BClient.handle()

DeeplinkResponse

sealed class DeeplinkResponse

A class representing the types of Deeplink responses that the Stytch client has handled

DeeplinkTokenPair

data class DeeplinkTokenPair(val tokenType: TokenType, val token: String?)

A data class representing a concrete token type and corresponding token parsed from a deeplink

EndpointOptions

data class EndpointOptions @JvmOverloads constructor(val dfppaDomain: String = "telemetry.stytch.com")

Defines custom endpoints used by the SDK

NoResponseResponse

typealias NoResponseResponse = StytchResult<NoResponseData>

Type alias for StytchResult used for empty responses

PKCECodePair

data class PKCECodePair(val codeChallenge: String, val codeVerifier: String, val method: String = "S256")

A data class representing the most recent PKCE code pair generated on this device. You may find this useful if you use a hybrid (frontend and backend) authentication flow, where you need to complete a PKCE flow on the backend

StytchClientOptions

data class StytchClientOptions @JvmOverloads constructor(val endpointOptions: EndpointOptions = EndpointOptions())

Options for configuring the StytchClient

StytchResult

sealed class StytchResult<out T> : Parcelable

Provides a wrapper for responses from the Stytch API

TokenType

interface TokenType

An interface representing the supported token types that we can extract from a deeplink

Properties

DEFAULT_OTP_EXPIRATION_TIME_MINUTES

const val DEFAULT_OTP_EXPIRATION_TIME_MINUTES: Int = 10

The default time that an OTP code will be valid. This is used if you do not provide an expiration duration to an OTP loginOrCreate or send call

DEFAULT_SESSION_TIME_MINUTES

const val DEFAULT_SESSION_TIME_MINUTES: Int = 5

The default time that a created session will be valid. This is used if you do not provide a session duration to an authentication call, and defaults to the shortest valid session duration supported by Stytch (5 minutes)