RSDAsyncActionConfiguration

public protocol RSDAsyncActionConfiguration : RSDPermissionsConfiguration

RSDAsyncActionConfiguration defines general configuration for an asynchronous background action that should be run in the background. Depending upon the parameters and how the action is set up, this could be something that is run continuously or else is paused or reset based on a timeout interval.

The configuration is intended to be a serializable object and does not call services, record data, or anything else. It does include a step identifier that can be used to let the RSDTaskController know when to trigger the async action.

Seealso

RSDTaskController and RSDAsyncAction.

  • A short string that uniquely identifies the asynchronous action within the task. If started asynchronously, then the identifier maps to a result stored in RSDTaskResult.asyncResults.

    Declaration

    Swift

    var identifier: String { get }

  • An identifier marking the step to start the action. If nil, then the action will be started when the task is started.

    Declaration

    Swift

    var startStepIdentifier: String? { get }

  • Validate the async action to check for any configuration that should throw an error.

    Declaration

    Swift

    func validate() throws