Junction Core SDK

Overview

Check out the SDK Authentication guide on the available SDK authentication schemes, and how to authenticate with the Junction Mobile SDK.

Mobile SDK Authentication

Learn how to authenticate your mobile app user with Junction Mobile SDK.

Accessing Junction API

You can access Junction API through VitalClient with typed request methods and response models.

Native iOS

// e.g. Link Service
let linkService = VitalClient.shared.link

Typed API access is not yet available in React Native.

Generating Junction Link URL

You can obtain an URL to the Junction Link Widget through VitalClient.linkWidgetUrl. Note that the URL contains a short-lived token with 10-minute expiry.

For the redirectUrl, you should set it to a URL with a custom URL scheme which your app would register to handle.

Native iOS

let widgetUrl = await VitalClient.shared.link.createProviderLink(
  redirectURL: "x-vital-app://"
)

Core SDK Status

You can inspect the status of the Core SDK for troubleshooting, as well as for your own business logic. For example, you may reconcile your user session and the Junction SDK sign-in based on the Core SDK status.

The SDK normally reports one of the following status combinations:

Combinations	Auth Scheme	Remarks
Empty	N/A	The SDK has neither been configured nor an active sign-in.
Configured	API Key	The SDK has been configured, but does not have an active sign-in.
Configured, SignedIn & UseApiKey	API Key	The active sign-in was done by setting an API Key and a target Junction User ID.
Configured, SignedIn & UseSignInToken	Junction Sign-In Token	The active sign-in was done by consuming a Junction Sign-In Token.

Get the current status

Native iOS

import VitalCore

let status: VitalClient.Status = VitalClient.status

Observe status changes over time

Native iOS

import VitalCore

// Combine Publisher
let cancellable = VitalClient.statusDidChange.sink { _ in }

// AsyncStream
Task {
  for status in VitalClient.statuses {
    // ...
  }
}

Get Current Junction User ID

Aside from the Core SDK Status, you can also query the Junction User ID of the signed-in user:

Native iOS

import VitalCore

let userId: String? = VitalClient.currentUserId

Reset the SDK (Sign Out)

Refer to the Sign Out section in the SDK Authentication guide.

Verbose Logging to Console/Logcat

You can enable verbose logging to have a deeper look into how Junction Mobile SDK is reacting to your calls, as well as all the automatic behaviours that the SDK is performing in background.

To avoid any missing log entry, you should enable verbose logging as early as possible — preferably before any usage of any Junction Mobile SDKs.

On Android, verbose logging is enabled by default when running as a debuggable build (i.e., with ApplicationInfo.FLAG_DEBUGGABLE).

Native iOS (Swift)

import VitalCore

class AppDelegate: NSObject, UIApplicationDelegate {
  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil
  ) -> Bool {

    VitalLogger.stdOutEnabled = true

    // ...

    return true
  }
}