UsersServiceClient class

The UsersService manages the full lifecycle of users. It provides standard CRUD operations alongside a robust state machine for verification, manager approval, and completion.

Annotations
  • @GrpcServiceName.new('Scailo.UsersService')

Constructors

UsersServiceClient(ClientChannel channel, {CallOptions? options, Iterable<ClientInterceptor>? interceptors})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

$createCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ClientCall<Q, R>
inherited
$createStreamingCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ResponseStream<R>
inherited
$createUnaryCall<Q, R>(ClientMethod<Q, R> method, Q request, {CallOptions? options}) → ResponseFuture<R>
inherited
approve(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Officially approves the record.
attachVaultFolder(VaultFolderAttachRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Attaches a specified folder directly to a record without requiring a full revision workflow.
commentAdd(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Adds an audit comment to the record's history without changing its current lifecycle status.
count(UsersServiceCountReq request, {CallOptions? options}) → ResponseFuture<CountResponse>
Returns the total count of records matching the given complex filter criteria.
countInStatus(CountInSLCStatusRequest request, {CallOptions? options}) → ResponseFuture<CountResponse>
Returns the total number of records currently in a specific lifecycle status.
create(UsersServiceCreateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Creates a new user and initiates the verification workflow.
createMagicLinkForSignature(MagicLinksServiceCreateRequestForSpecificResource request, {CallOptions? options}) → ResponseFuture<MagicLink>
Generates a secure, short-lived magic link allowing the user to securely upload their signature.
discard(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Permanently cancels the record.
downloadAsCSV(UsersServiceFilterReq request, {CallOptions? options}) → ResponseFuture<StandardFile>
CSV operations Download the CSV file that consists of the list of records according to the given filter request. The same file could also be used as a template for uploading records
draft(UsersServiceCreateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Saves a new user record as a draft without triggering side effects.
draftUpdate(UsersServiceUpdateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Updates an existing record that is currently in DRAFT status.
filter(UsersServiceFilterReq request, {CallOptions? options}) → ResponseFuture<UsersList>
Performs a high-granularity search based on multiple specific field filters.
halt(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Temporarily halts processing of the record.
identifyCroppedFace(StandardFile request, {CallOptions? options}) → ResponseFuture<User>
Performs biometric identification against a tightly pre-cropped image focusing solely on a single human face.
identifyFullFace(StandardFile request, {CallOptions? options}) → ResponseFuture<User>
Performs biometric identification against a standard or full-scale multi-context photograph.
importFromCSV(StandardFile request, {CallOptions? options}) → ResponseFuture<IdentifierUUIDsList>
Bulk imports records from a provided CSV file. Behavior:
mFAEnable(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<ImageResponse>
Enables Multi-Factor Authentication (MFA) for the specified user account.
mFAReset(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Disables and resets the Multi-Factor Authentication configuration for a user.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerMobileDevice(UsersServiceRegisterMobileDeviceRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Registers a user's mobile device to enable push notifications.
requestPasswordResetEmail(UsersServicePasswordResetReq request, {CallOptions? options}) → ResponseFuture<MagicLink>
Initiates the self-service password recovery workflow for a specific username.
restore(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Restores a previously DISCARDED or HALTED record.
revisionUpdate(UsersServiceUpdateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Updates a record that has been sent back for REVISION.
searchAll(UsersServiceSearchAllReq request, {CallOptions? options}) → ResponseFuture<UsersList>
Performs a free-text search across records using a search key.
sendForRevision(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Sends the record back to the creator for corrections.
sendForVerification(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Submits a record in DRAFT or REVISION status for verification.
toString() → String
A string representation of this object.
inherited
updateOwnPassword(UpdateOwnPasswordReq request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Allows the currently authenticated user to update their own account password.
updatePassword(UpdatePasswordReq request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Administrative override method to forcefully update a user's password.
updateProfilePicture(UploadPictureReq request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Updates the profile picture associated with the user account.
updateSignature(UploadPictureReq request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Updates the user's official signature resource.
verify(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>
Marks a record as verified, signaling that it is ready for final approval.
viewAll(ActiveStatus request, {CallOptions? options}) → ResponseFuture<UsersList>
Returns all records filtered by their active status.
viewAllForEntityUUID(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<UsersList>
Returns all records belonging to a specific organization/entity UUID.
viewBirthdaysOn(MonthAndDayFilter request, {CallOptions? options}) → ResponseFuture<UsersList>
Filters and returns all user records whose birthday falls on the specified month and day.
viewByCode(SimpleSearchReq request, {CallOptions? options}) → ResponseFuture<User>
Retrieves a single record via the assigned internal code.
viewByID(IdentifierZeroable request, {CallOptions? options}) → ResponseFuture<User>
View by ID (returns the entire information about the user, including the logs)
viewByUsername(SimpleSearchReq request, {CallOptions? options}) → ResponseFuture<User>
Retrieves a single user record utilizing their unique username.
viewByUUID(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<User>
View by UUID (logs aren't returned)
viewEssentialByID(Identifier request, {CallOptions? options}) → ResponseFuture<User>
Retrieves a record by ID excluding high-volume fields like logs for performance. This operation is optimized for high-performance internal system logic and backend-to-backend communication
viewEssentialByUUID(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<User>
Retrieves a record by UUID excluding high-volume fields like logs. This is intended for public-facing interfaces, since record identifiers aren't sequential and thus cannot be predicted.
viewFromIDs(IdentifiersList request, {CallOptions? options}) → ResponseFuture<UsersList>
View all users with the given IDs
viewFromUsernames(StringsList request, {CallOptions? options}) → ResponseFuture<UsersList>
Resolves and returns a collection of user records corresponding to an explicit list of usernames.
viewFromUUIDs(IdentifierUUIDsList request, {CallOptions? options}) → ResponseFuture<UsersList>
View all users with the given UUIDs
viewProfilePicture(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<ImageResponse>
Retrieves the primary full-resolution profile picture artifact mapped to the user UUID.
viewQRImage(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<ImageResponse>
Retrieves the user's unique identification QR Code rendered cleanly as an image asset.
viewQRString(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<StringResponse>
Retrieves the text payload or URL represented within the user's identification QR code.
viewSelf(Empty request, {CallOptions? options}) → ResponseFuture<User>
Retrieves the contextual profile details of the currently authenticated system caller.
viewSignature(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<Base64String>
Fetches the user's official signature rendered as a Base64 encoded string format.
viewThumbnailPicture(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<ImageResponse>
Retrieves the optimized, low-bandwidth thumbnail image variant of the user's profile picture.
viewVCard(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<ImageResponse>
Generates and returns a standard electronic business card (VCard) structure formatted as an image asset.
viewWithPagination(UsersServicePaginationReq request, {CallOptions? options}) → ResponseFuture<UsersServicePaginationResponse>
Retrieves a paginated list of records based on status, sort keys, and offsets.

Operators

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

Constants

defaultHost → const String
The hostname for this service.
oauthScopes → const List<String>
OAuth scopes needed for the client.