Javascript Integration API Documentation

It is a javascript API that allows you to control the web view and the push-only prototype app provided by Swing2App.

In short, include and use the following js file through the API specification below and perform the functions you need.

Common js file Please include the following js file in your HTML file

<script src="https://pcdn2.swing2app.co.kr/swing_public_src/v3/2023_01_16_001/js/swing_app_on_web.js"></script>

WebView Javascript API Specifications

Webview Control Related Methods

• Webview Backwards

To Move to the previous page in the webview app. Same style as the back function in the web browser

swingWebViewPlugin.app.webview.back();

• Webview Forward

Move to the front page in the webview app. Same style as the forward function in the web browser

swingWebViewPlugin.app.webview.forward();

• Go to Webview Home

Ability to navigate from the webview app to the home page (set initial page) set in the Swing2App.

swingWebViewPlugin.app.navigateToHome()

Application-related methods

• Get platform information

Functions for getting platform information from the web

if( swingWebViewPlugin.app.methods.getCurrentPlatform() == 'android' )
{
    console.log('android');
}
else if( swingWebViewPlugin.app.methods.getCurrentPlatform() == 'ios' )
{
    console.log('ios');
}
else
{
    console.log('web browser');
}

• Get version and device information

A function that gets the version of the app and the H/W and S/W information of the device

// android
swingWebViewPlugin.app.methods.getAppVersion(function(value){
    console.log('model : ' + value.model);
    console.log('sdk_version : ' + value.version);
    console.log('version_release : ' + value.version_release);
    console.log('manufacturer : ' + value.manufacturer);
    console.log('app_version : ' + value.appVersion);
    console.log('radio_version : ' + value.radio_version);
    console.log('package_name : ' + value.packageName);
});

// ios
swingWebViewPlugin.app.methods.getAppVersion(function(value){
    console.log('model : ' + value.model);
    console.log('name : ' + value.name);
    console.log('systemVersion : ' + value.systemVersion);
    console.log('appVersion : ' + value.appVersion);
    console.log('bundleVersion : ' + value.bundleVersion);
    console.log('bundleID : ' + value.bundleID);
});

• Ability to close the app

Command to terminate a running app

swingWebViewPlugin.app.methods.doExitApp();

• Run a URL with an external browser

If you want to open a specific page with the default browser of an app such as Chrome or Safari, you can use the following function.

swingWebViewPlugin.app.methods.doExternalOpen('https://www.swing2app.com');

• Run URLs with the embedded browser

Run using Android and iOS's own built-in browser.

If you must use Chrome and Safari, you can operate Chrome and Safari from inside the app through the code below.

swingWebViewPlugin.app.methods.openBrowser('https://www.swing2app.com');

• Share the current page

Run the code below for the current Web page-sharing feature

swingWebViewPlugin.app.methods.doShareCurrentPage();

• Share a custom URL

If you want to share the specified URL, run the code as shown below.

swingWebViewPlugin.app.methods.doShareWithUrl('https://www.swing2app.com');

• Checking the notification setting status of the application

Ability to check the status of push alarm settings in the application.

If the push is disabled or if the push is turned off by the OS itself,

You can check if the app is turned off with its own settings.

swingWebViewPlugin.app.methods.isNotificationEnabled(function (result) {
    if( result == '1' ) // Able to send push notification
    {
        console.log('push active');
    }
    else if( result == 'off_on_system' )    // Disabling app push by OS setting
    {
        console.log('push inactive');
    }
    else if( result == 'off_on_app' )       // Disable App Push by App Settings
    {
        console.log('push inactive');
    }
});

Ex:) Code example for recommending activation when Off setting according to push setting

swingWebViewPlugin.app.methods.isNotificationEnabled(function (result) {
    if( result == '1' ) // Able to send push notification
    {
        console.log('push active');
    }
    else if( result == 'off_on_system' )    // Disabling app push by OS setting
    {
        console.log('push inactive');
        swingWebViewPlugin.app.methods.goToNotificationSetting("system"); // Open Notification Setting in System setting
    }
    else if( result == 'off_on_app' )       // Disable App Push by App Settings
    {
        console.log('push inactive');
        swingWebViewPlugin.app.methods.goToNotificationSetting("app");    // Open Notification Setting in App
    }
});

• Alarm Settings

Ability to move alarm settings of applications or systems

(1) Go to the screen where you can set the alarm by the application itself

swingWebViewPlugin.app.methods.goToNotificationSetting('app');

(2) Go to the screen where you can set your own alarm for the system (Android, iOS)

swingWebViewPlugin.app.methods.goToNotificationSetting('system');

Methods related to AdMob

This is a command that allows you to manage in-app AdMob ads directly from the website.

Please refer to the information below to use the ads.

This command only works for apps with ad mob enabled

• Show banner ads

Commands to display AdMob banner ads in applications

Parameter	Explanation	Example values
adId	Enter banner ad unit ID	ca-app-pub-3940256099942544/6300978111

swingWebViewPlugin.app.admob.showBanner('ca-app-pub-3940256099942544/6300978111');

• End banner ads

Command to stop AdMob banner ads in the application

swingWebViewPlugin.app.admob.closeBanner();

• Show interstitial ads

Commands to display AdMob interstitial ads in applications

Parameter	Explanation	Example values
adId	Enter interstitial unit ID	ca-app-pub-3940256099942544/6300978111

swingWebViewPlugin.app.admob.showInterstitialAd('ca-app-pub-3940256099942544/6300978111');