Close Menu

CallbackURLKit

Introduction

Welcome to the CallbackURLKit documentation page. CallbackURLKit is a lightweight framework that simplifies managing and handling callback URLs in your iOS apps. It provides a convenient interface for creating, handling, and routing callback URLs. This documentation will guide you on how to integrate CallbackURLKit into your projects and leverage its powerful features.

Installation

To install CallbackURLKit in your project, follow these steps:

  1. Open your project in Xcode.
  2. Click on “File” in the menu bar, then select “Swift Packages” and choose “Add Package Dependency…”
  3. In the search bar, enter “CallbackURLKit” and select the package from the search results.
  4. Choose the version you want to install and click “Next”.
  5. Review the details and click “Add” to add CallbackURLKit to your project.

Getting Started

After installing CallbackURLKit, you can start using it in your application. Follow these steps to get started:

Step 1: Importing

To start using CallbackURLKit, import the module in your Swift file:

import CallbackURLKit

Step 2: Creating a Router

To handle callback URLs in your app, you need to create a router. The router is responsible for mapping callback URLs to appropriate actions. Here’s an example of how to create a basic router:

// Create a router instance
let router = Router()

// Define handlers for different callback URLs
router["myapp://action1"] = { parameters in
// Handle action1
}

router["myapp://action2"] = { parameters in
// Handle action2
}

// Add additional handlers...

// Handle a callback URL
router.handle(url: callbackURL)

Step 3: Handling Callback URLs

Once you have a router, you can handle callback URLs and perform actions accordingly. Here’s an example of how to handle a callback URL:

// Create a callback URL
let callbackURL = URL(string: "myapp://action1")!

// Handle the callback URL
router.handle(url: callbackURL)

Additional Features

Customizing Handlers

You can customize the behavior of your handlers by specifying additional parameters or using different methods:

  • onMatch: Execute a specific closure when a matching callback URL is found.
  • onFail: Define a fallback action when a callback URL does not match any handlers.
  • withQueryParameters: Access query parameters of the callback URL.

URL Templating

CallbackURLKit supports URL templating, which allows you to define dynamic parts in your callback URLs. Here’s an example:

// Create a dynamic callback URL
let callbackURLTemplate = "myapp://product/{productId}"

// Create a handler for the dynamic URL
router[callbackURLTemplate] = { parameters in
if let productId = parameters["productId"] {
// Handle the dynamic URL with the productId parameter
}
}

Conclusion

Congratulations! You now have a basic understanding of how to use CallbackURLKit in your iOS app. You can explore more advanced features and customization options by referring to the CallbackURLKit documentation and API reference.