Published 2024-03-27
Fork of merged appwrite and dart_appwrite projects.
appwrite merged into dart_appwrite, resulting in project tp_appwrite.Client now has setKey (optional api key):Client but you have capability to call admin stuff.isAdminClient that returns true when an api key was given.Now we have a single source for our models: tp_appwrite::User and not appwrite::User and dart_appwrite::User.
appwrite and dart_appwrite in a single project: data models are from different sources, causing confusion and constant prefixing them.swagger service definition to generate classes: succeeded in generating an api, but did not have a proper client that was capable of websockets (rest only), and no difference between browser and desktop http-client.Client instances.
Client with an api key (setKey) (for security reasons). And if you do, check if there is an active user session with proper privileges.get_it scope to hide the admin Client instance from userland?appwrite home-page, but with our specialized customizations?Storage::listBuckets is an admin function, while Storage::listFiles is not.storageId as a non-admin user from a Bucket without know id?
This SDK is compatible with Appwrite server version 0.15.x. For older versions, please check previous releases.
This is the Dart SDK for integrating with Appwrite from your Dart server-side code. If you're looking for the Flutter SDK you should check appwrite/sdk-for-flutter
Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Dart SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to https://appwrite.io/docs
Add this to your package's pubspec.yaml file:
dependencies:
dart_appwrite: ^6.0.0
You can install packages from the command line:
pub get dart_appwrite
Once you add the dependencies, its extremely easy to get started with the SDK; All you need to do is import the package in your code, set your Appwrite credentials, and start making API calls. Below is a simple example:
import 'package:dart_appwrite/dart_appwrite.dart';
void main() async {
Client client = Client()
.setEndpoint('http://[HOSTNAME_OR_IP]/v1') // Make sure your endpoint is accessible
.setProject('5ff3379a01d25') // Your project ID
.setKey('cd868c7af8bdc893b4...93b7535db89')
.setSelfSigned(); // Use only on dev mode with a self-signed SSL cert
Users users = Users(client);
try {
final response = await users.create(userId: '[USER_ID]', email: ‘email@example.com’,password: ‘password’, name: ‘name’);
print(response.data);
} on AppwriteException catch(e) {
print(e.message);
}
}
The Appwrite Dart SDK raises AppwriteException object with message, code and response properties. You can handle any errors by catching AppwriteException and present the message to the user or handle it yourself based on the provided error information. Below is an example.
Users users = Users(client);
try {
final response = await users.create(userId: '[USER_ID]', email: ‘email@example.com’,password: ‘password’, name: ‘name’);
print(response.data);
} on AppwriteException catch(e) {
//show message to user or do other operation based on error as required
print(e.message);
}
You can use the following resources to learn more and get help
This library is auto-generated by Appwrite custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide before sending a pull-request.
Please see the BSD-3-Clause license file for more information.
env to runtime in the Functions APItoString() to get proper error message for unhandled exceptionsMultipartFile has changed as we have dropped Dio in favor of http package. Here is the new signature for MultipartFileResponse has changed, now it only exposes the data.Response objectcreateFile function expects Bucket ID as the first parametercreateDeployment and createFile functions expect an instance InputFile rather than the instance of MultipartFilelist<Entity> endpoints now contain a total attribute instead of sumonProgress() callback function for endpoints supporting file uploadsaccount.delete() -> account.updateStatus()stdout renamed to responsename renamed to userName and email renamed to userEmailteamName to Membership modelusers.getMemberships functionDatabase -> Databasesaccount.createSession() -> account.createEmailSession()dateCreated attribute removed from Team, Execution, File modelsdateCreated and dateUpdated attribute removed from Func, Deployment, Bucket modelsappwrite to dart_appwrite.