iOS SDK - FlowX.AI

iOS SDK migration guide

FlowX.AI 6.0 aligns the names of five iOS SDK APIs with the Android and web SDKs. The build requirements and library dependencies are unchanged, and the 5.9 names still compile, so your app builds with the 6.0 SDK after you update the pod version. Replace the deprecated names afterwards.

System requirements

Requirement	5.9.x	6.0
Minimum iOS	iOS 15	iOS 15
Swift	5.9	5.9

Library dependencies

Dependency	5.9.x	6.0
Alamofire	`~> 5.9.0`	`~> 5.9.0`
SDWebImageSwiftUI	3.0.3	3.0.3
SDWebImageSVGCoder	`~> 1.7.0`	`~> 1.7.0`

Migration steps

Update the SDK version

Podfile

pod 'FlowXRenderer', '<5.9.x version>'
pod 'FlowXRenderer', '<6.0 version>'

Find the SDK version that matches your platform version in Release Notes → v6.0 → Deployment guidelines → Component versions.

Replace the deprecated APIs

Replace the 5.9 names with the 6.0 names listed in the Replace deprecated APIs section. The parameters, types and behavior are unchanged.

Replace deprecated APIs

The following 5.9 names still compile in 6.0, but they are deprecated and will be removed in the next LTS release. Replace them now:

Deprecated (5.9)	Replacement (6.0)	Available on
`imageBaseURL`	`assetsBaseURL`	`FXConfig`
`updateAuthorization(token:)`	`setAccessToken(token:)`	`FlowX.sharedInstance`
`getTag(withKey:)`	`getSubstitutionTagContent(key:)`	`FlowX.sharedInstance`
`getEnumeration(name:parentName:)`	`getEnumerationItems(name:parentName:)`	`FlowX.sharedInstance` (async and completion versions)
`continueExistingProcess(uuid:name:…)`	`continueProcess(uuid:name:…)`	`FlowX.sharedInstance` (all three versions)

Xcode shows a deprecation warning on every deprecated call, with a Fix-it that replaces it with the new name.

These changes are reflected in an actual implementation as shown below:

// configuration
FXConfig.sharedInstance.configure { config in
    config.imageBaseURL = myImageBaseURL 
    config.assetsBaseURL = myAssetsBaseURL 
}

// authorization token changes
FlowX.sharedInstance.updateAuthorization(token: accessToken) 
FlowX.sharedInstance.setAccessToken(token: accessToken) 

// substitution tags
FlowX.sharedInstance.getTag(withKey: "@@close_message") 
FlowX.sharedInstance.getSubstitutionTagContent(key: "@@close_message") 

// enumerations
let items = await FlowX.sharedInstance.getEnumeration(name: "cities", parentName: "countries") 
let items = await FlowX.sharedInstance.getEnumerationItems(name: "cities", parentName: "countries") 

// resuming a process
FlowX.sharedInstance.continueExistingProcess(uuid: uuid, 
FlowX.sharedInstance.continueProcess(uuid: uuid, 
                                     name: processName,
                                     navigationController: processNavigationController,
                                     isModal: true)

iOS SDK reference

iOS renderer SDK documentation

Migration overview

Full 5.9.x → 6.0.0 container app upgrade guide

​iOS SDK migration guide

​System requirements

​Library dependencies

​Migration steps

​Replace deprecated APIs

​Related resources

iOS SDK reference

Migration overview

iOS SDK migration guide

System requirements

Library dependencies

Migration steps

Replace deprecated APIs

Related resources