EventStorePersistentSubscriptionsClient class

Class implementing the Persistent Subscriptions API

Utility class for persistent subscriptions

persistent subscriptions

Persistent Subscriptions API

Inheritance
Mixed in types

Properties

api → Versions
Get api versions. If verify is not invoked, Versions.server is null.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isGrpcWeb → bool
True if this client is using grpc-web protocol
finalinherited
leader → EndPoint
Get EndPoint for last known leader node. If connecting to a single node, this returns EventStoreClientSettings.singleNode.
no setterinherited
options → CallOptions?
GRPC CallOptions instance
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
settings → EventStoreClientSettings
Connection name supplied as metadata to server
finalinherited
supportsClientStreamingRpc → bool
Check if grpc protocol supports client streaming See https://github.com/grpc/grpc-web/blob/master/doc/interop-test-descriptions.md
no setterinherited

Methods

$createChannel(EndPoint endPoint) → GrpcOrGrpcWebClientChannel
inherited
$getClient() → Future<PersistentSubscriptionsClient>
inherited
create(String streamId, String groupName, {int bufferSize = 10, UserCredentials? userCredentials, PersistentSubscriptionSettings? settings, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Creates a filtered persistent subscription groupName on given stream.
inherited
createToAll(String groupName, {UserCredentials? userCredentials, PersistentSubscriptionSettings? settings, SubscriptionFilterOptions? filterOptions, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Creates a filtered persistent subscription to SystemStreams.AllStream.
inherited
delete(String streamId, String groupName, {UserCredentials? userCredentials}) → Future<void>
Deletes a persistent subscription.
inherited
deleteToAll(String groupName, {UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Deletes a persistent subscription to SystemStreams.AllStream.
inherited
discover() → Future<EndPoint>
Discover node EndPoint given current EventStoreClientSettings.nodePreference.
inherited
isAllStreamSupported() → bool
Check if persistent subscription on SystemStreams.AllStream is supported by EventStoreClientSettings.apiVersion in current settings.
inherited
isFeatureSupported(ApiFeature feature) → bool
Check if given feature is supported by api.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
readParked(String streamId, String groupName, {int? maxCount, bool forward = true, bool resolveLinks = true, StreamPosition? position, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<ReadEventsResult>
Get parked ResolveEvents.
inherited
readParkedFromAll(String groupName, {int? maxCount, bool forward = true, bool resolveLinks = true, StreamPosition? position, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<ReadEventsResult>
Get parked ResolveEvents from SystemStreams.AllStream
inherited
replay(String streamId, String groupName, {int? stopAt, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Replay the parked messages for given subscription.
inherited
replayFromAll(String groupName, {int? stopAt, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Replay the parked messages for given subscription on SystemStreams.AllStream
inherited
shutdown() → Future<void>
Shutdown all channels
inherited
subscribe(String streamId, String groupName, {int bufferSize = 10, bool autoAck = true, UserCredentials? userCredentials, SubscriptionDroppedCallback? onSubscriptionDropped, EventStoreClientOperationOptions? operationOptions, PersistentSubscriptionResolvedEventCallback? onEventAppeared}) → Future<PersistentSubscription>
Subscribes to ResolvedEvents from a persistent subscription.
inherited
subscribeToAll(String groupName, {int bufferSize = 10, bool autoAck = true, UserCredentials? userCredentials, SubscriptionDroppedCallback? onSubscriptionDropped, EventStoreClientOperationOptions? operationOptions, PersistentSubscriptionResolvedEventCallback? onEventAppeared}) → Future<PersistentSubscription>
Subscribe to ResolvedEvents in SystemStreams.AllStream.
inherited
subscribeToParked(String streamId, String groupName, {Position? position, bool resolveLinks = false, UserCredentials? userCredentials, SubscriptionResolvedEventCallback? onEventAppeared, SubscriptionDroppedCallback? onSubscriptionDropped, EventStoreClientOperationOptions? operationOptions}) → Future<EventStreamSubscription>
Subscribe to parked ResolveEvents.
inherited
subscribeToParkedFromAll(String groupName, {Position? position, bool resolveLinks = false, UserCredentials? userCredentials, SubscriptionResolvedEventCallback? onEventAppeared, SubscriptionDroppedCallback? onSubscriptionDropped, EventStoreClientOperationOptions? operationOptions}) → Future<EventStreamSubscription>
Subscribe to parked ResolveEvents from SystemStreams.AllStream
inherited
toString() → String
A string representation of this object.
inherited
update(String streamId, String groupName, {int bufferSize = 10, UserCredentials? userCredentials, PersistentSubscriptionSettings? settings, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Updates a filtered persistent subscription groupName on given stream.
inherited
updateToAll(String groupName, {int bufferSize = 10, UserCredentials? userCredentials, PersistentSubscriptionSettings? settings, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Updates a filtered persistent subscription to SystemStreams.AllStream.
inherited
verify() → Future<void>
Verify that EventStoreClientSettings.apiVersion is compatible with server version. Throws a UnsupportedApiVersionException if MemberInfo.apiVersion is incompatible with requested EventStoreClientSettings.apiVersion.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

ExceptionMap ↔ Map<String, GrpcErrorCallback>
Converts GrpcErrors to typed Exceptions
getter/setter pair
Requests → ClientRequestInterceptor
Track
final

Constants

UPDATE_DOES_NOT_EXIST → const String