at_onboarding_flutter library

Classes

AppLocalizationDelegate
AtAuthService
AtAuthServiceImpl
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.
AtClientAuth
AtClientAuthenticator
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.
AtClientService
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
AtOnboarding
AtOnboardingConfig
AtOnboardingLocalizations
AtOnboardingResult
The result returned after onboard
AtOnboardingTheme
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
BackupKeyConstants
BackupKeyWidget
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
KeyChainManager
Service to manage keychain entries. This includes saving the encryption keys and secret to keychain
KeychainUtil
KeyFormatValidation
Validates if the Key adheres to a format represented by a regex
KeyInfo
KeyLengthValidation
Validates key length of a @sign
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
Represents a Private key.
PublicKey
Represents a public key.
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

Extensions

AtMessageExtension
NullCheck
Extending the String class to check null and empty.
NullOrEmptyCheck
Extending the String class to check null and empty.
ParseEncodingTypeToString
Parse EncodingType to String

Constants

error_codes → const Map
error_description → const Map

Exceptions / Errors

AtBufferOverFlowException
AtCertificateValidationException
Exception thrown when security certification validation on root or secondary server fails
AtClientException
AtConnectException
The class AtConnectException and its subclasses represent any issues that prevents an connection to the root or the secondary server
AtDecryptionException
AtEncryptionException
AtEnrollmentException
Exception thrown for enrollment related exceptions
AtException
The class AtException and its subclasses represents various exceptions that can arise while using the @ protocol.
AtInvalidEnrollmentException
Exception thrown when an Enrollment_id is expired or invalid
AtIOException
Exception thrown when there is any issue related to socket operations e.g read/write
AtKeyException
AtKeyNotFoundException
AtPrivateKeyNotFoundException
AtPublicKeyChangeException
AtPublicKeyNotFoundException
AtServerException
AtSigningException
Exception thrown for issues occurring during data signing or pkam signing operations.
AtSigningVerificationException
Exception thrown for issues occurring during data signing verification or pkam signing verification operations.
AtThrottleLimitExceeded
Exception thrown when the enrollment requests exceed the limit in the given time window
AtTimeoutException
Exception thrown when no response is received before the timeout duration
AtValueException
BlockedConnectionException
BufferOverFlowException
Exception thrown when data size passed to the socket is greater than configured buffer size
ConnectionInvalidException
Thrown when trying to perform a read/write on a connection which is invalid
HandShakeException
Exception thrown when from-pol handshake fails between two secondary servers
IllegalArgumentException
Exception thrown when any parameter in a verb command is invalid
InboundConnectionLimitException
Thrown when current server's inbound connection limit is reached
InternalServerError
Thrown for any unhandled server error
InternalServerException
Thrown for any unhandled server exception
InvalidAtKeyException
Exception thrown when a key is invalid
InvalidAtSignException
Exception thrown when an atsign name provided is invalid.
InvalidDataException
Exception thrown when data provided to a method is invalid.
InvalidPinException
InvalidRequestException
Exception thrown when request to secondary server is invalid
InvalidResponseException
Exception thrown when response from secondary server is invalid e.g invalid json format
InvalidSyntaxException
Exception thrown when an @ protocol verb has an invalid syntax.
KeyNotFoundException
Exception thrown when AtKey.key is not present in the keystore
LookupException
Thrown when lookup fails after handshake
OutBoundConnectionInvalidException
Thrown when trying to perform a read/write on an outbound connection which is invalid
OutboundConnectionLimitException
Thrown when current server's outbound connection limit is reached
RootServerConnectivityException
Exception thrown when there is an issue connecting to root server
SecondaryConnectException
Exception thrown when an atsign's secondary url cannot be reached or is unavailable Should this be extending AtConnectException?
SecondaryNotFoundException
Exception thrown when the requested atsign's secondary url is not present in Root server
SecondaryServerConnectivityException
Exception thrown when there is an issue connecting to secondary server
SelfKeyNotFoundException
ServerIsPausedException
Thrown when a request is received on a connection while the server is paused
SharedKeyNotFoundException
UnAuthenticatedException
Thrown when trying to perform a verb execution which requires authentication
UnAuthorizedException
Exception thrown when a client tries to execute a verb or establish a connection but doesn't have the required permissions