InquiryTheme

public struct InquiryTheme

Defines the color theme for an Inquiry.

General colors

  • The background color for all views.

    Declaration

    Swift

    public var backgroundColor: UIColor

  • The primary color.

    Declaration

    Swift

    public var primaryColor: UIColor

  • The darker, primary color.

    Declaration

    Swift

    public var darkPrimaryColor: UIColor

  • The accent color.

    Declaration

    Swift

    public var accentColor: UIColor

Errors

  • The error color.

    Declaration

    Swift

    public var errorColor: UIColor

  • The font for error labels.

    Declaration

    Swift

    public var errorTextFont: UIFont

Overlay

  • The background color for overlay views.

    Declaration

    Swift

    public var overlayBackgroundColor: UIColor

Footer

  • The background color for the footer container.

    Declaration

    Swift

    public var footerBackgroundColor: UIColor

  • The border color for the footer container.

    Declaration

    Swift

    public var footerBorderColor: UIColor

  • The border width for the footer container.

    Declaration

    Swift

    public var footerBorderWidth: CGFloat

Navigation Bar

  • The text color for title labels.

    Declaration

    Swift

    public var navigationBarTextColor: UIColor

  • The font for title labels.

    Declaration

    Swift

    public var navigationBarTextFont: UIFont

Title text

  • The text alignment for title labels.

    Declaration

    Swift

    public var titleTextAlignment: NSTextAlignment

  • The text color for title labels.

    Declaration

    Swift

    public var titleTextColor: UIColor

  • The font for title labels.

    Declaration

    Swift

    public var titleTextFont: UIFont

  • The font for card titles.

    Declaration

    Swift

    public var cardTitleTextFont: UIFont

Body text

  • The text alignment for body labels.

    Declaration

    Swift

    public var bodyTextAlignment: NSTextAlignment

  • The text color for body labels.

    Declaration

    Swift

    public var bodyTextColor: UIColor

  • The font for body labels.

    Declaration

    Swift

    public var bodyTextFont: UIFont

Footnote

  • The text color for footnote labels.

    Declaration

    Swift

    public var footnoteTextColor: UIColor

  • The font for footnote labels.

    Declaration

    Swift

    public var footnoteTextFont: UIFont

Form label

  • The text color for form labels.

    Declaration

    Swift

    public var formLabelTextColor: UIColor

  • The font for form labels.

    Declaration

    Swift

    public var formLabelTextFont: UIFont

Text field

  • The text color for text fields.

    Declaration

    Swift

    public var textFieldTextColor: UIColor

  • The text color for placeholder text in text fields.

    Declaration

    Swift

    public var textFieldPlaceholderColor: UIColor

  • The background color for text fields.

    Declaration

    Swift

    public var textFieldBackgroundColor: UIColor

  • The border color for text fields.

    Declaration

    Swift

    public var textFieldBorderColor: UIColor

  • The corner radius for text fields.

    Declaration

    Swift

    public var textFieldCornerRadius: CGFloat

  • The font for text fields.

    Declaration

    Swift

    public var textFieldFont: UIFont

  • The font for placeholder text in text fields.

    Declaration

    Swift

    public var textFieldPlaceholderFont: UIFont

Picker

  • The text color for picker items.

    Declaration

    Swift

    public var pickerTextColor: UIColor

  • The font for picker items.

    Declaration

    Swift

    public var pickerTextFont: UIFont

Primary Button Properties

  • The background color for buttons, in the normal state.

    Declaration

    Swift

    public var buttonBackgroundColor: UIColor

  • The background color for buttons, in the disabled state.

    Declaration

    Swift

    public var buttonDisabledBackgroundColor: UIColor

  • The background color for buttons, in the touched state.

    Declaration

    Swift

    public var buttonTouchedBackgroundColor: UIColor

  • The text color for button text, in the normal state.

    Declaration

    Swift

    public var buttonTextColor: UIColor

  • The text color for button text, in the disabled state.

    Declaration

    Swift

    public var buttonDisabledTextColor: UIColor

  • The text alignment for button text.

    Declaration

    Swift

    public var buttonTextAlignment: NSTextAlignment

  • The tint color for button images

    Declaration

    Swift

    public var buttonImageTintColor: UIColor

  • The corner radius to apply to buttons.

    Declaration

    Swift

    public var buttonCornerRadius: CGFloat

  • The border width to apply to buttons.

    Declaration

    Swift

    public var buttonBorderWidth: CGFloat

  • The border color to apply to buttons.

    Declaration

    Swift

    public var buttonBorderColor: UIColor

  • The font for button text.

    Declaration

    Swift

    public var buttonFont: UIFont

  • The shadow color for buttons (this should include the desired opacity), e.g. UIColor.black.withAlphaComponent(0.5)

    Declaration

    Swift

    public var buttonShadowColor: UIColor

  • The blur radius (in points) used to render the shadow.

    Declaration

    Swift

    public var buttonShadowRadius: CGFloat

  • The offset (in points) of the shadow.

    Declaration

    Swift

    public var buttonShadowOffset: CGSize

Secondary Button Properties

  • The background color for buttons, in the normal state.

    Declaration

    Swift

    public var buttonSecondaryBackgroundColor: UIColor

  • The background color for buttons, in the disabled state.

    Declaration

    Swift

    public var buttonSecondaryDisabledBackgroundColor: UIColor

  • The background color for buttons, in the touched state.

    Declaration

    Swift

    public var buttonSecondaryTouchedBackgroundColor: UIColor

  • The text color for button text, in the normal state.

    Declaration

    Swift

    public var buttonSecondaryTextColor: UIColor

  • The text color for button text, in the disabled state.

    Declaration

    Swift

    public var buttonSecondaryDisabledTextColor: UIColor

  • The text alignment for button text.

    Declaration

    Swift

    public var buttonSecondaryTextAlignment: NSTextAlignment

  • The tint color for button images

    Declaration

    Swift

    public var buttonSecondaryImageTintColor: UIColor

  • The corner radius to apply to buttons.

    Declaration

    Swift

    public var buttonSecondaryCornerRadius: CGFloat

  • The border width to apply to buttons.

    Declaration

    Swift

    public var buttonSecondaryBorderWidth: CGFloat

  • The border color to apply to buttons.

    Declaration

    Swift

    public var buttonSecondaryBorderColor: UIColor

  • The font for button text.

    Declaration

    Swift

    public var buttonSecondaryFont: UIFont

  • The shadow color for buttons (this should include the desired opacity), e.g. UIColor.black.withAlphaComponent(0.5)

    Declaration

    Swift

    public var buttonSecondaryShadowColor: UIColor

  • The blur radius (in points) used to render the shadow.

    Declaration

    Swift

    public var buttonSecondaryShadowRadius: CGFloat

  • The offset (in points) of the shadow.

    Declaration

    Swift

    public var buttonSecondaryShadowOffset: CGSize

Checkbox

  • The background color for checkboxes, in the normal state.

    Declaration

    Swift

    public var checkboxBackgroundColor: UIColor

  • The foreground color for checkboxes, in the normal state.

    Declaration

    Swift

    public var checkboxForegroundColor: UIColor

Table view cell

Close button

  • The tint to apply to the close button.

    Declaration

    Swift

    public var closeButtonTintColor: UIColor

Cancel button

  • The background color for the “Yes, cancel” button when cancelling a verification.

    Declaration

    Swift

    public var cancelButtonBackgroundColor: UIColor

  • The text color for the “Yes, cancel” when cancelling a verification.

    Declaration

    Swift

    public var cancelButtonTextColor: UIColor

  • The background color for the “No, resume” button when cancelling a verification.

    Declaration

    Swift

    public var cancelButtonAlternateBackgroundColor: UIColor

  • The text color for the “No, resume” button when cancelling a verification.

    Declaration

    Swift

    public var cancelButtonAlternateTextColor: UIColor

  • The shadow color for buttons (this should include the desired opacity), e.g. UIColor.black.withAlphaComponent(0.5)

    Declaration

    Swift

    public var cancelButtonShadowColor: UIColor

  • The blur radius (in points) used to render the shadow.

    Declaration

    Swift

    public var cancelButtonShadowRadius: CGFloat

  • The offset (in points) of the shadow.

    Declaration

    Swift

    public var cancelButtonShadowOffset: CGSize

Processing view

  • The text alignment for labels on the processing view.

    Declaration

    Swift

    public var processingLabelsTextAlignment: NSTextAlignment

Assets

  • The path to a custom Lottie animation (found in the app bundle) that shows loading activity.

    Declaration

    Swift

    public var loadingAnimation: AnimationAsset?

  • The background image to use while the first screen of the inquiry is loading.

    Declaration

    Swift

    public var initialLoadingBackgroundImage: UIImage?

  • The path to a custom Lottie animation (found in the app bundle) that shows processing activity.

    Declaration

    Swift

    public var processingAnimation: AnimationAsset?

  • The path to a custom asset shown on the selfie biometrics consent screen The asset can be:

    • an AnimationAsset (requires path and size to a Lottie animation found in the app bundle)
    • an SVGAsset (requires path and size to a SVG image found in the app bundle)
    • an ImageAsset (requires name and size of a JPG/PNG image found in the app bundle)

    Declaration

    Swift

    public var selfieAsset: ThemeAsset?

  • The path to a custom asset that’s shown when an inquiry succeeds. The asset can be:

    • an AnimationAsset (requires path and size to a Lottie animation found in the app bundle)
    • an SVGAsset (requires path and size to a SVG image found in the app bundle)
    • an ImageAsset (requires name and size of a JPG/PNG image found in the app bundle)

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var successAsset: ThemeAsset?

  • The path to a custom asset that’s shown when an inquiry fails. The asset can be:

    • an AnimationAsset (requires path and size to a Lottie animation found in the app bundle)
    • an SVGAsset (requires path and size to a SVG image found in the app bundle)
    • an ImageAsset (requires name and size of a JPG/PNG image found in the app bundle)

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var failedAsset: ThemeAsset?

  • The path to a custom asset that’s shown when a verification fails. The asset can be:

    • an AnimationAsset (requires path and size to a Lottie animation found in the app bundle)
    • an SVGAsset (requires path and size to a SVG image found in the app bundle)
    • an ImageAsset (requires name and size of a JPG/PNG image found in the app bundle)

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var verificationFailedAsset: ThemeAsset?

  • When set to true, will center remote assets on ui steps (most commonly: start, fail, retry, success screens). Default value is false.

    Declaration

    Swift

    public var centerAlignRemoteAsset: Bool

Separator

  • The border color for separators.

    Declaration

    Swift

    public var separatorColor: UIColor

Camera

  • The text color for camera hint titles.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraInstructionsTextColor: UIColor

  • The font for camera hint labels.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraInstructionsTextFont: UIFont

  • The text alignment for camera hint labels.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraInstructionTextAlignment: NSTextAlignment

  • The background color for the button that takes a photo.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraButtonBackgroundColor: UIColor

  • The text color for the button that takes a photo.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraButtonTextColor: UIColor

  • The background color for the button that re-takes a photo.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraButtonAlternateBackgroundColor: UIColor

  • The text color for the button that re-takes a photo.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraButtonAlternateTextColor: UIColor

  • The text color for camera hint titles.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraHintTextColor: UIColor

  • The font for camera hint labels.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraHintTextFont: UIFont

  • The text color for camera guide hint titles.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraGuideHintTextColor: UIColor

  • The text color for the [ ] corners shown as a guide when the user is taking a photo.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraGuideCornersColor: UIColor

  • The font for camera guide hint labels.

    Declaration

    Swift

    @available(*, deprecated, message: "Unused in dynamic flows")
public var cameraGuideHintTextFont: UIFont

GovernmentId

  • An optional header icon to display above the title on government id select screen

    Declaration

    Swift

    public var governmentIdSelectScreenHeaderIcon: ImageAsset?

  • The background color for government id captures. If no color is provided, a blur effect is used instead. Use an alpha color to show the camera preview outside of the government id frame. e.g. UIColor.black.withAlphaComponent(0.75)

    Declaration

    Swift

    public var governmentIdCaptureBackgroundColor: UIColor?

  • The stroke style to use for government id captures while scanning.

    Declaration

    Swift

    public var governmentIdScanningStrokeStyle: InquiryTheme.IdFrameStrokeStyle

  • The stroke style to use for government id captures while capturing.

    Declaration

    Swift

    public var governmentIdCapturingStrokeStyle: InquiryTheme.IdFrameStrokeStyle

  • The stroke style to use for government id captures while confirming.

    Declaration

    Swift

    public var governmentIdConfirmingStrokeStyle: InquiryTheme.IdFrameStrokeStyle

  • The animation asset to use for government id captures while scanning. Size is ignored on this asset.

    Declaration

    Swift

    public var governmentIdScanningAnimation: AnimationAsset?

  • Icon to display next to optional disclaimer on government id camera screens. Size ignored on this asset, uses a width and height of 24.

    Declaration

    Swift

    public var governmentIdCaptureDisclaimerIcon: ImageAsset?

  • The text alignment to use for government id hints

    Declaration

    Swift

    public var governmentIdHintTextAlignment: NSTextAlignment

  • The text color to use for government id hints

    Declaration

    Swift

    public var governmentIdHintTextColor: UIColor

  • The font to use for government id hints

    Declaration

    Swift

    public var governmentIdHintTextFont: UIFont

  • The background color to use for government id hints

    Declaration

    Swift

    public var governmentIdHintBackgroundColor: UIColor

  • The guide overlay to use during generic front capture of government id

    Declaration

    Swift

    public var governmentIdOverlayGenericFrontImage: UIImage?

  • The guide overlay to use during back capture of government id types with pdf417 barcode

    Declaration

    Swift

    public var governmentIdOverlayBarcodeImage: UIImage?

  • The guide overlay to use during capture of government id types with mrz barcodes (e.g. passport)

    Declaration

    Swift

    public var governmentIdOverlayMrzImage: UIImage?

  • Whether or not to show the icons next to government id types

    Declaration

    Swift

    public var showGovernmentIdIcons: Bool

  • Whether or not to show the overlays for government id captures while scanning.

    Declaration

    Swift

    public var showGovernmentIdOverlays: Bool

  • Whether or not to show icon next to government id capture hints

    Declaration

    Swift

    public var showGovernmentIdHintIcons: Bool

Selfie

  • The background color for the silhouette overlay that’s shown when taking automated selfies. If no color is provided, a blur effect is used instead. An alpha value should be included in order to see the camera preview underneath, e.g. UIColor.black.withAlphaComponent(0.75)

    Declaration

    Swift

    public var selfieOverlayBackgroundColor: UIColor?

  • The asset to during selfie look left photos. Size is ignored on this asset. Uses a 1:1 aspect ratio in the selfie circle.

    Declaration

    Swift

    public var selfieLookLeftAsset: ThemeAsset?

  • The asset to use during selfie look right photos. Size is ignored on this asset. Uses a 1:1 aspect ratio in the selfie circle.

    Declaration

    Swift

    public var selfieLookRightAsset: ThemeAsset?

  • Asset to display above title on selfie consent screen

    Declaration

    Swift

    public var selfieStartScreenHeaderIcon: ImageAsset?

  • The font to use when counting down to take a selfie

    Declaration

    Swift

    public var selfieCountdownFont: UIFont

  • Constructor

    Declaration

    Swift

    @available(*, deprecated, message: "Please migrate to InquiryTheme(themeSource:﹚ initializer instead.")
public init()

  • Inquiry themes control the look and feel of a given flow. Persona’s dynamic flow product enables full support for server side themeing, configurable in the Persona dashboard

    Declaration

    Swift

    public init(themeSource: ThemeSource)

    Parameters

    themeSource

    An enum value which determines whether or not this sdk should use the theme object sent from our servers.

Public Type Definitions