Type Alias BrowserOpenOptions

Configuration for launching the browser.

The callbackUrlScheme is required to receive the redirect back into the app.

type BrowserOpenOptions = {
    callbackUrlScheme: string;
    ios?: JourneyInstance;
    redirectUri?: string;
}

Properties

callbackUrlScheme: string

App callback scheme used to receive the redirect.

Examples:

iOS: Passed to ASWebAuthenticationSession callbackURLScheme.

Android: Used for per-launch redirect handling and must match the manifestPlaceholder appRedirectUriScheme.

iOS-only options.

redirectUri?: string

Optional full redirect URI override.

Android: Supported and recommended for per-launch configuration.

iOS: Typically handled by the authentication layer; ignored if not applicable.