Namespace Messages.
- Source:
Classes
- ConnectToPersistentSubscription
- CreatePersistentSubscription
- CreatePersistentSubscriptionCompleted
- DeletePersistentSubscription
- DeletePersistentSubscriptionCompleted
- DeleteStream
- DeleteStreamCompleted
- EventRecord
- NewEvent
- NotHandled
- PersistentSubscriptionAckEvents
- PersistentSubscriptionConfirmation
- PersistentSubscriptionNakEvents
- PersistentSubscriptionStreamEventAppeared
- ReadAllEvents
- ReadAllEventsCompleted
- ReadEvent
- ReadEventCompleted
- ReadStreamEvents
- ReadStreamEventsCompleted
- ResolvedEvent
- ResolvedIndexedEvent
- ScavengeDatabase
- ScavengeDatabaseCompleted
- StreamEventAppeared
- SubscribeToStream
- SubscriptionConfirmation
- SubscriptionDropped
- TransactionCommit
- TransactionCommitCompleted
- TransactionStart
- TransactionStartCompleted
- TransactionWrite
- TransactionWriteCompleted
- UnsubscribeFromStream
- UpdatePersistentSubscription
- UpdatePersistentSubscriptionCompleted
- WriteEvents
- WriteEventsCompleted
Members
(static) OperationResult :number
OperationResult enum.
Type:
- number
Properties:
Name | Type | Description |
---|---|---|
Success |
number | Success value |
PrepareTimeout |
number | PrepareTimeout value |
CommitTimeout |
number | CommitTimeout value |
ForwardTimeout |
number | ForwardTimeout value |
WrongExpectedVersion |
number | WrongExpectedVersion value |
StreamDeleted |
number | StreamDeleted value |
InvalidTransaction |
number | InvalidTransaction value |
AccessDenied |
number | AccessDenied value |
- Source:
Type Definitions
ConnectToPersistentSubscription$Properties
Properties of a ConnectToPersistentSubscription.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
subscriptionId |
string | ConnectToPersistentSubscription subscriptionId. |
eventStreamId |
string | ConnectToPersistentSubscription eventStreamId. |
allowedInFlightMessages |
number | ConnectToPersistentSubscription allowedInFlightMessages. |
- Source:
CreatePersistentSubscription$Properties
Properties of a CreatePersistentSubscription.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
subscriptionGroupName |
string | CreatePersistentSubscription subscriptionGroupName. | |
eventStreamId |
string | CreatePersistentSubscription eventStreamId. | |
resolveLinkTos |
boolean | CreatePersistentSubscription resolveLinkTos. | |
startFrom |
number | CreatePersistentSubscription startFrom. | |
messageTimeoutMilliseconds |
number | CreatePersistentSubscription messageTimeoutMilliseconds. | |
recordStatistics |
boolean | CreatePersistentSubscription recordStatistics. | |
liveBufferSize |
number | CreatePersistentSubscription liveBufferSize. | |
readBatchSize |
number | CreatePersistentSubscription readBatchSize. | |
bufferSize |
number | CreatePersistentSubscription bufferSize. | |
maxRetryCount |
number | CreatePersistentSubscription maxRetryCount. | |
preferRoundRobin |
boolean | CreatePersistentSubscription preferRoundRobin. | |
checkpointAfterTime |
number | CreatePersistentSubscription checkpointAfterTime. | |
checkpointMaxCount |
number | CreatePersistentSubscription checkpointMaxCount. | |
checkpointMinCount |
number | CreatePersistentSubscription checkpointMinCount. | |
subscriberMaxCount |
number | CreatePersistentSubscription subscriberMaxCount. | |
namedConsumerStrategy |
string |
<optional> |
CreatePersistentSubscription namedConsumerStrategy. |
- Source:
CreatePersistentSubscriptionCompleted$Properties
Properties of a CreatePersistentSubscriptionCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
result |
EventStore.Client.Messages.CreatePersistentSubscriptionCompleted.CreatePersistentSubscriptionResult | CreatePersistentSubscriptionCompleted result. | |
reason |
string |
<optional> |
CreatePersistentSubscriptionCompleted reason. |
- Source:
DeletePersistentSubscription$Properties
Properties of a DeletePersistentSubscription.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
subscriptionGroupName |
string | DeletePersistentSubscription subscriptionGroupName. |
eventStreamId |
string | DeletePersistentSubscription eventStreamId. |
- Source:
DeletePersistentSubscriptionCompleted$Properties
Properties of a DeletePersistentSubscriptionCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
result |
EventStore.Client.Messages.DeletePersistentSubscriptionCompleted.DeletePersistentSubscriptionResult | DeletePersistentSubscriptionCompleted result. | |
reason |
string |
<optional> |
DeletePersistentSubscriptionCompleted reason. |
- Source:
DeleteStream$Properties
Properties of a DeleteStream.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
eventStreamId |
string | DeleteStream eventStreamId. | |
expectedVersion |
number | DeleteStream expectedVersion. | |
requireMaster |
boolean | DeleteStream requireMaster. | |
hardDelete |
boolean |
<optional> |
DeleteStream hardDelete. |
- Source:
DeleteStreamCompleted$Properties
Properties of a DeleteStreamCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
result |
EventStore.Client.Messages.OperationResult | DeleteStreamCompleted result. | |
message |
string |
<optional> |
DeleteStreamCompleted message. |
preparePosition |
number | Long |
<optional> |
DeleteStreamCompleted preparePosition. |
commitPosition |
number | Long |
<optional> |
DeleteStreamCompleted commitPosition. |
- Source:
EventRecord$Properties
Properties of an EventRecord.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
eventStreamId |
string | EventRecord eventStreamId. | |
eventNumber |
number | EventRecord eventNumber. | |
eventId |
Uint8Array | EventRecord eventId. | |
eventType |
string | EventRecord eventType. | |
dataContentType |
number | EventRecord dataContentType. | |
metadataContentType |
number | EventRecord metadataContentType. | |
data |
Uint8Array | EventRecord data. | |
metadata |
Uint8Array |
<optional> |
EventRecord metadata. |
created |
number | Long |
<optional> |
EventRecord created. |
createdEpoch |
number | Long |
<optional> |
EventRecord createdEpoch. |
- Source:
NewEvent$Properties
Properties of a NewEvent.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
eventId |
Uint8Array | NewEvent eventId. | |
eventType |
string | NewEvent eventType. | |
dataContentType |
number | NewEvent dataContentType. | |
metadataContentType |
number | NewEvent metadataContentType. | |
data |
Uint8Array | NewEvent data. | |
metadata |
Uint8Array |
<optional> |
NewEvent metadata. |
- Source:
NotHandled$Properties
Properties of a NotHandled.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
reason |
EventStore.Client.Messages.NotHandled.NotHandledReason | NotHandled reason. | |
additionalInfo |
Uint8Array |
<optional> |
NotHandled additionalInfo. |
- Source:
PersistentSubscriptionAckEvents$Properties
Properties of a PersistentSubscriptionAckEvents.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
subscriptionId |
string | PersistentSubscriptionAckEvents subscriptionId. | |
processedEventIds |
Array.<Uint8Array> |
<optional> |
PersistentSubscriptionAckEvents processedEventIds. |
- Source:
PersistentSubscriptionConfirmation$Properties
Properties of a PersistentSubscriptionConfirmation.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
lastCommitPosition |
number | Long | PersistentSubscriptionConfirmation lastCommitPosition. | |
subscriptionId |
string | PersistentSubscriptionConfirmation subscriptionId. | |
lastEventNumber |
number |
<optional> |
PersistentSubscriptionConfirmation lastEventNumber. |
- Source:
PersistentSubscriptionNakEvents$Properties
Properties of a PersistentSubscriptionNakEvents.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
subscriptionId |
string | PersistentSubscriptionNakEvents subscriptionId. | |
processedEventIds |
Array.<Uint8Array> |
<optional> |
PersistentSubscriptionNakEvents processedEventIds. |
message |
string |
<optional> |
PersistentSubscriptionNakEvents message. |
action |
EventStore.Client.Messages.PersistentSubscriptionNakEvents.NakAction | PersistentSubscriptionNakEvents action. |
- Source:
PersistentSubscriptionStreamEventAppeared$Properties
Properties of a PersistentSubscriptionStreamEventAppeared.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
event |
EventStore.Client.Messages.ResolvedIndexedEvent$Properties | PersistentSubscriptionStreamEventAppeared event. |
- Source:
ReadAllEvents$Properties
Properties of a ReadAllEvents.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
commitPosition |
number | Long | ReadAllEvents commitPosition. |
preparePosition |
number | Long | ReadAllEvents preparePosition. |
maxCount |
number | ReadAllEvents maxCount. |
resolveLinkTos |
boolean | ReadAllEvents resolveLinkTos. |
requireMaster |
boolean | ReadAllEvents requireMaster. |
- Source:
ReadAllEventsCompleted$Properties
Properties of a ReadAllEventsCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
commitPosition |
number | Long | ReadAllEventsCompleted commitPosition. | |
preparePosition |
number | Long | ReadAllEventsCompleted preparePosition. | |
events |
Array.<EventStore.Client.Messages.ResolvedEvent$Properties> |
<optional> |
ReadAllEventsCompleted events. |
nextCommitPosition |
number | Long | ReadAllEventsCompleted nextCommitPosition. | |
nextPreparePosition |
number | Long | ReadAllEventsCompleted nextPreparePosition. | |
result |
EventStore.Client.Messages.ReadAllEventsCompleted.ReadAllResult |
<optional> |
ReadAllEventsCompleted result. |
error |
string |
<optional> |
ReadAllEventsCompleted error. |
- Source:
ReadEvent$Properties
Properties of a ReadEvent.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
eventStreamId |
string | ReadEvent eventStreamId. |
eventNumber |
number | ReadEvent eventNumber. |
resolveLinkTos |
boolean | ReadEvent resolveLinkTos. |
requireMaster |
boolean | ReadEvent requireMaster. |
- Source:
ReadEventCompleted$Properties
Properties of a ReadEventCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
result |
EventStore.Client.Messages.ReadEventCompleted.ReadEventResult | ReadEventCompleted result. | |
event |
EventStore.Client.Messages.ResolvedIndexedEvent$Properties | ReadEventCompleted event. | |
error |
string |
<optional> |
ReadEventCompleted error. |
- Source:
ReadStreamEvents$Properties
Properties of a ReadStreamEvents.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
eventStreamId |
string | ReadStreamEvents eventStreamId. |
fromEventNumber |
number | ReadStreamEvents fromEventNumber. |
maxCount |
number | ReadStreamEvents maxCount. |
resolveLinkTos |
boolean | ReadStreamEvents resolveLinkTos. |
requireMaster |
boolean | ReadStreamEvents requireMaster. |
- Source:
ReadStreamEventsCompleted$Properties
Properties of a ReadStreamEventsCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
events |
Array.<EventStore.Client.Messages.ResolvedIndexedEvent$Properties> |
<optional> |
ReadStreamEventsCompleted events. |
result |
EventStore.Client.Messages.ReadStreamEventsCompleted.ReadStreamResult | ReadStreamEventsCompleted result. | |
nextEventNumber |
number | ReadStreamEventsCompleted nextEventNumber. | |
lastEventNumber |
number | ReadStreamEventsCompleted lastEventNumber. | |
isEndOfStream |
boolean | ReadStreamEventsCompleted isEndOfStream. | |
lastCommitPosition |
number | Long | ReadStreamEventsCompleted lastCommitPosition. | |
error |
string |
<optional> |
ReadStreamEventsCompleted error. |
- Source:
ResolvedEvent$Properties
Properties of a ResolvedEvent.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
event |
EventStore.Client.Messages.EventRecord$Properties | ResolvedEvent event. | |
link |
EventStore.Client.Messages.EventRecord$Properties |
<optional> |
ResolvedEvent link. |
commitPosition |
number | Long | ResolvedEvent commitPosition. | |
preparePosition |
number | Long | ResolvedEvent preparePosition. |
- Source:
ResolvedIndexedEvent$Properties
Properties of a ResolvedIndexedEvent.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
event |
EventStore.Client.Messages.EventRecord$Properties | ResolvedIndexedEvent event. | |
link |
EventStore.Client.Messages.EventRecord$Properties |
<optional> |
ResolvedIndexedEvent link. |
- Source:
ScavengeDatabase$Properties
Properties of a ScavengeDatabase.
Type:
- Object
- Source:
ScavengeDatabaseCompleted$Properties
Properties of a ScavengeDatabaseCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
result |
EventStore.Client.Messages.ScavengeDatabaseCompleted.ScavengeResult | ScavengeDatabaseCompleted result. | |
error |
string |
<optional> |
ScavengeDatabaseCompleted error. |
totalTimeMs |
number | ScavengeDatabaseCompleted totalTimeMs. | |
totalSpaceSaved |
number | Long | ScavengeDatabaseCompleted totalSpaceSaved. |
- Source:
StreamEventAppeared$Properties
Properties of a StreamEventAppeared.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
event |
EventStore.Client.Messages.ResolvedEvent$Properties | StreamEventAppeared event. |
- Source:
SubscribeToStream$Properties
Properties of a SubscribeToStream.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
eventStreamId |
string | SubscribeToStream eventStreamId. |
resolveLinkTos |
boolean | SubscribeToStream resolveLinkTos. |
- Source:
SubscriptionConfirmation$Properties
Properties of a SubscriptionConfirmation.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
lastCommitPosition |
number | Long | SubscriptionConfirmation lastCommitPosition. | |
lastEventNumber |
number |
<optional> |
SubscriptionConfirmation lastEventNumber. |
- Source:
SubscriptionDropped$Properties
Properties of a SubscriptionDropped.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
reason |
EventStore.Client.Messages.SubscriptionDropped.SubscriptionDropReason |
<optional> |
SubscriptionDropped reason. |
- Source:
TransactionCommit$Properties
Properties of a TransactionCommit.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
transactionId |
number | Long | TransactionCommit transactionId. |
requireMaster |
boolean | TransactionCommit requireMaster. |
- Source:
TransactionCommitCompleted$Properties
Properties of a TransactionCommitCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
transactionId |
number | Long | TransactionCommitCompleted transactionId. | |
result |
EventStore.Client.Messages.OperationResult | TransactionCommitCompleted result. | |
message |
string |
<optional> |
TransactionCommitCompleted message. |
firstEventNumber |
number | TransactionCommitCompleted firstEventNumber. | |
lastEventNumber |
number | TransactionCommitCompleted lastEventNumber. | |
preparePosition |
number | Long |
<optional> |
TransactionCommitCompleted preparePosition. |
commitPosition |
number | Long |
<optional> |
TransactionCommitCompleted commitPosition. |
- Source:
TransactionStart$Properties
Properties of a TransactionStart.
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
eventStreamId |
string | TransactionStart eventStreamId. |
expectedVersion |
number | TransactionStart expectedVersion. |
requireMaster |
boolean | TransactionStart requireMaster. |
- Source:
TransactionStartCompleted$Properties
Properties of a TransactionStartCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
transactionId |
number | Long | TransactionStartCompleted transactionId. | |
result |
EventStore.Client.Messages.OperationResult | TransactionStartCompleted result. | |
message |
string |
<optional> |
TransactionStartCompleted message. |
- Source:
TransactionWrite$Properties
Properties of a TransactionWrite.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
transactionId |
number | Long | TransactionWrite transactionId. | |
events |
Array.<EventStore.Client.Messages.NewEvent$Properties> |
<optional> |
TransactionWrite events. |
requireMaster |
boolean | TransactionWrite requireMaster. |
- Source:
TransactionWriteCompleted$Properties
Properties of a TransactionWriteCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
transactionId |
number | Long | TransactionWriteCompleted transactionId. | |
result |
EventStore.Client.Messages.OperationResult | TransactionWriteCompleted result. | |
message |
string |
<optional> |
TransactionWriteCompleted message. |
- Source:
UnsubscribeFromStream$Properties
Properties of an UnsubscribeFromStream.
Type:
- Object
- Source:
UpdatePersistentSubscription$Properties
Properties of an UpdatePersistentSubscription.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
subscriptionGroupName |
string | UpdatePersistentSubscription subscriptionGroupName. | |
eventStreamId |
string | UpdatePersistentSubscription eventStreamId. | |
resolveLinkTos |
boolean | UpdatePersistentSubscription resolveLinkTos. | |
startFrom |
number | UpdatePersistentSubscription startFrom. | |
messageTimeoutMilliseconds |
number | UpdatePersistentSubscription messageTimeoutMilliseconds. | |
recordStatistics |
boolean | UpdatePersistentSubscription recordStatistics. | |
liveBufferSize |
number | UpdatePersistentSubscription liveBufferSize. | |
readBatchSize |
number | UpdatePersistentSubscription readBatchSize. | |
bufferSize |
number | UpdatePersistentSubscription bufferSize. | |
maxRetryCount |
number | UpdatePersistentSubscription maxRetryCount. | |
preferRoundRobin |
boolean | UpdatePersistentSubscription preferRoundRobin. | |
checkpointAfterTime |
number | UpdatePersistentSubscription checkpointAfterTime. | |
checkpointMaxCount |
number | UpdatePersistentSubscription checkpointMaxCount. | |
checkpointMinCount |
number | UpdatePersistentSubscription checkpointMinCount. | |
subscriberMaxCount |
number | UpdatePersistentSubscription subscriberMaxCount. | |
namedConsumerStrategy |
string |
<optional> |
UpdatePersistentSubscription namedConsumerStrategy. |
- Source:
UpdatePersistentSubscriptionCompleted$Properties
Properties of an UpdatePersistentSubscriptionCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
result |
EventStore.Client.Messages.UpdatePersistentSubscriptionCompleted.UpdatePersistentSubscriptionResult | UpdatePersistentSubscriptionCompleted result. | |
reason |
string |
<optional> |
UpdatePersistentSubscriptionCompleted reason. |
- Source:
WriteEvents$Properties
Properties of a WriteEvents.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
eventStreamId |
string | WriteEvents eventStreamId. | |
expectedVersion |
number | WriteEvents expectedVersion. | |
events |
Array.<EventStore.Client.Messages.NewEvent$Properties> |
<optional> |
WriteEvents events. |
requireMaster |
boolean | WriteEvents requireMaster. |
- Source:
WriteEventsCompleted$Properties
Properties of a WriteEventsCompleted.
Type:
- Object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
result |
EventStore.Client.Messages.OperationResult | WriteEventsCompleted result. | |
message |
string |
<optional> |
WriteEventsCompleted message. |
firstEventNumber |
number | WriteEventsCompleted firstEventNumber. | |
lastEventNumber |
number | WriteEventsCompleted lastEventNumber. | |
preparePosition |
number | Long |
<optional> |
WriteEventsCompleted preparePosition. |
commitPosition |
number | Long |
<optional> |
WriteEventsCompleted commitPosition. |
- Source: