AtClient class abstract

Interface for a client application that can communicate with a secondary server.

Implementers

Constructors

AtClient()

Properties

atChops ↔ AtChops?
Set an instance of AtChops for data encryption and signing operations
getter/setter pair
atSign → Atsign
no setter
dataEvents → Stream<DataEvent>
Stream of DataEvents — DataUpdated for every successful local keystore mutation that passes through the update path, DataDeleted for every successful one that passes through the delete path. Subscribers see local app writes AND sync-applied remote changes via a single uniform stream. Internal-bookkeeping writes (e.g. putValue) intentionally do NOT emit — see the DataEvent dartdoc.
no setter
encryptionService → EncryptionService?
no setter
enrollmentId ↔ String?
Enrollment id for apkam enrolled clients
getter/setter pair
enrollmentService ↔ EnrollmentService?
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
isStopped → bool
Whether this client has been stopped via AtClientManager.
no setter
notificationService ↔ NotificationService
getter/setter pair
pendingEmissions → Future<void>
Resolves once every event currently in-flight on dataEvents has been delivered to all listeners. Useful for callers that just performed a write and want to observe the resulting event before continuing — await atClient.pendingEmissions gives "watch streams up-to-date" semantics without sync-emission's re-entrancy / listener-stalls-writer hazards.
no setter
persistenceBundle → AtPersistenceBundle?
The local persistence bundle backing this client, or null when local storage is not required or has not yet been initialised. Commit-log-free: persistenceBundle.keyValueStore.commitLog is always null on the client. Owned and torn down by the client; callers must not close it.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
syncService ↔ SyncService
getter/setter pair
telemetry ↔ AtTelemetryService?
getter/setter pair

Methods

collection<T>(String namespace, Duration defaultExpiration, {EventSource eventSource = EventSource.both, T fromJson(Map<String, dynamic>)?, String? typeTag, bool cleanupOrphansOnCreation = false}) → Future<AtCollection<T>>
Returns an AtCollection of CItems for the given namespace.
delete(AtKey key, {bool isDedicated = false, DeleteRequestOptions? deleteRequestOptions}) → Future<bool>
Delete the key from user's local secondary and syncs the delete to cloud secondary if client's sync preference is immediate. By default namespace that is used to create the AtClient instance will be appended to the key. phone@alice translates to phone.persona@alice where 'persona' is the namespace. If you want to ignoring the namespace set AtKey.metadata.namespaceAware to false.
downloadFile(String transferId, String sharedByAtSign, {String? downloadPath}) → Future<List<File>>
Downloads the list of files for a given transferId shared by sharedByAtSign Optionally you can pass downloadPath to download the files.
get(AtKey key, {bool isDedicated = false, GetRequestOptions? getRequestOptions}) → Future<AtValue>
Get the value of AtKey.key from user's cloud secondary if AtKey.sharedBy is set. Otherwise looks up the key from local secondary. If the key was stored with public access, set AtKey.metadata.isPublic to true. If the key was shared with another atSign set AtKey.sharedWith
getAtKeys({String? regex, String? sharedBy, String? sharedWith, bool showHiddenKeys = false, bool useRemoteAtServer = false}) → Future<List<AtKey>>
Get all the keys stored in user's secondary in AtKey format. If regex is specified only matching keys are returned. If sharedBy is specified, then gets the keys from sharedBy user shared with current atClient user. If sharedWith is specified, then gets the keys shared to sharedWith user from the current atClient user.
getCurrentAtSign() → String?
Note - this method name is misleading as 'current' implies the atSign could change - but an AtClient should only ever have one atSign.
getKeys({String? regex, String? sharedBy, String? sharedWith, bool showHiddenKeys = false, bool useRemoteAtServer = false}) → Future<List<String>>
Get all the keys stored in user's secondary in string format. If regex is specified only matching keys are returned. If sharedBy is specified, then gets the keys from sharedBy user shared with current atClient user. If sharedWith is specified, then gets the keys shared to sharedWith user from the current atClient user.
getLocalSecondary() → LocalSecondary?
getMeta(AtKey key) → Future<Metadata?>
Gets the metadata of AtKey.key
getOTP() → Future<AtResponse>
Returns an OTP (One-Time Password) from the secondary server.
getPreferences() → AtClientPreference?
getRemoteSecondary() → RemoteSecondary?
Returns a RemoteSecondary to communicate with user's cloud secondary server.
keyExists(AtKey key, bool? useRemoteAtServer) → Future<bool>
Does a key exist
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notify(AtKey key, String value, OperationEnum operation, {MessageTypeEnum? messageType, PriorityEnum? priority, StrategyEnum? strategy, int? latestN, String? notifier, bool isDedicated = false}) → Future<bool>
Notifies the AtKey with the sharedWith user of the atsign. Optionally, operation, value and metadata can be set along with key to notify.
notifyAll(AtKey atKey, String value, OperationEnum operation) → Future<String>
Notifies the AtKey with the list of sharedWith user's of the atsign. Optionally, operation, value and metadata can be set along with the key to notify.
notifyChange(NotificationParams notificationParams) → Future<String?>
Notifies the NotificationParams.atKey to notificationParams.atKey.sharedWith user of the atSign. Optionally, operation, value and metadata can be set along with key to notify.
notifyList({String? fromDate, String? toDate, String? regex}) → Future<String>
Returns the list of received notifications of an atsign, Optionally, notifications can be filtered on from date, to date and regular expression
notifyStatus(String notificationId) → Future<String>
Returns the status of the notification
put(AtKey key, dynamic value, {bool isDedicated = false, PutRequestOptions? putRequestOptions}) → Future<bool>
Updates value of AtKey.key is if it is already present. Otherwise creates a new key. Set AtKey.sharedWith if the key has to be shared with another atSign. Set AtKey.metadata.isBinary if you are updating binary value e.g image,file. By default namespace that is used to create the AtClient instance will be appended to the key. phone@alice will be saved as phone.persona@alice where 'persona' is the namespace. If you want to save by ignoring the namespace set AtKey.metadata.namespaceAware to false. Additional metadata can be set using AtKey.metadata
putBinary(AtKey atKey, List<int> value, {PutRequestOptions? putRequestOptions}) → Future<AtResponse>
Used when storing binary data - e.g. images, files etc. See also AtClient.put and AtClient.putText
putMeta(AtKey key, {PutRequestOptions? putRequestOptions}) → Future<bool>
Updates the metadata of AtKey.key if it is already present. Otherwise creates a new key without a value. By default namespace that is used to create the AtClient instance will be appended to the key. phone@alice will be saved as phone.persona@alice where 'persona' is the namespace. If you want to save by ignoring the namespace set AtKey.metadata.namespaceAware to false.
putText(AtKey atKey, String value, {PutRequestOptions? putRequestOptions}) → Future<AtResponse>
Used to store the textual data into the keystore. Updates value of AtKey.key is if it is already present. Otherwise creates a new key. Set AtKey.sharedWith if the key has to be shared with another atSign. By default namespace that is used to create the AtClient instance will be appended to the key. phone@alice will be saved as phone.persona@alice where 'persona' is the namespace.
reuploadFiles(List<File> files, FileTransferObject fileTransferObject) → Future<List<FileStatus>>
re uploads file in fileTransferObject.fileUrl returns list of FileStatus which contains upload status of each file.
sendStreamAck(String streamId, String fileName, int fileLength, String senderAtSign, Function streamCompletionCallBack, Function streamReceiveCallBack) → Future<void>
Sends stream acknowledgement
setPreferences(AtClientPreference preference) → void
Sets the preferences such as sync strategy, storage path etc., for the client.
setSPP(String otp, {Duration? expiry}) → Future<AtResponse>
Sets a Semi Permanent Passcode (SPP) in the secondary server key-store. An SPP is a 6-character alphanumeric code used when submitting an enrollment request. Only connections with access to the "__manage" namespace are allowed to set an SPP.
shareFiles(List<String> sharedWithAtSigns, String key, String fileUrl, String encryptionKey, List<FileStatus> fileStatus, {DateTime? date}) → Future<Map<String, FileTransferObject>>
re sends file notifications to sharedWithAtSigns returns Map<String, FileTransferObject> which contains transfer status for each atsign.
startCompactionJob({Duration? commitLogCompactionDuration}) → Future<void>
No longer does anything; retained for source compatibility.
startMonitor(String privateKey, Function acceptStream, {String? regex}) → Future<void>
Creates a monitor connection to atSign's cloud secondary server.Whenever a notification is created on the server, monitor receives the notification on the client. Optionally a regular expression and be passed to filter the notifications deprecated Use NotificationService.subscribe
stop() → Future<void>
Stops all background services for this atSign: cancels the keystore-event timers, closes the data-event stream, and stops the sync and notification services and the remote secondary connection.
stopCompactionJob() → Future<void>
No longer does anything; retained for source compatibility.
stream(String sharedWith, String filePath, {String namespace}) → Future<AtStreamResponse>
Streams the file in filePath to sharedWith atSign.
toString() → String
A string representation of this object.
inherited
uploadFile(List<File> files, List<String> sharedWithAtSigns) → Future<Map<String, FileTransferObject>>
Uploads list of files to filebin and shares the file download url with sharedWithAtSigns returns map containing key of each sharedWithAtSign and value of FileTransferObject

Operators

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

Constants

defaultSppExpiry → const Duration