Close Menu

CallbackURLKit

Introduction

CallbackURLKit is a Swift-based, type-safe utility that simplifies the process of setting up and triggering complex inter-app communication in iOS. It provides a clean interface for third-party app interaction using x-callback-url, promoting app extensibility and deep linking.

Functionalities

An overview of its capabilities includes:

  • Encoding and sending x-callback URLs
  • Receiving, parsing, and handling callback URLs
  • Handling errors
  • Managing action paths and callback parameters

Setting Up CallbackURLKit

The setup process involves adding the utility to your project, creating a URL scheme for your app, and setting up listeners for incoming URLs. 

For adding CallbackURLKit to your project with CocoaPods:
pod 'CallbackURLKit'

For adding it with Swift Package Manager:
.package(url: "https://github.com/phimage/CallbackURLKit.git", .upToNextMajor(from: "1.0.0"))

Usage

Using CallbackURLKit involves creating URL schemes and handlers, managing parameters, and working with CallbackURLKit’s Manager, Sender, and Parser classes.

You’ll need to register your scheme within your app’s Info.plist and then can start to handle actions and parameters:


let manager = Manager.shared
try? manager.add(action: "task", forScheme: "myapp") { parameters, success, failure, cancel in
// implementation
}

Links

For more information, tutorials, and examples, visit the official GitHub page:

Github – CallbackURLKit