at_client
library
Classes
AtBuffer <T >
Class holder for message of different data types(int, String etc.,)
AtChainedException
AtClient
Interface for a client application that can communicate with a secondary server.
AtClientImpl
Implementation of AtClient interface and AtSignChangeListener interface
AtClientManager
Factory class for creating AtClient , SyncService and NotificationService instances
AtClientPreference
Class to hold attributes for client preferences.
Set the preferences for your application and pass it to AtClientManager.setCurrentAtSign .
AtClientTelemetryConsumer
AtClientTelemetryService
Telemetry Service for an AtProtocol client (i.e. emitter of atProtocol verb commands)
AtClientUtil
AtCollectionModel <T >
AtCollectionModelFactory <T extends AtCollectionModel >
AtCollectionModelFactoryManager
AtConstants
AtExceptionManager
AtExceptionManager is responsible for creating instances of the appropriate exception
classes for a given exception scenario.
AtExceptionStack
Class to maintain stack of exceptions to form a chained exception.
AtExceptionUtils
Utility class that returns instance of exception for the given error code.
AtKey
AtKeyValidator
Validates String representation of a AtKey
For example String representation of a public key PublicKey will be public:phone.wavi@bob
AtKeyValidators
Returns an instance of AtKeyValidator
AtNotification
AtRpc
A simple rpc request-response abstraction which uses atProtocol
notifications under the hood.
AtRpcCallbacks
The callbacks which the creator of the AtRpc object needs to provide
AtRpcClient
AtRpcReq
Simple data structure whose JSON is transmitted as the payload of the
notification which is sent from the requester to the responder
AtRpcResp
Simple data structure whose JSON is transmitted as the payload of the
notification which is sent by the responder back to the requester
AtServiceFactory
AtTelemetryEvent
Concrete AtTelemetryItem subclass for Events - e.g. SyncStarted, NetworkUnavailable, MonitorUnavailable
AtTelemetryItem
Generic telemetry datum
AtTelemetrySample
Concrete AtTelemetryItem subclass for Samples - e.g. KeyStoreSize, DataReceived, DataTransmitted
AtTelemetryService
Simple software telemetry service. See https://en.wikipedia.org/wiki/Telemetry#Software
AtValue
BatchRequest
BatchResponse
ByteBuffer
ConflictInfo
ConnectivityListener
@Deprecated Will be removed in a future release. Please use a connectivity checker of your own choice in your application code
DefaultAtServiceFactory
DeleteRequestOptions
Parameters that application code can optionally provide when calling
AtClient.delete
EncryptionUtil
EnrollParams
GetRequestOptions
Parameters that application code can optionally provide when calling
AtClient.get
IterableKeyStream <T >
Class to expose a stream of Iterable<AtKey> based on the provided query parameters
KeyFormatValidation
Validates if the Key adheres to a format represented by a regex
KeyInfo
KeyLengthValidation
Validates key length of a key
KeyOwnershipValidation
Validates if the ownership is right for a given key type
KeyShareValidation
Validates if key is rightly shared
KeyStream <T >
Class to expose a stream of AtKey based on the provided query parameters
ListKeyStream <T >
Class to expose a stream of List<AtKey> based on the provided query parameters
LocalKey
Represents a local key
Local key are confined to the client(device)/server it is created.
The key does not sync between the local-secondary and the cloud-secondary.
LocalSecondary
Contains methods to execute verb on local secondary storage using executeVerb
Set AtClientPreference.isLocalStoreRequired to true and other preferences that your app needs.
Delete and Update commands will be synced to the server
MapKeyStream <K , V >
Class to expose a stream of Map<AtKey> based on the provided query parameters
Metadata
NotificationConfig
The configurations for the Notification listeners
NotificationParams
NotificationParams represents a notification input params.
NotificationResult
NotificationResult encapsulates the notification response
NotificationService
PrivateKey
Obsolete, was never used
PublicKey
Represents a public key.
PublicKeyHash
Represents hash of an atsign's public encryption key and the hashing algorithm used
PutRequestOptions
Parameters that application code can optionally provide when calling
AtClient.put
RemoteSecondary
Contains methods used to execute verbs on remote secondary server of the atSign.
RequestOptions
Parameters that application code can optionally provide when calling
AtClient.get, AtClient.put and AtClient.delete methods
ReservedEntityValidation
Verifies if the key belongs to reserved key list.
ResolutionContext
Response
SecureSocketConfig
class to store configuration to create a security context while creating secure sockets
SelfKey
Represents a Self key.
SetKeyStream <T >
Class to expose a stream of Set<AtKey> based on the provided query parameters
SharedKey
Represents a key shared to another atSign.
StringBuffer
SyncEntry
SyncProgress
SyncProgressListener
SyncResult
Class to represent sync response.
SyncService
SyncTelemetryEvent
Tuple <T1 , T2 >
UpdateParams
Validation
Implement a validation on a key
ValidationContext
Represents context of a validation
See AtKeyValidator
ValidationResult
Represents outcome of a key validation
See AtKeyValidator and AtConcreteKeyValidator
VerbSyntax
VerbUtil
