Capabilities

openApp

Updated:

Opens a native app installed on the mobile device.

openApp is only supported inside the Q2 mobile banking app. It is not available in the mobile browser or desktop browser.

Description

openApp opens a native app installed on the mobile device, with the fallback of navigating to the application's install page in the app store if it is not already installed.

Signature

tecton.actions.openApp(params: OpenAppArgs): Promise<boolean>;
export interface OpenAppArgs {
    iOSScheme?: string;
    iOSAppStoreUrl?: string;
    androidPackage?: string;
    androidParamString?: string;
    redirectToAppStore?: boolean;
    errMsgTitle?: string;
    errMsgText?: string;
}

Usage

Open the Facebook app, or redirect to the app store if not installed.

tecton.actions.openApp({
    iOSScheme: 'fb://profile?myID=23423',
    iOSAppStoreUrl: 'https://itunes.apple.com/gd/app/facebook/id284882215',
    errMsgTitle: 'Facebook not installed',
    errMsgText: 'You will now be direct to the app store to download the application.',
    androidPackage: 'com.facebook.katana',
    androidParamString: 'myID=23423'
}).then(() => {
    // App opened successfully
}).catch(() => {
    // App failed to open
});

Additional Information

When using the openApp action, there are important details to keep in mind.

Mobile App Configuration

Google greatly restricts this function, so we need to configure your mobile app to be aware of any other apps you will be opening. Before you can open another app on Android, you must create a Q2 Support case requesting to add the package name to the "Sub App Package Name List". Support will configure that, rebuild, and republish your app. Then you will be able to use the openApp capability.

Parameters

Some parameters are only supported by specific platforms. Platform support for individual parameters will be indicated with a badge below the parameter name.

params.iOSScheme
iOS
params.iOSAppStoreUrl
iOS
params.androidPackage
Android
params.androidParamString
Android
params.redirectToAppStore
params.errMsgTitle
params.errMsgText

Platform Support

iOS
Android

Changelog

The changelog provides a detailed history of new features, improvements, and bug fixes going back to Tecton 1.30.0. If the button is disabled, it indicates there have been no detectable changes since then.

Show changelog (0)