1
0
Fork 0
mirror of synced 2024-06-14 16:54:52 +12:00
appwrite/docs/sdks/dart/GETTING_STARTED.md

48 lines
1.9 KiB
Markdown
Raw Normal View History

2021-03-09 00:19:18 +13:00
## Getting Started
### Initialize & Make API Request
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:
```dart
import 'package:dart_appwrite/dart_appwrite.dart';
void main() async {
2022-05-24 20:02:39 +12:00
Client client = Client()
2021-03-11 17:42:07 +13:00
.setEndpoint('http://[HOSTNAME_OR_IP]/v1') // Make sure your endpoint is accessible
2021-03-09 00:19:18 +13:00
.setProject('5ff3379a01d25') // Your project ID
.setKey('cd868c7af8bdc893b4...93b7535db89')
2022-06-05 04:19:22 +12:00
.setSelfSigned(); // Use only on dev mode with a self-signed SSL cert
2021-03-10 14:36:25 +13:00
2021-03-09 00:19:18 +13:00
Users users = Users(client);
2021-03-10 14:36:25 +13:00
2021-03-11 17:42:07 +13:00
try {
2023-10-19 08:21:10 +13:00
final user = await users.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
2021-03-11 17:42:07 +13:00
} on AppwriteException catch(e) {
print(e.message);
}
2021-03-09 00:19:18 +13:00
}
2021-03-11 17:53:40 +13:00
```
2021-03-26 20:16:14 +13:00
### Error handling
2021-03-26 20:47:06 +13:00
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.
2021-03-26 20:16:14 +13:00
```dart
Users users = Users(client);
try {
2023-10-19 08:21:10 +13:00
final user = await users.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
2021-03-26 20:16:14 +13:00
} on AppwriteException catch(e) {
//show message to user or do other operation based on error as required
print(e.message);
}
```
2021-03-11 17:53:40 +13:00
### Learn more
2021-07-07 22:25:49 +12:00
You can use the following resources to learn more and get help
2021-03-15 16:23:24 +13:00
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
2021-03-14 17:29:55 +13:00
- 📜 [Appwrite Docs](https://appwrite.io/docs)
- 💬 [Discord Community](https://appwrite.io/discord)
2021-03-15 16:23:24 +13:00
- 🚂 [Appwrite Dart Playground](https://github.com/appwrite/playground-for-dart)