InquiryConfiguration

public struct InquiryConfiguration : InquiryConfig

Undocumented

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,
        nfcAdapter: InquiryNfcAdapter? = nil,
        collectionDelegate: InquiryCollectionDelegate? = 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.

    nfcAdapter

    An adapter that is used internally when using Nfc. Add the PersonaNfc framework to your project and pass in PersonaNfc() if enabling the Nfc capability.

    collectionDelegate

    An optional delegate to receive collected inquiry data in a client side callback.

  • 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,
        nfcAdapter: InquiryNfcAdapter? = nil,
        collectionDelegate: InquiryCollectionDelegate? = 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.

    nfcAdapter

    An adapter that is used internally when using Nfc. Add the PersonaNfc framework to your project and pass in PersonaNfc() if enabling the Nfc capability.

    collectionDelegate

    An optional delegate to receive collected inquiry data in a client side callback.

  • 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,
        nfcAdapter: InquiryNfcAdapter? = nil,
        collectionDelegate: InquiryCollectionDelegate? = nil
    )

    Parameters

    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.

    nfcAdapter

    An adapter that is used internally when using Nfc. Add the PersonaNfc framework to your project and pass in PersonaNfc() if enabling the Nfc capability.

    collectionDelegate

    An optional delegate to receive collected inquiry data in a client side callback.

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,
        nfcAdapter: InquiryNfcAdapter? = nil,
        collectionDelegate: InquiryCollectionDelegate? = 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.

    nfcAdapter

    An adapter that is used internally when using Nfc. Add the PersonaNfc framework to your project and pass in PersonaNfc() if enabling the Nfc capability.

    collectionDelegate

    An optional delegate to receive collected inquiry data in a client side callback.

  • 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,
        nfcAdapter: InquiryNfcAdapter? = nil,
        collectionDelegate: InquiryCollectionDelegate? = 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.

    nfcAdapter

    An adapter that is used internally when using Nfc. Add the PersonaNfc framework to your project and pass in PersonaNfc() if enabling the Nfc capability.

    collectionDelegate

    An optional delegate to receive collected inquiry data in a client side callback.

  • 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,
        nfcAdapter: InquiryNfcAdapter? = nil,
        collectionDelegate: InquiryCollectionDelegate? = 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.

    nfcAdapter

    An adapter that is used internally when using Nfc. Add the PersonaNfc framework to your project and pass in PersonaNfc() if enabling the Nfc capability.

    collectionDelegate

    An optional delegate to receive collected inquiry data in a client side callback.

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,
        nfcAdapter: InquiryNfcAdapter? = nil,
        collectionDelegate: InquiryCollectionDelegate? = 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.

    nfcAdapter

    An adapter that is used internally when using Nfc. Add the PersonaNfc framework to your project and pass in PersonaNfc() if enabling the Nfc capability.

    collectionDelegate

    An optional delegate to receive collected inquiry data in a client side callback.

Builder

  • Builds a configuration object. Validation is performed on the parameters supplied and fed to other public initializers. Prioritizes inquiryId over templateVersion over templateId (mutually exclusive) Also prioritizes referenceId over accountId (mutually exclusive) returns nil when inquiryId, templateVersion, and templateId are all nil

    Declaration

    Swift

    public static func build(
        inquiryId: String? = nil,
        sessionToken: String? = nil,
        templateVersion: String? = nil,
        templateId: String? = nil,
        referenceId: String? = nil,
        accountId: String? = nil,
        environment: Environment? = nil,
        fields: [String: InquiryField]? = nil,
        theme: InquiryTheme? = nil,
        nfcAdapter: InquiryNfcAdapter? = nil,
        collectionDelegate: InquiryCollectionDelegate? = nil
    ) -> InquiryConfiguration?

    Parameters

    inquiryId

    An existing inquiry.

    sessionToken

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

    templateVersion

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

    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.

    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.

    nfcAdapter

    An adapter that is used internally when using Nfc. Add the PersonaNfc framework to your project and pass in PersonaNfc() if enabling the Nfc capability.

    collectionDelegate

    An optional delegate to receive collected inquiry data in a client side callback.