AmplifyTaskExecution

public protocol AmplifyTaskExecution

Task that supports hub with execution of a single unit of work. .

See Also: AmplifyTask

  • Tag: AmplifyTaskExecution

  • Declaration

    Swift

    associatedtype Success

  • Declaration

    Swift

    associatedtype Request

  • Declaration

    Swift

    associatedtype Failure : AmplifyError

  • Declaration

    Swift

    typealias AmplifyTaskExecutionResult = Result<Success, Failure>
  • value Asynchronous

    Blocks until the receiver has successfully collected a result or throws if an error was encountered.

    • Tag: AmplifyTaskExecution.value

    Declaration

    Swift

    var value: Success { get async throws }

  • Hub event name for the task

    • Tag: AmplifyTaskExecution.eventName

    Declaration

    Swift

    var eventName: HubPayloadEventName { get }

  • Category for which the Hub event would be dispatched for.

    • Tag: AmplifyTaskExecution.eventNameCategoryType

    Declaration

    Swift

    var eventNameCategoryType: CategoryType { get }
  • execute() Asynchronous

    Executes work represented by the receiver.

    • Tag: AmplifyTaskExecution.execute

    Declaration

    Swift

    func execute() async throws -> Success

  • Dispatches a hub event.

    • Tag: AmplifyTaskExecution.dispatch

    Declaration

    Swift

    func dispatch(result: AmplifyTaskExecutionResult)