Swiftpack.co - appcues/appcues-ios-sdk as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by appcues.
appcues/appcues-ios-sdk 1.0.0
The Appcues iOS SDK
⭐️ 5
πŸ•“ 4 days ago
iOS
.package(url: "https://github.com/appcues/appcues-ios-sdk.git", from: "1.0.0")

AppcuesKit

Appcues iOS SDK

CircleCI Cocoapods License: MIT

Appcues iOS SDK allows you to integrate Appcues experiences into your native iOS and iPadOS apps.

The SDK is a Swift library for sending user properties and events to the Appcues API and retrieving and rendering Appcues content based on those properties and events.

πŸš€ Getting Started

Installation

Add the Appcues iOS SDK package to your app. There are several supported installation options.

Segment

Appcues supports integration with Segment's analytics-swift library. To install with Segment, you'll use the Segment Appcues plugin.

Swift Package Manager

Add the Swift package as a dependency to your project in Xcode:

  1. In Xcode, open your project and navigate to File β†’ Add Packages…
  2. Enter the package URL https://github.com/appcues/appcues-ios-sdk
  3. For Dependency Rule, select Up to Next Major Version
  4. Click Add Package

Alternatively, if your project has a Package.swift file, you can add Appcues iOS SDK to your dependencies:

dependencies: [
    .package(url: "https://github.com/appcues/appcues-ios-sdk", .branch("main"))
]

Cocoapods

  1. Add the pod to your Podfile
    pod 'Appcues'
    
  2. In Terminal, run
    pod install
    

XCFramework

An XCFramework is attached with each release.

  1. Download AppcuesKit.xcframework.zip attached to the latest release and unzip.
  2. In Xcode, open your project and navigate to File β†’ Add Files to "<Project>"…
  3. Find the XCFramework in the file navigator and select it
  4. Ensure the option to "Copy items if needed" is checked and that your app's target is selected
  5. Click Add
  6. Select your project in the Project navigator, select your app target and then the General tab. Under Frameworks, Libraries, and Embedded Content, set AppcuesKit.xcframework to Embed & Sign

One Time Setup

After installing the package, you can reference Appcues iOS SDK by importing the package with import AppcuesKit.

Initializing the SDK

An instance of the Appcues iOS SDK should be initialized when your app launches. A lifecycle method such as application(_:didFinishLaunchingWithOptions:) would be a common location:

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  let appcuesConfig = Appcues.Config(
    accountID: <#APPCUES_ACCOUNT_ID#>,
    applicationID: <#APPCUES_APPLICATION_ID#>)
    
  appcues = Appcues(config: appcuesConfig)
}

Initializing the SDK requires you to provide two values, an Appcues account ID, and an Appcues mobile application ID. These values can be obtained from your Appcues settings.

Supporting Debugging and Experience Previewing

Supporting debugging and experience previewing is not required for the Appcues iOS SDK to function, but it is necessary for the optimal Appcues builder experience. Refer to the Debug Guide for details.

Identifying Users

In order to target content to the right users at the right time, you need to identify users and send Appcues data about them. A user is identified with a unique ID.

  • identify(userID:)

Tracking Screens and Events

Events are the β€œactions” your users take in your application, which can be anything from clicking a certain button to viewing a specific screen. Once you’ve installed and initialized the Appcues iOS SDK, you can start tracking screens and events using the following methods:

  • track(name:)
  • screen(title:)

Refer to the full Getting Started Guide for more details.

πŸ›  Customization

Refer to the Extending Guide for details.

πŸ“ Documentation

SDK Documentation is available at https://appcues.github.io/appcues-ios-sdk/documentation/appcueskit and full Appcues documentation is available at https://docs.appcues.com/

🎬 Examples

The Examples directory in repository contains full example iOS apps demonstrating different methods of installation and providing references for usage of the Appcues API.

πŸ‘· Contributing

See the contributing guide to learn how to get set up for development and how to contribute to the project.

πŸ“„ License

This project is licensed under the MIT License. See LICENSE for more information.

GitHub

link
Stars: 5
Last commit: 3 days ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

1.0.0
4 days ago
  • [2022-08-10] πŸ‘Œ Update debugger deep link messaging (0572cac)
  • [2022-08-09] 🚨 Fix missed deep link spelling (a5c5609)
  • [2022-08-09] 🚨 Fix deep link spelling (cbe0541)
  • [2022-08-03] 🚚 Remove request review action (ea61480)
  • [2022-08-05] ✨ Add @appcues/background-content trait (cbae252)
  • [2022-08-05] ✨ Add TraitLevel to ExperienceTrait.init (bc35ace)
  • [2022-08-02] ✨ Add deeplink verification to debugger (1513cf7)
  • [2022-08-02] 🚨 Fix lint warning (66050f6)

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics