SagaApi (FCQRS) | FCQRS

SagaApi Type

Namespace: FCQRS
Assembly: FCQRS.dll
Parent Module: CSharp
Base Type: obj

Low-level C# saga API (mirrors ActorApi/QueryApi). For most sagas, prefer the Saga<_,_,_> base class, which wraps this.

Static members

Static member	Description
`SagaApi.Factory(actorApi, sagaEntityFac, entityId)` Full Usage: `SagaApi.Factory(actorApi, sagaEntityFac, entityId)` Parameters: actorApi : `IActor` sagaEntityFac : `EntityFac<obj>` entityId : `string` Returns: `IEntityRef<obj>`	Get the factory for a saga actorApi : `IActor` sagaEntityFac : `EntityFac<obj>` entityId : `string` Returns: `IEntityRef<obj>`
`SagaApi.Init(actorApi, sagaData, handleEvent, applySideEffects, originatorFactory, sagaName)` Full Usage: `SagaApi.Init(actorApi, sagaData, handleEvent, applySideEffects, originatorFactory, sagaName)` Parameters: actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<obj, SagaState<'TSagaData, 'TSagaState option>, EventAction<'TSagaState>>` applySideEffects : `Func<SagaState<'TSagaData, 'TSagaState>, bool, SagaSideEffectResult<'TSagaState>>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`	Initialize a saga without apply (no data updates based on state) actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<obj, SagaState<'TSagaData, 'TSagaState option>, EventAction<'TSagaState>>` applySideEffects : `Func<SagaState<'TSagaData, 'TSagaState>, bool, SagaSideEffectResult<'TSagaState>>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`
`SagaApi.Init(actorApi, sagaData, handleEvent, applySideEffects, apply, originatorFactory, sagaName)` Full Usage: `SagaApi.Init(actorApi, sagaData, handleEvent, applySideEffects, apply, originatorFactory, sagaName)` Parameters: actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<obj, SagaState<'TSagaData, 'TSagaState option>, EventAction<'TSagaState>>` applySideEffects : `Func<SagaState<'TSagaData, 'TSagaState>, bool, SagaSideEffectResult<'TSagaState>>` apply : `Func<'TSagaData, 'TSagaState, 'TSagaData>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`	Initialize a saga with simplified apply - just takes data and unwrapped state, returns new data actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<obj, SagaState<'TSagaData, 'TSagaState option>, EventAction<'TSagaState>>` applySideEffects : `Func<SagaState<'TSagaData, 'TSagaState>, bool, SagaSideEffectResult<'TSagaState>>` apply : `Func<'TSagaData, 'TSagaState, 'TSagaData>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`
`SagaApi.Init(actorApi, sagaData, handleEvent, applySideEffects, apply, originatorFactory, sagaName, snapshotPolicy)` Full Usage: `SagaApi.Init(actorApi, sagaData, handleEvent, applySideEffects, apply, originatorFactory, sagaName, snapshotPolicy)` Parameters: actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<obj, SagaState<'TSagaData, 'TSagaState option>, EventAction<'TSagaState>>` applySideEffects : `Func<SagaState<'TSagaData, 'TSagaState>, bool, SagaSideEffectResult<'TSagaState>>` apply : `Func<SagaState<'TSagaData, SagaStateWrapper<'TSagaState, 'TEvent>>, SagaState<'TSagaData, SagaStateWrapper<'TSagaState, 'TEvent>>>` originatorFactory : `AggregateFactory` sagaName : `string` snapshotPolicy : `SnapshotPolicy` Returns: `EntityFac<obj>`	Initialize a saga with an explicit per-saga snapshot policy. actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<obj, SagaState<'TSagaData, 'TSagaState option>, EventAction<'TSagaState>>` applySideEffects : `Func<SagaState<'TSagaData, 'TSagaState>, bool, SagaSideEffectResult<'TSagaState>>` apply : `Func<SagaState<'TSagaData, SagaStateWrapper<'TSagaState, 'TEvent>>, SagaState<'TSagaData, SagaStateWrapper<'TSagaState, 'TEvent>>>` originatorFactory : `AggregateFactory` sagaName : `string` snapshotPolicy : `SnapshotPolicy` Returns: `EntityFac<obj>`
`SagaApi.Init(actorApi, sagaData, handleEvent, applySideEffects, apply, originatorFactory, sagaName)` Full Usage: `SagaApi.Init(actorApi, sagaData, handleEvent, applySideEffects, apply, originatorFactory, sagaName)` Parameters: actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<obj, SagaState<'TSagaData, 'TSagaState option>, EventAction<'TSagaState>>` applySideEffects : `Func<SagaState<'TSagaData, 'TSagaState>, bool, SagaSideEffectResult<'TSagaState>>` apply : `Func<SagaState<'TSagaData, SagaStateWrapper<'TSagaState, 'TEvent>>, SagaState<'TSagaData, SagaStateWrapper<'TSagaState, 'TEvent>>>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`	Initialize a saga with C# delegates 'TEvent - The triggering event type (from the originator aggregate) 'TSagaData - Cross-cutting saga data 'TSagaState - User-defined saga states actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<obj, SagaState<'TSagaData, 'TSagaState option>, EventAction<'TSagaState>>` applySideEffects : `Func<SagaState<'TSagaData, 'TSagaState>, bool, SagaSideEffectResult<'TSagaState>>` apply : `Func<SagaState<'TSagaData, SagaStateWrapper<'TSagaState, 'TEvent>>, SagaState<'TSagaData, SagaStateWrapper<'TSagaState, 'TEvent>>>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`
`SagaApi.InitSimple(actorApi, sagaData, handleEvent, applySideEffects, originatorFactory, sagaName)` Full Usage: `SagaApi.InitSimple(actorApi, sagaData, handleEvent, applySideEffects, originatorFactory, sagaName)` Parameters: actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<Event<'TEvent>, 'TSagaData, 'TSagaState, EventAction<'TSagaState>>` applySideEffects : `Func<'TSagaData, 'TSagaState, bool, SagaSideEffectResult<'TSagaState>>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`	Initialize a saga with simplified signatures and no apply actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<Event<'TEvent>, 'TSagaData, 'TSagaState, EventAction<'TSagaState>>` applySideEffects : `Func<'TSagaData, 'TSagaState, bool, SagaSideEffectResult<'TSagaState>>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`
`SagaApi.InitSimple(actorApi, sagaData, handleEvent, applySideEffects, apply, originatorFactory, sagaName)` Full Usage: `SagaApi.InitSimple(actorApi, sagaData, handleEvent, applySideEffects, apply, originatorFactory, sagaName)` Parameters: actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<Event<'TEvent>, 'TSagaData, 'TSagaState, EventAction<'TSagaState>>` applySideEffects : `Func<'TSagaData, 'TSagaState, bool, SagaSideEffectResult<'TSagaState>>` apply : `Func<'TSagaData, 'TSagaState, 'TSagaData>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`	Initialize a saga with simplified signatures - no FSharpOption, typed events handleEvent: (event, data, currentState) -> EventAction applySideEffects: (data, state, recovering) -> SagaSideEffectResult actorApi : `IActor` sagaData : `'TSagaData` handleEvent : `Func<Event<'TEvent>, 'TSagaData, 'TSagaState, EventAction<'TSagaState>>` applySideEffects : `Func<'TSagaData, 'TSagaState, bool, SagaSideEffectResult<'TSagaState>>` apply : `Func<'TSagaData, 'TSagaState, 'TSagaData>` originatorFactory : `AggregateFactory` sagaName : `string` Returns: `EntityFac<obj>`