The Rokt iOS SDK enables you to integrate Rokt into your native iOS mobile apps to drive more value from, and for, your customers. The SDK is built to be lightweight, secure, and simple to integrate and maintain, resulting in minimal lift for your engineering team.
For more information please visit official docs
Copyright 2020 Rokt Pte Ltd
Licensed under the Rokt Software Development Kit (SDK) Terms of Use Version 2.0 (the "License")
You may not use this file except in compliance with the License.
You may obtain a copy of the License at https://rokt.com/sdk-license-2-0/
Download the latest version of Xcode. Xcode 11 and above comes with a built-in Swift Package Manager.
For more information on Swift Package Manager, open Swift official documentation
Package.swift
is the main package manifest that defines updated configurations to the Rokt iOS SDK package as required by the Swift Package Manager.
To install for iOS development:
On Xcode:
- Go to File > Add Packages
- Enter Package URL
https://github.com/ROKT/rokt-sdk-ios.git
- Select Up to Next Major with 3.17.0
Alternatively add below code to the dependencies
part of Package.swift
.
dependencies: [
.package(url: "https://github.com/ROKT/rokt-sdk-ios.git", .upToNextMajor(from: "3.17.0"))
]
The following steps test an overlay placement - only 2 explicit calls, init
and execute
, are needed.
import Rokt_Widget
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
Rokt.initWith(roktTagId: "your_tag_id_here")
return true
}
Contact Rokt for the Rokt Account ID associated with your account and enter your unique Rokt Account ID as the roktTagId
.
To test your integration with an overlay placement, firstly define in ViewController
e.g.
func showWidget() {
let attributes = ["email": "[[email protected]]",
"firstname": "Jenny",
"lastname": "Smith",
"mobile": "(555)867-5309",
"postcode": "90210",
"country": "US",
"sandbox": "true"]
Rokt.execute(viewName: "[your_view_name_here]", attributes: attributes, onLoad: {
// Optional callback for when the Rokt placement loads
}, onUnLoad: {
// Optional callback for when the Rokt placement unloads
}, onShouldShowLoadingIndicator: {
// Optional callback to show a loading indicator
}, onShouldHideLoadingIndicator: {
// Optional callback to hide a loading indicator
}, onEmbeddedSizeChange: { selectedPlacement, widgetHeight in
// Optional callback to get selectedPlacement and height required by the placement every time the height of the placement changes
})
}
Replace viewName
in the above snippet with your configured view name.
Important: Before launching in production, remove "sandbox": "true"
. The sandbox environment is intended for acceptance testing, meaning that while it follows the production configuration, it does not charge advertisers or generate revenue.
Finally, call this function in any subsequent view where the placement needs to be shown. Placement will not appear when called in the first view of the application as initialization requires time.
To test your integration with embedded placement, view steps here