Custom URL Scheme

Hybrid

Filter by IDE
Select the AppBuilder client you are currently using for development.

IDE

Custom URL Schemes in iOS and Android

Try in the Platform

This sample shows you how to use an Android-specific custom plugin and the Info.plist configuration file for iOS to register a custom URL scheme for your app. You can later call the app from another app using the custom URL scheme.

Supported mobile platforms: iOS 7.1+, Android 4.4+

Developed with: Apache Cordova 4.0.0, WebIntent 1.0.0

Back to Top

Important Directories and Files

  • Plugins\WebIntent: Contains the Android-specific custom plugin.
  • App_Resources\Android\AndroidManifest.xml: Contains the configuration changes which register the app to a custom URI scheme.
  • App_Resources\iOS\Info.plist: Contains the configuration changes which register the app to a custom URI scheme.

Back to Top

Screenshots

Platform Home
All

Back to Top

Test the Sample

Apart from exploring the sample code base in GitHub, you can also clone and run the sample in your preferred AppBuilder client.

In-Browser

With the AppBuilder in-browser client, you can develop hybrid and NativeScript cross-platform mobile apps from your browser. You can use the in-browser client at https://platform.telerik.com.

Clone the sample

  1. Click the button at the top of this document.
  2. Provide your login credentials, if prompted.

Run the sample

  1. Deploy on device via QR code.
  2. After the installation completes, run the app.
  3. Create a new Blank (JavaScript) project.
  4. In the Project Navigator, double-click index.html.
  5. Within the <body> element, add the following line.

    <button onclick="window.open('myapp://views/navigate.html', '_system')">Open App</button>
    
  6. Deploy on device via QR code.

  7. On the device, run the app that you have just deployed and tap Open App.

Back to Top

Windows

With the AppBuilder Windows client, you can develop hybrid and NativeScript cross-platform mobile apps from your Windows desktop. You can download and install the Windows client from http://www.telerik.com/appbuilder/windows-client.

Clone the sample

  1. Verify that the AppBuilder Windows client is running and you are logged in the Telerik Platform in the account in which you want to develop your application.
  2. In the dashboard, click Samples and select Hybrid.
  3. From the Workspace drop-down menu, select the workspace in which you want to develop your application.
  4. Select Advanced APIs.
  5. Select Custom URL Scheme.
  6. (Optional) Rename the project.
  7. Click Clone.

Run the sample

With the AppBuilder Windows client, you can quickly test your apps on device, in the simulator or in the native emulators.

  1. Deploy on device via QR code or deploy on device via USB cable.
  2. After the installation completes, run the app.
  3. Create a new Blank (JavaScript) project.
  4. In the Project Navigator, double-click index.html.
  5. Within the <body> element, add the following line.

    <button onclick="window.open('myapp://views/navigate.html', '_system')">Open App</button>
    
  6. Deploy on device via QR code or deploy on device via USB cable.

  7. On the device, run the app that you have just deployed and tap Open App.

Back to Top

Visual Studio

With the AppBuilder extension for Visual Studio, you can develop hybrid and NativeScript cross-platform mobile apps from Microsoft Visual Studio. You can download and install the extension here.

Clone the sample

  1. Verify that the AppBuilder extension for Visual Studio is running and you are logged in the Telerik Platform in the account in which you want to develop your application.
  2. Select AppBuilderGet Sample.
  3. Select Hybrid.
  4. Select Advanced APIs.
  5. Select Custom URL Scheme.
  6. (Optional) Rename the project.
  7. Click Get.

The extension for Visual Studio copies the sample files locally. The extension creates a new solution and project and loads them.

Run the sample

With the AppBuilder extension for Visual Studio, you can quickly test your apps on device, in the simulator or in the native emulators.

  1. Deploy on device via QR code or deploy on device via USB cable.
  2. After the installation completes, run the app.
  3. Create a new Blank (JavaScript) project.
  4. In the Solution Explorer, double-click index.html.
  5. Within the <body> element, add the following line.

    <button onclick="window.open('myapp://views/navigate.html', '_system')">Open App</button>
    
  6. Deploy on device via QR code or deploy on device via USB cable.

  7. On the device, run the app that you have just deployed and tap Open App.

Back to Top

CLI

With the AppBuilder command-line interface, you can develop hybrid and NativeScript cross-platform mobile apps from the command line. You can learn how to add the AppBuilder commands to your command line here.

Clone the sample

  1. Verify that a command prompt is running and you are logged in the Telerik Platform in the account in which you want to develop your application.
  2. To list the available samples, run the following command.

    appbuilder sample
    
  3. Run the clone command for the sample as listed by appbuilder sample.

    appbuilder sample clone custom-url-scheme
    

The AppBuilder command-line interface shows the following message: Successfully initialized project in the folder!

Run the sample

With the AppBuilder command-line interface, you can quickly test your apps on device, in the simulator or in the native emulators.

  1. Deploy on device via QR code or deploy on device via USB cable.
  2. After the installation completes, run the app.
  3. Create a new Blank (JavaScript) project.
  4. For the newly created project, open index.html.
  5. Within the <body> element, add the following line.

    <button onclick="window.open('myapp://views/navigate.html', '_system')">Open App</button>
    
  6. Deploy on device via QR code or deploy on device via USB cable.

  7. On the device, run the app that you have just deployed and tap Open App.

Back to Top

Limitations

  • You cannot run this sample in the device simulator.
  • You cannot run this sample on Android emulators.
  • You cannot run this sample in the iOS Simulator.
  • You cannot run this sample in the companion apps.
  • This sample is not enabled for Windows Phone development.

Back to Top

Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.