Saga<'TEvent, 'TSagaData, 'TState> (FCQRS)

Saga<'TEvent, 'TSagaData, 'TState> Type

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

C#-friendly abstract base for a saga. A concrete saga supplies InitialData, SagaName, Originator (the aggregate it starts from), HandleEvent and ApplySideEffects; the base provides the wiring (Init/Factory) and the small transition DSL. Designed to be subclassed from C#.

Constructors

Constructor	Description
`Saga()` Full Usage: `Saga()` Returns: `Saga<'TEvent, 'TSagaData, 'TState>`	Returns: `Saga<'TEvent, 'TSagaData, 'TState>`

Instance members

Instance member	Description
`this.ApplySideEffects` Full Usage: `this.ApplySideEffects` Parameters: arg0 : `SagaState<'TSagaData, 'TState>` arg1 : `bool` Returns: `SagaSideEffectResult<'TState>` Modifiers: abstract	arg0 : `SagaState<'TSagaData, 'TState>` arg1 : `bool` Returns: `SagaSideEffectResult<'TState>`
`this.Factory` Full Usage: `this.Factory` Parameters: actorApi : `IActor` Returns: `AggregateFactory`	The factory the saga-starter spawns instances from. actorApi : `IActor` Returns: `AggregateFactory`
`this.Factory` Full Usage: `this.Factory` Parameters: actorApi : `IActor` snapshotPolicy : `SnapshotPolicy` Returns: `AggregateFactory`	The factory the saga-starter spawns instances from, with an explicit policy. actorApi : `IActor` snapshotPolicy : `SnapshotPolicy` Returns: `AggregateFactory`
`this.HandleEvent` Full Usage: `this.HandleEvent` Parameters: arg0 : `obj` arg1 : `SagaState<'TSagaData, 'TState option>` Returns: `EventAction<'TState>` Modifiers: abstract	arg0 : `obj` arg1 : `SagaState<'TSagaData, 'TState option>` Returns: `EventAction<'TState>`
`this.Init` Full Usage: `this.Init` Parameters: actorApi : `IActor` Returns: `EntityFac<obj>`	Register the saga; calling this IS the registration. actorApi : `IActor` Returns: `EntityFac<obj>`
`this.Init` Full Usage: `this.Init` Parameters: actorApi : `IActor` snapshotPolicy : `SnapshotPolicy` Returns: `EntityFac<obj>`	Register the saga with an explicit (already-resolved) snapshot policy. actorApi : `IActor` snapshotPolicy : `SnapshotPolicy` Returns: `EntityFac<obj>`
`this.InitialData` Full Usage: `this.InitialData` Returns: `'TSagaData` Modifiers: abstract	Returns: `'TSagaData`
`this.Originator` Full Usage: `this.Originator` Returns: `AggregateFactory` Modifiers: abstract	Returns: `AggregateFactory`
`this.SagaName` Full Usage: `this.SagaName` Returns: `string` Modifiers: abstract	Returns: `string`
`this.SnapshotPolicy` Full Usage: `this.SnapshotPolicy` Returns: `SnapshotPolicy` Modifiers: abstract	Per-saga snapshot cadence. Override to use Every(n) or NoSnapshots; the default falls back to config:akka:persistence:snapshot-version-count (or 30). Returns: `SnapshotPolicy`

Static members

Static member	Description
`Saga.NextState(next)` Full Usage: `Saga.NextState(next)` Parameters: next : `'TState` Returns: `SagaTransition<'TState>`	next : `'TState` Returns: `SagaTransition<'TState>`
`Saga.StateChanged(next)` Full Usage: `Saga.StateChanged(next)` Parameters: next : `'TState` Returns: `EventAction<'TState>`	Transition / event DSL — over TState. next : `'TState` Returns: `EventAction<'TState>`
`Saga.Stay()` Full Usage: `Saga.Stay()` Returns: `SagaTransition<'TState>`	Returns: `SagaTransition<'TState>`
`Saga.StopSaga()` Full Usage: `Saga.StopSaga()` Returns: `SagaTransition<'TState>`	Returns: `SagaTransition<'TState>`
`Saga.Unhandled()` Full Usage: `Saga.Unhandled()` Returns: `EventAction<'TState>`	Returns: `EventAction<'TState>`