SDK reference · iOS SDK / iOS Individual Modules

Full Name

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.

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; nil when unavailable.
  • error: IncdError?: The error that occurred while capturing the name, if any; otherwise, nil.

Headless

IncdOnboardingManager.shared.startUserNameInfo { result in
    // UserNameInfoResult
}

Requires an active session.

Was this page helpful?