UserTransactionErrorController

@MainActor
public class UserTransactionErrorController : ErrorController

This view controller is to be display when user transaction error occurred.

This view contains an error banner, a title label, a message label, an user image view, user name label, user info label, detail message label, and an action button.

  • The error banner has a default localized title “Sync Failed”. Developer can use errorBannerTitle property to customize the error banner title.
  • The title label has a default localized title “Transaction Issue”. Developer can use titleLabel.text property to change the default title.
  • The message label has a default localized message “Before you can access your account on this device, hand over the device to:”. Developer can use messageLabel.text to change the default message.
  • The user image view is to display the user image. Or, the user name initials when user image is not available.
  • The user name label is to display the user name.
  • The user info label is to display the user info.
  • The detail message label has a default localized detail message “They will need to sign in with their account and resolve their transaction issue.”. Developer can use detailMessageLabel property to customize the label.
  • The action button has a default localized title “Return to Sign In Screen”. Developer can use actionButton property to customize the button.

Also, there is a “Cancel” button on the navigation bar. Developer should set the onCancelHandler property to process user cancel action.

Theming

Supported fixed font UILabel class paths:

fdlFUIFeedbackScreen_UserTransactionErrorController_titleLabel
fdlFUIFeedbackScreen_UserTransactionErrorController_messageLabel
fdlFUIFeedbackScreen_UserTransactionErrorController_detailMessageLabel
fdlFUIFeedbackScreen_UserTransactionErrorController_userNameLabel
fdlFUIFeedbackScreen_UserTransactionErrorController_userInfoLabel

Supported fixed font UILabel properties:

font-size: (Size)
font-name: (Font Name)
font-color: (Color)

Supported ImagePlaceholder class paths:

fdlFUIFeedbackScreen_UserTransactionErrorController_userImagePlaceholder

Supported ImagePlaceholder properties:

font-size: (Size)
font-name: (Font Name)
font-color: (Color)

Supported ImagePlaceholderView class paths:

fdlFUIFeedbackScreen_UserTransactionErrorController_userImagePlaceholderView

Supported ImagePlaceholderView properties:

background-color: (Color)

Support FUIButton class paths:

fdlFUIFeedbackScreen_UserTransactionErrorController_actionButton

Supported FUIButton properties:

font-style: (Font Style Name)
font-color: (Color)
corner-radius: (Radius)
background-color-normal: (Color)
background-color-highlighted: (Color)

Supported UIBarButtonItem class paths:

fdlFUIFeedbackScreen_UserTransactionErrorController_closeButton

Supported UIBarButtonItem properties:

image: (Image Name)
background-tint-color: (Color)

  • The label containing the detail message.

    The default localized detail message is “They will need to sign in with their account and resolve their transaction issue.”.

    Declaration

    Swift

    @MainActor
public let detailMessageLabel: FUILabel

  • This image view contains the image of the user.

    This image view will be displayed If property showsUserImage is true.

    The user image is coming from the user property. A image with user name initials will be displayed if there is no image provided in the user property.

    Declaration

    Swift

    @MainActor
public let userImageView: FUIImageView

  • The label for the user name.

    The user name is coming from the user property.

    Declaration

    Swift

    @MainActor
public let userNameLabel: FUILabel

  • The label for other user info to be displayed.

    This label will be displayed if property showsUserInfo is true.

    The user info is coming from the user property.

    Declaration

    Swift

    @MainActor
public let userInfoLabel: FUILabel

  • The user associated with the transaction error.

    Declaration

    Swift

    @MainActor
public var user: FUIUser? { get set }

  • This property indicates if the user image is to be displayed or not.

    The default is true.

    Declaration

    Swift

    @MainActor
public var showsUserImage: Bool

  • This property indicates if the user info label is to be displayed or not.

    The default is true.

    Declaration

    Swift

    @MainActor
public var showsUserInfo: Bool

  • This handler is to be invoked when user tapped the action button.

    Declaration

    Swift

    @MainActor
public var onReturnToLoginHandler: ((UserTransactionErrorController) -> Void)?