The Full Name module collects the user's name and sends it to the server.
You add this module in code by adding it to your IncdOnboardingFlowConfiguration (flowConfig), as shown on this page. See Integration Approaches for how to define and run the flow.
Availability: All variants.
Add Full Name
Add the module with addFullName().
flowConfig.addFullName()
Configuration Options
Full Name has no configurable options.
Validation
The Continue button is enabled by default and stays enabled until an error is shown.
- Typing never introduces an error message. It only clears one that the new value has resolved.
- Leaving a field reports a malformed value, but stays quiet about an empty required field until the user has tried to submit at least once.
- Tapping Continue validates everything, empty required fields included. From then on, leaving a field also reports an empty one.
Result
Full Name delivers a UserNameInfoResult to the onAddFullNameCompleted(_:) callback on your IncdOnboardingDelegate:
func onAddFullNameCompleted(_ result: UserNameInfoResult)
UserNameInfoResult fields:
name: String?: The name captured from the user;nilwhen unavailable.error: IncdError?: The error that occurred while capturing the name, if any; otherwise,nil.
Headless
Requires an active session.
IncdOnboardingManager.shared.startUserNameInfo { result in
// UserNameInfoResult
}