ActionGroupConfiguration

@MainActor
public struct ActionGroupConfiguration<InteractorType, ContentType> : InteractorConfiguring, ActionCollectionConfiguring where InteractorType : InteractorTypeable, ContentType : ContentTypeable

Configures a group of Interactor actions which an ActionGroup runs in parallel as a single step in an ActionSequence.

Each child configuration makes its own Interactor request; when all have completed, the supplied SequenceGroupMerging object merges their results into a single content value which is passed on through the group’s output conduit. Children can cancel the group’s task on a per-child basis with GroupStepConfiguration‘s shouldEndParentTaskOnFailure property.

GroupActionType
A group has no single action type of its own; this placeholder satisfies the ActionConfiguring requirement. Each child carries its own real action type.
See more
Declaration
Swift

public enum GroupActionType : InteractorRequestActionTypeable


                    
                    
                    ActionType

Undocumented

Declaration

Swift

public typealias ActionType = GroupActionType


                    
                    
                    interactorType

Declaration

Swift

@MainActor
public let interactorType: InteractorType?


                    
                    
                    actionType

Declaration

Swift

@MainActor
public let actionType: GroupActionType

assistant
Unused. A group has no single assistant. Each child builds its own.
Declaration
Swift

@MainActor public let assistant: InteractorAssistantType


                    
                    
                    configurationType

Declaration

Swift

@MainActor
public let configurationType: ActionConfigurationType


                    
                    
                    outputConduit

Declaration

Swift

@MainActor
public var outputConduit: (any ActionSequenceConduiting<ContentType>)?

identifier
An optional identifier of this group step, carried onto the group’s ActionResult.
Declaration
Swift

@MainActor public let identifier: (any ActionIdentifying)?


                    
                    
                    shouldEndParentTaskOnFailure

Declaration

Swift

@MainActor
public let shouldEndParentTaskOnFailure: Bool


                    
                    
                    shouldSaveResult

Declaration

Swift

@MainActor
public let shouldSaveResult: Bool

shouldSaveChildResults
Determines whether the results of this group’s children are saved in its origin when the group’s result is passed on
Declaration
Swift

@MainActor public let shouldSaveChildResults: Bool
actions
An array of action configurations which the group should run in parallel.
Declaration
Swift

@MainActor public let actions: [any ActionConfiguring<InteractorType, ContentType>]


                    
                    
                    merger

Handles request output merging for this group action.

Declaration

Swift

@MainActor
public let merger: (any ActionResultsMerging<ContentType>)?


                    
                    
                    init(actions:merger:outputConduit:identifier:shouldEndParentTaskOnFailure:shouldSaveResult:shouldSaveChildResults:)

Creates a group configuration.

Declaration

Swift

@MainActor
public init(actions: [any ActionConfiguring<InteractorType, ContentType>], merger: any ActionResultsMerging<ContentType>, outputConduit: (any ActionSequenceConduiting<ContentType>)? = nil, identifier: (any ActionIdentifying)?, shouldEndParentTaskOnFailure: Bool? = nil, shouldSaveResult: Bool? = nil, shouldSaveChildResults: Bool? = nil)

Parameters

`actions`	The configurations of the actions which should run in parallel within this group.
`merger`	An object which merges the child action results into a single content value.
`outputConduit`	An optional conduit which passes the merged content on to the next step in the sequence.
`type`	An optional type tagging this group step, used to locate the group’s result in an `ActionSequenceResults` object.


                    
                    
                    buildAssistant()

Declaration

Swift

@MainActor
public func buildAssistant() throws -> any AsyncInteractorAssisting<InteractorType, ContentType>


                    
                    
                    buildAction(resultHandler:)

Declaration

Swift

@MainActor
public func buildAction(resultHandler: any InteractorResultHandling<InteractorType, ContentType>) throws -> any ActionPerformable<ContentType>