InquiryConfiguration

public struct InquiryConfiguration

Defines the configuration for an Inquiry.

Template ID based initializers

  • Creates a configuration object used for creating an Inquiry using a template ID.

    Declaration

    Swift

    public init(templateId: String,
                environment: Environment? = .production,
                fields: [String: InquiryField]? = nil,
                theme: InquiryTheme? = nil)

    Parameters

    templateId

    An existing template that determines how the flow is customized.

    environment

    The Persona API environment on which to create inquiries.

    fields

    Any existing user data you want to attach to the inquiry.

    theme

    An optional theme to apply.

  • Creates a configuration object used for creating an Inquiry using a template ID and reference ID.

    Declaration

    Swift

    public init(templateId: String,
                referenceId: String,
                environment: Environment? = .production,
                fields: [String: InquiryField]? = nil,
                theme: InquiryTheme? = nil)

    Parameters

    templateId

    An existing template that determines how the flow is customized.

    referenceId

    The identifier can be used to monitor user progress in newly created inquiries.

    environment

    The Persona API environment on which to create inquiries.

    fields

    Any existing user data you want to attach to the inquiry.

    theme

    An optional theme to apply.

  • Creates a configuration object used for creating an Inquiry using a template ID and account ID.

    Declaration

    Swift

    public init(templateId: String,
                accountId: String,
                environment: Environment? = .production,
                fields: [String: InquiryField]? = nil,
                theme: InquiryTheme? = nil)

    Parameters

    environment

    The Persona API environment on which to create inquiries.

    templateId

    An existing template that determines how the flow is customized.

    accountId

    The account to associate this inquiry with. The account can be used to monitor user progress in newly created inquiries.

    environment

    The Persona API environment on which to create inquiries.

    fields

    Any existing user data you want to attach to the inquiry.

    theme

    An optional theme to apply.

Template Version based initializers

  • Creates a configuration object used for creating an Inquiry using a template ID.

    Declaration

    Swift

    public init(templateVersion: String,
                environment: Environment? = .production,
                fields: [String: InquiryField]? = nil,
                theme: InquiryTheme? = nil)

    Parameters

    templateVersion

    An existing template version that determines how the flow is customized.

    environment

    The Persona API environment on which to create inquiries.

    fields

    Any existing user data you want to attach to the inquiry.

    theme

    An optional theme to apply.

  • Creates a configuration object used for creating an Inquiry using a template ID and reference ID.

    Declaration

    Swift

    public init(templateVersion: String,
                referenceId: String,
                environment: Environment? = .production,
                fields: [String: InquiryField]? = nil,
                theme: InquiryTheme? = nil)

    Parameters

    templateVersion

    An existing template version that determines how the flow is customized.

    referenceId

    The identifier can be used to monitor user progress in newly created inquiries.

    environment

    The Persona API environment on which to create inquiries.

    fields

    Any existing user data you want to attach to the inquiry.

    theme

    An optional theme to apply.

  • Creates a configuration object used for creating an Inquiry using a template ID and account ID.

    Declaration

    Swift

    public init(templateVersion: String,
                accountId: String,
                environment: Environment? = .production,
                fields: [String: InquiryField]? = nil,
                theme: InquiryTheme? = nil)

    Parameters

    environment

    The Persona API environment on which to create inquiries.

    templateVersion

    An existing template version that determines how the flow is customized.

    accountId

    The account to associate this inquiry with. The account can be used to monitor user progress in newly created inquiries.

    environment

    The Persona API environment on which to create inquiries.

    fields

    Any existing user data you want to attach to the inquiry.

    theme

    An optional theme to apply.

Inquiry ID based initializers

  • Creates a configuration object used for creating an Inquiry using an inquiry ID.

    Declaration

    Swift

    public init(inquiryId: String, sessionToken: String? = nil, theme: InquiryTheme? = nil)

    Parameters

    inquiryId

    An existing inquiry.

    sessionToken

    Session token for resuming an Inquiry. The token must be generated on the server.

    theme

    An optional theme to apply.