Brand Concierge Implementation Guide (iOS)
The Brand Concierge UI is presented in two steps:
- Enable UI presentation by wrapping your SwiftUI root with
Concierge.wrap(...) - Open the chat by calling
Concierge.show(...)
Internally, Concierge.show(...) dispatches an event in the Adobe Experience Platform Mobile SDK that the Concierge extension handles to build a ConciergeConfiguration, then the SwiftUI overlay presents ChatView.
Prerequisites
Required SDK modules
Your app needs the following Experience Platform SDKs to be available and registered:
- AEPCore (MobileCore; Configuration shared state from
configureWith(appId:)) - AEPEdge
- AEPEdgeIdentity
- AEPBrandConcierge
iOS version
- Minimum iOS 15.0+
Permissions for speech to text (optional)
Speech to text uses iOS Speech and microphone APIs. Add these to your app Info.plist:
NSMicrophoneUsageDescriptionNSSpeechRecognitionUsageDescription
Configuration
Step 1: Set up the Adobe Experience Platform Mobile SDK
Follow the Adobe Experience Platform Mobile SDK getting started guide to set up the base SDK integration used by Concierge.
The required extensions are:
- AEPCore
- AEPEdge
- AEPEdgeIdentity
- AEPBrandConcierge
Step 2: Validate the Brand Concierge configuration keys
If you set the Adobe Experience Platform SDK log level to trace:
Copied to your clipboardMobileCore.setLogLevel(.trace)
you can then inspect the app logs to confirm that extension shared states are being set with the expected values.
Brand Concierge expects the following keys in the Configuration shared state:
concierge.server: String (server host or base domain for Concierge requests)concierge.configId: String (datastream ID)
The ECID is read from the Edge Identity shared state.
Another option for validation is to use Adobe Assurance. Refer to the Mobile SDK validation guide for more information.
Optional styling
Theme injection (recommended)
The Brand Concierge chat interface can be customized by loading a theme JSON and applying it above Concierge.wrap(...) so both the floating button and the overlay use it. The UI reads styling from the SwiftUI environment value conciergeTheme:
Copied to your clipboardlet theme = ConciergeThemeLoader.load(from: "theme-default", in: .main) ?? ConciergeThemeLoader.default()var body: some View {Concierge.wrap(AppRootView(), surfaces: ["my-surface"], hideButton: true).conciergeTheme(theme)}
More information regarding theme customization can be found in the Style guide (iOS).
Basic usage
Option A — Manual API call (no floating button)
Use this when you want full control over where the entry point lives.
- Wrap your root content and hide the built-in button:
Copied to your clipboardConcierge.wrap(AppRootView(), surfaces: ["my-surface"], hideButton: true)
- Trigger chat from your own UI:
Copied to your clipboardButton("Chat") {Concierge.show(surfaces: ["my-surface"], title: "Concierge", subtitle: "Powered by Adobe")}
Optional: provide speech capture (default is created internally if not passed) and text to speech by passing a TextSpeaking implementation (text to speech is off by default unless you supply one).
Option B — Floating button (built-in)
Use this for a drop-in entry point:
Copied to your clipboardConcierge.wrap(AppRootView(), surfaces: ["my-surface"]) // hideButton defaults to false
This shows a floating button in the bottom trailing corner; tapping it calls Concierge.show(surfaces:).
Closing the UI
Dismiss the overlay from code with:
Copied to your clipboardConcierge.hide()
UIKit usage
Use this when your app is UIKit-based and you want to present Concierge from a UIViewController.
Present the chat UI
Call Concierge.present(on:surfaces:title:subtitle:) from the view controller that should host the chat:
Copied to your clipboardimport AEPBrandConciergefinal class MyViewController: UIViewController {@objc private func openChat() {Concierge.present(on: self, surfaces: ["my-surface"], title: "Concierge", subtitle: "Powered by Adobe")}}
Dismiss the chat UI
To dismiss the presented UI:
Copied to your clipboardConcierge.hide()
Next steps
- Style guide (iOS) — Theme JSON reference and implementation status for iOS.
