FrameSDK/com.framepayments.framesdk/FrameNetworking

FrameNetworking

Central SDK singleton. Initialize once with initializeWithAPIKey from your Application.onCreate before using any Frame UI component or API client.

Samples

Properties

accountId

@Volatile

var accountId: String?

The Frame account this app run belongs to, set at initializeWithAPIKey or resolved later via setAccountIdIfUnset. Read by com.framepayments.framesdk.accountevents.AccountEventEmitter to attribute account events.

apiPublishableKey

var apiPublishableKey: String

The publishable key set during initializeWithAPIKey. Used for client-safe API calls.

apiSecretKey

var apiSecretKey: String

The secret key set during initializeWithAPIKey. Used as the Bearer token for most API calls.

asyncURLSession

var asyncURLSession: URLSessionProtocol

HTTP session used for all suspend-based API calls. Replace in tests to inject a mock.

CURRENT_VERSION

const val CURRENT_VERSION: <Error class: unknown class>

The current SDK version string, sourced from BuildConfig.

debugMode

var debugMode: Boolean

When true, request URLs, request bodies, and response bodies are printed to logcat.

eventPlatform

@Volatile

var eventPlatform: String

The platform reported on emitted account events. Defaults to "android"; overridden by setHostSDKInfo when this build runs under a wrapper SDK.

googlePayMerchantId

var googlePayMerchantId: String?

Google Pay merchant identifier, captured at SDK init and read by every Google Pay surface (FrameGooglePayButton, the bundled checkout, onboarding's wallet attach). Null until set.

gson

val gson: Gson

Gson instance shared across all SDK API clients.

hasActiveOnboardingSession

val hasActiveOnboardingSession: Boolean

Whether an onboarding session (onb_sess_…) is currently active. Lets the onboarding flow avoid re-minting a session when the host already supplied one via OnboardingContainerView.

hostSDKVersion

@Volatile

var hostSDKVersion: String?

The wrapper SDK's version reported alongside emitted account events, if any.

isEvervaultConfigured

var isEvervaultConfigured: Boolean

true once Evervault has been successfully configured; false until then.

mainApiUrl

var mainApiUrl: String

Base URL for all Frame API requests. Defaults to the production endpoint.

okHttpClient

val okHttpClient: OkHttpClient

Shared OkHttp client configured with Frame's standard timeouts.

Functions

applyEvervaultConfiguration

fun applyEvervaultConfiguration(config: ConfigurationResponses.GetEvervaultConfigurationResponse?): Boolean

Applies Evervault credentials when both team id and app id are present. Returns false if config is missing or invalid (do not use Evervault card inputs until this returns true).

beginOnboardingSession

fun beginOnboardingSession(clientSecret: String)

Begins an onboarding session scoped to a single account.

configureEvervault

fun configureEvervault()

Loads Evervault credentials from secure storage or the Frame API (callback-based variant). Prefer EvervaultConfigurator.ensureConfigured from a coroutine when possible.

currentSonarSessionId

fun currentSonarSessionId(): String?

Returns the current Sonar session identifier, or null if Sonar has not been initialized.

endOnboardingSession

@Synchronized

fun endOnboardingSession(clientSecret: String? = null)

Ends the active onboarding session, restoring normal pk_/sk_ authentication.

ensureEvervaultReadyForCardInputs

suspend fun ensureEvervaultReadyForCardInputs(): Boolean

Loads Evervault config from secure storage or the Frame API, then applies it. Call from a coroutine before showing Evervault RowsPaymentCard / EncryptedPaymentCardInput.

getContext

fun getContext(): Context

Returns the application context stored during initializeWithAPIKey.

initializeWithAPIKey

fun initializeWithAPIKey(context: Context, secretKey: String, publishableKey: String, accountId: String? = null, googlePayMerchantId: String? = null, debug: Boolean = false)

Initializes the Frame SDK. Call once from Application.onCreate before using any SDK component.

parseListResponse

inline fun <T> parseListResponse(data: ByteArray?): List<T>?

Deserializes data from a JSON array into a list of T, or returns null on failure.

parseResponse

inline fun <T> parseResponse(data: ByteArray?): T?

Deserializes data from JSON into type T, or returns null on failure.

performDataTask

suspend fun performDataTask(endpoint: FrameNetworkingEndpoints, auth: FrameAuthMode = FrameAuthMode.Secret): Pair<ByteArray?, NetworkingError?>

Executes a GET or DELETE request to endpoint and returns the raw response bytes.

fun performDataTask(endpoint: FrameNetworkingEndpoints, auth: FrameAuthMode = FrameAuthMode.Secret, completion: (data: ByteArray?, error: NetworkingError?) -> Unit)

Callback-based GET/DELETE for callers that cannot use coroutines.

performDataTaskWithRequest

suspend fun performDataTaskWithRequest(endpoint: FrameNetworkingEndpoints, request: Any? = null, auth: FrameAuthMode = FrameAuthMode.Secret): Pair<ByteArray?, NetworkingError?>

Executes a POST or PATCH request to endpoint, serializing request as the JSON body.

fun <T> performDataTaskWithRequest(endpoint: FrameNetworkingEndpoints, request: T? = null, auth: FrameAuthMode = FrameAuthMode.Secret, completion: (data: ByteArray?, error: NetworkingError?) -> Unit)

Callback-based POST/PATCH for callers that cannot use coroutines.

performMultipartDataTask

suspend fun performMultipartDataTask(endpoint: FrameNetworkingEndpoints, filesToUpload: List<FileUpload>, auth: FrameAuthMode = FrameAuthMode.Secret): Pair<ByteArray?, NetworkingError?>

Executes a multipart POST to endpoint, uploading each FileUpload as a form-data part.

fun performMultipartDataTask(endpoint: FrameNetworkingEndpoints, filesToUpload: List<FileUpload>, auth: FrameAuthMode = FrameAuthMode.Secret, completion: (data: ByteArray?, error: NetworkingError?) -> Unit)

Callback-based multipart POST for callers that cannot use coroutines.

setAccountIdIfUnset

fun setAccountIdIfUnset(accountId: String?)

Publishes an account resolved after initializeWithAPIKey — onboarding creates the account mid-flow, so a host that launched without one would otherwise emit nothing for the whole run.

setHostSDKInfo

fun setHostSDKInfo(platform: String, version: String)

Tags subsequent account events as originating from a wrapper SDK (e.g. frame-react-native) instead of directly from this SDK.

sonarSessionManagerOrNull

fun sonarSessionManagerOrNull(): SessionManager?

Returns the SDK's SonarSessionManager, or null if Sonar has not been initialized.