directus library
Directus SDK that provides all needed APIs for using Directus server
It provides APIs for reading, creating, updating and deleting user and system data, authentication, and access to activity.
final sdk = await Directus('http://localhost:8055').init();
Classes
- Directus
- DirectusActivity
- DirectusCollection
- DirectusCore
- DirectusCoreSingleton
- DirectusField
- DirectusFile
- DirectusFolder
-
DirectusListResponse<
T> - Directus response object when data is List.
- DirectusPermission
- DirectusPreset
- DirectusRelation
-
DirectusResponse<
T> - Wrapper around data that is returned from API.
- DirectusRevision
- DirectusRole
- DirectusSettings
- DirectusStorage
-
Interface that any custom storage must fulfill to use
their storage for storing directus internal data.
SDK uses
shared_preferences
by default. If user wants something more secure, store remotely on some server, write to file, or to use other DB engine, user needs to implement all methods. - DirectusUser
- Filter
- Used for filtering data
- Filters
- Object used for filtering items from collection.
-
ItemsConverter<
T> - Used for getting objects from and to Map.
- MemoryStorage
- MemoryStorage is mainly used for testing
- Meta
- What metadata response should return.
- OneQuery
-
All options that can be passed to some of
ItemsHandler
methods. - Query
-
All options that can be passed to and
ItemsHandler.readMany
. - ResponseMeta
- Response metadata
- Use shared preferences as storage engine
Enums
- DirectusThumbnailFit
- Fit of the thumbnail
- DirectusThumbnailFormat
- File format to return the thumbnail in
Exceptions / Errors
- DirectusError
- Error that any exception inside SDK will throw.