ActionPerformOutcome

public enum ActionPerformOutcome : CustomStringConvertible

The type that indicates the outcome of performing an action.

Actions use this result type to indicate whether or not the current action stack should be closed, indicating the end of a sequence of action usage for a given feature.

  • The action completed successfully. Pass true for closeActionStack if this action should result in the current action stack being closed, so no more actions are added to it. Usually this will be false but pass true when the action clearly indicates the user is no longer using the feature, e.g. closing a document for a Document Editing Feature

    Declaration

    Swift

    case success(closeActionStack: Bool)
  • The action encountered an error. Pass true for closeActionStack if this action should result in the current action stack being closed, so no more actions are added to it. Usually this will be false but pass true when the action clearly indicates the user is no longer using the feature, e.g. closing a document for a Document Editing Feature

    Declaration

    Swift

    case failure(error: Error?, closeActionStack: Bool)
  • Declaration

    Swift

    public var description: String { get }