Brand Concierge API reference (iOS)

wrap

Wraps a SwiftUI view with the Brand Concierge overlay and optional floating button. Call this once at the app's root to enable the chat overlay across the entire view hierarchy.

data-variant=info

data-slots=text

Syntax

static func wrap<Content: View>(
    _ content: Content,
    surfaces: [String] = [],
    title: String? = nil,
    subtitle: String? = nil,
    hideButton: Bool = false,
    handleLink: ((URL) -> Bool)? = nil
) -> some View

Parameters

• content required - The SwiftUI content to wrap.
• surfaces - Surface identifiers sent to the Brand Concierge server. Defaults to [].
• title - Header title text shown at the top of the chat.
• subtitle - Header subtitle text shown at the top of the chat.
• hideButton - When true, hides the built-in floating button. Defaults to false.
• handleLink - Optional callback for link routing. Return true to claim the URL; return false to let the SDK handle it.

Example

@main
struct MyApp: App {
    var body: some Scene {
        WindowGroup {
            Concierge.wrap(
                ContentView(),
                surfaces: ["web://example.com/your-surface.html"]
            )
        }
    }
}

show

Opens the chat overlay for a new chat session. Requires the view hierarchy to have been wrapped with Concierge.wrap(...) first.

Syntax

static func show(
    surfaces: [String],
    title: String? = nil,
    subtitle: String? = nil,
    speechCapturer: SpeechCapturing? = nil,
    textSpeaker: TextSpeaking? = nil,
    handleLink: ((URL) -> Bool)? = nil
)

Parameters

• surfaces required - Surface identifiers sent to the Brand Concierge server.
• title - Header title text shown at the top of the chat for this session.
• subtitle - Header subtitle text shown at the top of the chat for this session.
• speechCapturer - Custom SpeechCapturing implementation. If nil, a default is created internally.
• textSpeaker - Custom TextSpeaking implementation. If nil, text-to-speech is disabled.
• handleLink - Optional callback for link routing. Return true to claim the URL; return false to let the SDK handle it.

Example

Button("Chat") {
    Concierge.show(
        surfaces: ["web://example.com/your-surface.html"],
        title: "Concierge",
        subtitle: "Powered by Adobe"
    )
}

hide

Dismisses the currently presented chat overlay.

Syntax

static func hide()

Example

Concierge.hide()

present

Embeds the chat UI as a child view controller into an existing UIViewController. Use this for UIKit-based apps.

Syntax

static func present(
    on presentingViewController: UIViewController,
    surfaces: [String],
    title: String? = nil,
    subtitle: String? = nil,
    speechCapturer: SpeechCapturing? = nil,
    textSpeaker: TextSpeaking? = nil,
    handleLink: ((URL) -> Bool)? = nil
)

Parameters

• on presentingViewController required - The UIViewController that will host the chat UI, filling its view.
• surfaces required - Surface identifiers sent to the Brand Concierge server.
• title - Header title text shown at the top of the chat for this session.
• subtitle - Header subtitle text shown at the top of the chat for this session.
• speechCapturer - Custom SpeechCapturing implementation. If nil, a default is created internally.
• textSpeaker - Custom TextSpeaking implementation. If nil, text-to-speech is disabled.
• handleLink - Optional callback for link routing. Return true to claim the URL; return false to let the SDK handle it.

Example

import AEPBrandConcierge

final class MyViewController: UIViewController {
    @objc private func openChat() {
        Concierge.present(
            on: self,
            surfaces: ["web://example.com/your-surface.html"],
            title: "Concierge",
            subtitle: "Powered by Adobe"
        )
    }
}

setAuthTokenProvider

Registers the provider the SDK consults for an auth token before every chat and feedback turn. Lets a host app attach its own opaque, app-minted authentication token to Brand Concierge conversation turns.

data-variant=info

data-slots=text

Syntax

static func setAuthTokenProvider(
    timeout: TimeInterval = 3,
    _ provider: (@Sendable () async -> String?)?
)

Parameters

• timeout - How long to await the provider before sending the turn without a token. Defaults to 3 seconds; raise it if minting the token may take longer.
• provider required - An async closure returning the current token, or nil to clear a previously registered provider. The closure is consulted fresh on every turn (never cached) and works for both synchronous ({ tokenCache.current }) and asynchronous ({ await tokenCache.freshToken() }) callers. Returning nil/blank, or not returning within timeout, sends the turn without a token instead of failing it.

Example

Concierge.setAuthTokenProvider { [weak tokenCache] in
    await tokenCache?.freshToken()
}

sendDataHandoff

Hands data that didn't originate from something the user typed or said in chat (for example, the result of a native checkout flow) to the agent pipeline (Brand Concierge / Product Advisor). Requires an active Concierge chat session. See Data handoff in the implementation guide for details.

Syntax

static func sendDataHandoff(
    routingHint: String = "",
    xdmFields: [String: Any],
    localMessage: String? = nil,
    completion: (@MainActor (Result<Void, ConciergeDataHandoffError>) -> Void)? = nil
)

Parameters

• routingHint - A keyword consumed only by Brand Concierge's phrase-based router (for example, "successful-checkout"). Never shown to the end user. Defaults to empty, which is appropriate when xdmFields carries the routing context on its own.
• xdmFields required - Non-empty, JSON-serializable, XDM-shaped dictionary merged into the root of the forwarded XDM object. identityMap is reserved and cannot be used as a top-level key.
• localMessage - Optional text rendered immediately in the chat transcript as a local, non-networked message. It is not sent to Brand Concierge. If nil or empty, nothing is shown locally.
• completion - Optional closure called exactly once on the main actor, always within 60 seconds. .success means Brand Concierge completed the turn and its response was rendered. .failure carries a ConciergeDataHandoffError; a failed handoff leaves nothing in the transcript, so the app owns any failure UI.

Example

Concierge.sendDataHandoff(
    routingHint: "successful-checkout",
    xdmFields: ["commerce": ["order": ["purchaseID": orderId]]],
    localMessage: "Your order is confirmed!"
) { result in
    if case .failure(let error) = result {
        analytics.track("concierge_handoff_failed", ["code": error.code])
    }
}

ConciergeDataHandoffError

The typed error passed to the sendDataHandoff completion on failure. Each case exposes a stable code string intended for analytics and crash reporting.

See the error table in the implementation guide for the meaning of each case.

ConciergeThemeLoader.load

Loads a ConciergeTheme from a JSON file in a bundle. Returns nil if the file cannot be found or parsed.

Syntax

public static func load(from filename: String, in bundle: Bundle = .main) -> ConciergeTheme?

Parameters

• filename required - The name of the JSON theme file (without the .json extension).
• bundle - The bundle to search for the file. Defaults to .main.

Example

let theme = ConciergeThemeLoader.load(from: "my-theme", in: .main)
    ?? ConciergeThemeLoader.default()

ConciergeThemeLoader.default

Returns the built-in default ConciergeTheme.

Syntax

public static func `default`() -> ConciergeTheme

Example

let theme = ConciergeThemeLoader.default()