Use the iOS SDK settings and actions to customize the behavior of your bot.
With the iOS SDK, you can customize the behavior of your chatbot with AdaWebHost input parameters.
appScheme: String = ""
Use this setting to pass the scheme name of the host app. This allows for more robust handling of universal links.
cluster: String = ""
Specifies the Kubernetes cluster your AI Agent runs on.
Set this only if your Agent is hosted on a non-default cluster (e.g., us2, maple, eu, att).
If the Agent is on the default us cluster, leave this unset.
greeting: String = ""
Use this setting to customize the greeting messages that new chatters see. This is useful for setting view-specific greetings across your app. The greeting should correspond to the ID of the Answer you would like to use, which you can find in the URL of the corresponding Answer in the dashboard.
Example
This setting is only applicable if you’re using a scripted bot.
handle: String
The handle for your bot. This is a required field.
language: String = ""
Takes in a language code to programmatically set the bot language. You must first turn languages on in your Ada dashboard.
Language codes use the ISO 639-1 language format.
metafields: [String: String]? = [:]
Use metaFields to pass information about a user to Ada. This can be useful for tracking information about your customers, as well as personalizing their experience. For example, you may wish to track the phone_number and name for conversation attribution. (See Variables for more information.)
To change these values after bot setup, use the setMetaFields action.
sensitiveMetafields: [String: String]? = [:]
Use this parameter to pass sensitive meta information about a chatter. This works like metafields but provides an added layer of security. To change these values after bot setup, use the setSensitiveMetafields action.
openWebLinksInSafari: Bool = false
External web links open by default in-app, via the SFSafariViewController. To open external links in the Safari browser, pass openWebLinksInSafari: true to AdaWebHost.
zdChatterAuthCallback: ((((_ token: String) -> Void)) -> Void)? = nil
Use the zdChatterAuthCallback to request a JWT token from your API, then pass it to Ada. This creates shared trust between Ada and Zendesk, and in turn allows for verifiable chatter identity.
zdChatterAuthCallback is available only for Zendesk Chat. It is not available for Zendesk Messaging.
The iOS SDK stores session state — including the chatter token and any active Zendesk Messaging handoff context — in the WebView’s localStorage.
On iOS, WebView localStorage persistence across app restarts is not guaranteed. Session state may or may not survive depending on OS memory management, and should not be relied upon for maintaining live agent handoff state.
If your app requires guaranteed session continuity across app restarts, you will need to implement your own native storage management. The current SDK does not persist session state using platform-native storage such as Keychain or UserDefaults.
To implement this yourself, see the Apple developer documentation on Keychain Services or UserDefaults.
Use the actions below in conjunction with settings to customize the behavior of your bot in an iOS app.
deleteHistory()
Deletes the record used to fetch conversation logs for a user from local storage. When a user opens a new chat window, a new user record will be created.
launchInjectingWebSupport(into view: UIView)
Launches Ada chat into a specified subview.
launchModalWebSupport(from viewController: UIViewController)
Launches Ada chat in a modal view over top of your current view.
launchNavWebSupport(from navController: UINavigationController)
Pushes a view containing Ada chat to the top of your navigational stack.
reset()
Use this action to create a new user and refresh the chat window.
setLanguage(language: string)
Changes the language in chat programmatically. Use this action, rather than the language setting, to change the chat language without clearing the chat history. Language codes must use a lowercase, two-letter code, in ISO 639-1 language format.
Before using setLanguage:
You must turn languages on in your Ada dashboard.
The chat window must be opened at least once.
setMetaFields(_ fields: [String: Any])
Used to set metadata for a user after instantiation. This is useful if you need to update user data after Ada Chat has already launched. See also metaFields.
setSensitiveMetaFields(_ fields: [String: Any])
Used to set sensitive metadata for a chatter after instantiation. This works like setMetaFields and is useful for storing more private and sensitive information. See also sensitiveMetaFields.
triggerAnswer()
Triggers an answer in chat. Include the Answer ID, which you can find in the URL of the corresponding Answer in the dashboard.
Example
The chat window must be opened at least once before this method can be used.
This action is only applicable if you’re using a scripted bot.