etebase_flutter library
Classes
- Account
- The main object for all user interactions and data manipulation, representing an authenticated user account.
- Cache
- A caching helper that allows you to easily save and restore items and collections on the end device.
- Client
- The network client to use to interact with the Etebase server.
- Collection
- A collection of Items.
- CollectionInvitationManager
- An manager for managing user invitations to Collections.
- CollectionManager
- A manager for managing Collection operations like creation and fetching.
- CollectionMember
- A member of a collection.
- CollectionMemberManager
- A manager for managing the members of a Collection.
- CryptoExecutor
- Defines an service that can run cryptographic operations synchronously and asynchronously, using whatever execution model is preferred.
- DateTimeMillisConverter
- A custom converter for converter DateTime objects from and to JSON as milliseconds. They are counted from the start of the epoch in UTC.
- FlutterClient
- The network client to use to interact with the Etebase server.
- HttpErrorContent
- An error message as received from the server.
- HttpFieldError
- An error for a specific field in case a field failed server validation.
- Item
- Items belong to Collections and are where data is stored.
- ItemManager
- A manager for managing Item operations like creation and fetching.
- ItemMetadata
- Metadata of the item.
-
ListResponse<
T extends Object> - The response of fetching a list.
- RemovedCollection
- A collection for which the user lost access.
- SignedInvitation
- A signed invitation to join a collection.
- User
- A user object.
- UserProfile
- A user's public profile.
Enums
- CollectionAccessLevel
- The access level to a collection.
- PrefetchOption
-
Dictates how much data to prefetch when passed to
FetchOptionsBase.
Extensions
- ItemMetadataCopyWithX on ItemMetadata
- Helper extension to be able to call copyWith on ItemMetadata without making the method part of the interface
- ItemMetadataExtensions on T
- Extension on ItemMetadata to get and set Color values directly.
Constants
- dateTimeMillis → const DateTimeMillisConverter
- A custom converter for converter DateTime objects from and to JSON as milliseconds. They are counted from the start of the epoch in UTC.
Functions
-
flutterItemMetadata(
{required Color color, String? description, DateTime? mtime, String? name, String? itemType, bool? withAlpha}) → ItemMetadata -
Helper factory to create ItemMetadata with a
colorvalue that is a Color
Typedefs
-
AsyncCallback<
T> = T Function(SodiumSumo sodium, List< SecureKey> secureKeys, List<KeyPair> keyPairs) - A callback for a asynchronous cryptographic operations.
- ContentProgressCallback = void Function(int current, int total)
- A callback to receive progress for when an items content is uploaded or downloaded separately.
-
ItemMetadataCopyWith
= $ItemMetadataImplCopyWith<
ItemMetadata> - The type definition of the ItemMetadataCopyWithX.copyWith method
-
MetaFromJson<
TMeta extends ItemMetadata> = TMeta Function(Map< String, dynamic> json) -
A callback that takes a
jsonmap and returns an instance of a type that implements ItemMetadata. -
SyncCallback<
T> = T Function(SodiumSumo sodium) - A callback for a synchronous cryptographic operations.
Exceptions / Errors
- ApiMissuse
- API missuses.
- AsyncCryptoExecutorIsolateFailure
- A wrapper exception type for error that occur on the background isolate of the CryptoExecutor.async.
- Conflict
- A conflict between local and remote changes has been detected.
- ConnectionProblem
- There was an issue with the connection (e.g. DNS lookup)
- CryptoFailure
- An issue with the encryption/decryption or other cryptographic operations.
- EtebaseException
- A base class for all etebase related exceptions.
- HttpFailure
- A http error occurred.
- IntegrityCompromised
- The integrity of the data was compromised.
- InvalidMessagePackData
- Required content of an item is missing.
- MissingContent
- Required content of an item is missing.
- NotFound
- The resource was not found on the server.
- PermissionDenied
- Access to the resource has not been granted.
- ServerProblem
- A permanent server error occurred.
- TemporaryServerProblem
- A temporary server error occurred.
- Authorization is required to access the resource.
- WebsocketClosed
- A websocket connection was closed with an unexpected reason