EventStoreUsersClient class

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<UsersClient>
inherited
changePassword({required String loginName, required String oldPassword, required String newPassword, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Change current password for user in EventStore with given loginName.
inherited
create({required String loginName, required String password, required String fullName, List<String> groups = const [], UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Create user in EventStore with given loginName.
inherited
delete({required String loginName, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Delete user in EventStore with given loginName.
inherited
disable({required String loginName, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Disable user in EventStore with given loginName.
inherited
discover() → Future<EndPoint>
Discover node EndPoint given current EventStoreClientSettings.nodePreference.
inherited
enable({required String loginName, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Enable user in EventStore with given loginName.
inherited
getAllUsers({UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<List<UserDetails>>
Gets the UserDetails of all internal users.
inherited
getCurrentUser({UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<UserDetails>
Gets the UserDetails of the internal user given by UserCredentials.username. If userCredentials is not provided, EventStoreClientSettings.defaultCredentials in settings is used. If UserCredentials.username is empty, an ArgumentOutOfRangeException is thrown.
inherited
getUser({required String loginName, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<UserDetails>
Gets the UserDetails of an internal user with given loginName.
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
resetPassword({required String loginName, required String newPassword, UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Resets password for user in EventStore with given loginName.
inherited
shutdown() → Future<void>
Shutdown all channels
inherited
toString() → String
A string representation of this object.
inherited
update({required String loginName, String? fullName, List<String> groups = const [], UserCredentials? userCredentials, EventStoreClientOperationOptions? operationOptions}) → Future<void>
Update user in EventStore with given loginName.
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