WAError

public struct WAError : Error

WAError represents an error in the writing assistant feature, providing details about the error and potential actions which will be used in IllustratedMessage.

  • Detail image for the error.

    Declaration

    Swift

    public let detailImage: Image?

  • Title of the error.

    Declaration

    Swift

    public let title: AttributedString

  • Description of the error.

    Declaration

    Swift

    public let description: AttributedString?

  • Action button for the error.

    Declaration

    Swift

    public let action: FioriButton?

  • Secondary action button for the error.

    Declaration

    Swift

    public let secondaryAction: FioriButton?

  • Size of the detail image.

    Declaration

    Swift

    public let detailImageSize: IllustratedMessage.DetailImageSize?

  • Whether the action button is vertically aligned.

    Declaration

    Swift

    public let isActionVerticallyAligned: Bool?

  • Content alignment for the error message.

    Declaration

    Swift

    public let contentAlignment: HorizontalAlignment?

  • Initialization for a WAError.

    Declaration

    Swift

    public init(detailImage: Image? = nil,
            title: AttributedString,
            description: AttributedString? = nil,
            action: FioriButton? = nil,
            secondaryAction: FioriButton? = nil,
            detailImageSize: IllustratedMessage.DetailImageSize? = nil,
            isActionVerticallyAligned: Bool? = nil,
            contentAlignment: HorizontalAlignment? = nil)

    Parameters

    detailImage

    Detail image for the error.
    title

    The title of the error.
    description

    Description of the error.
    action

    Action button for the error.
    secondaryAction

    Secondary action button for the error.
    detailImageSize

    Size for the detail image.
    isActionVerticallyAligned

    A boolean value to indicate whether the action button is vertically aligned.
    contentAlignment

    Content alignment for the error message.