Close Menu

arncustomurlhelper

ARNCustomURLHelper is a lightweight Swift library that simplifies the process of working with custom URL schemes in iOS apps. With this library, you can easily handle custom URL schemes, detect installed apps, deep-link into other apps, and handle callbacks.

Installation

To integrate ARNCustomURLHelper into your Xcode project, you can use CocoaPods, Swift Package Manager, or manually install it.

Installation with CocoaPods

To use CocoaPods, add the following line to your Podfile:

pod 'ARNCustomURLHelper'

Installation with Swift Package Manager

To use Swift Package Manager, simply add ARNCustomURLHelper as a dependency in your Package.swift file:

.package(url: "https://github.com/your/repo", from: "1.0.0")

Manual Installation

If you prefer not to use either of the above methods, you can manually install the library:

  1. Download the latest release from the GitHub repository.
  2. Drag and drop the ARNCustomURLHelper files into your Xcode project.

Usage

Using ARNCustomURLHelper is straightforward. Follow the steps below to get started:

  1. Import ARNCustomURLHelper in your Swift file:

import ARNCustomURLHelper

  1. Create an instance of ARNCustomURLHelper:

let customURLHelper = ARNCustomURLHelper()

  1. Handle custom URL schemes by implementing the following method:
customURLHelper.handleURL(url) { (success, appURL) in
     if success {
         // Custom URL scheme handled successfully
         // appURL contains the URL returned by the app
     } else {
         // Custom URL scheme handling failed
     }
 }

Additional Information

Recognizing Installed Apps

You can use ARNCustomURLHelper to check whether an app with a specific custom URL scheme is installed on the user’s device:

if customURLHelper.isAppInstalled("yourAppURLScheme") {
  // App is installed, perform action
} else {
  // App is not installed, show appropriate message
}

Deep Linking

ARNCustomURLHelper allows you to easily deep-link into other apps. Simply call the following method:

customURLHelper.openURL("yourAppURLScheme://yourPath")

Handling Callbacks

If the target app returns a custom URL scheme after handling the deep link, you can retrieve it using the handleURL method:

customURLHelper.handleURL(url) { (success, appURL) in
     if success {
         // Custom URL scheme handled successfully
         // appURL contains the URL returned by the app
     } else {
         // Custom URL scheme handling failed
     }
 }

Conclusion

ARNCustomURLHelper simplifies working with custom URL schemes in your iOS app. It provides a convenient way to handle custom URL schemes, detect installed apps, deep-link into other apps, and handle callbacks. Use this library to enhance your app’s functionality and provide a seamless user experience.