SDK

iOS setup

The iOS SDK prepares context and supports local Search. Your backend uses Profile and Query through the context service.

Install#

Request SDK access to get the package URL and installation instructions for your integration. Add the package in Xcode using the URL and version provided by the Rollup team.

Configure#

AppDelegate.swift
import Rollup

// Configure Rollup when your app starts.
Rollup.configure(
    publishableKey: "ru_pk_live_...",
    userID: currentUser.id
)
OnboardingViewController.swift
let result = try await Rollup.requestPhotoAccess(
    presentingFrom: viewController
)

if result == .granted {
    // Rollup begins preparing user context.
}

React to readiness#

swift
for await state in Rollup.indexStateUpdates {
    if state == .ready || state == .complete {
        enableContextAwareFeatures()
    }
}
swift
let results = try await Rollup.search(
    "weekend hikes"
)

Search stays on the device and returns local references. Profile and Query examples use a server-side client bound to the same application user ID. Keep secret service credentials on your backend.

That’s enough to get started.#

Rollup handles indexing progressively and adjusts work based on device conditions.

Your app should not keep the screen open or display a blocking progress bar while the full library is processed.

Android
Android support is planned. Profile and Query use a platform-independent context service; local Search requires SDK support on the device.