mirror of
https://github.com/appwrite/appwrite
synced 2026-05-24 09:28:40 +00:00
Merge pull request #3778 from appwrite/doc-swift-dir-fix
This commit is contained in:
Damodar Lohani
GitHub
commit
129c69ddac
5 changed files with 128 additions and 112 deletions
|
|
@ -53,30 +53,35 @@ For UIKit, you need to add the following function to your `SceneDelegate.swift`.
|
||||||
|
|
||||||
### Init your SDK
|
### Init your SDK
|
||||||
|
|
||||||
Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key project API keys section.
|
Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page.
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
import Appwrite
|
import Appwrite
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
let client = Client()
|
let client = Client()
|
||||||
.setEndpoint("http://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
|
.setEndpoint("http://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
|
||||||
.setProject("5df5acd0d48c2") // Your project ID
|
.setProject("5df5acd0d48c2") // Your project ID
|
||||||
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
|
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Make Your First Request
|
### Make Your First Request
|
||||||
|
|
||||||
Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.
|
Once your SDK object is initialized, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
let users = Users(client: client)
|
let account = Account(client)
|
||||||
users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in
|
|
||||||
switch result {
|
do {
|
||||||
case .failure(let error): print(error.message)
|
let account = try await account.create(
|
||||||
case .success(let user): print(String(describing: user))
|
userId: ID.unique(),
|
||||||
}
|
email: "email@example.com",
|
||||||
|
password: "password"
|
||||||
|
)
|
||||||
|
print(String(describing: account.toMap()))
|
||||||
|
} catch {
|
||||||
|
print(error.localizedDescription)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -87,37 +92,40 @@ import Appwrite
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
let client = Client()
|
let client = Client()
|
||||||
.setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
|
.setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
|
||||||
.setProject("5df5acd0d48c2") // Your project ID
|
.setProject("5df5acd0d48c2") // Your project ID
|
||||||
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
|
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
|
||||||
|
|
||||||
let users = Users(client: client)
|
let account = Account(client)
|
||||||
users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in
|
|
||||||
switch result {
|
do {
|
||||||
case .failure(let error): print(error.message)
|
let account = try await account.create(
|
||||||
case .success(let user): print(String(describing: user))
|
userId: ID.unique(),
|
||||||
}
|
email: "email@example.com",
|
||||||
|
password: "password"
|
||||||
|
)
|
||||||
|
print(String(describing: account.toMap()))
|
||||||
|
} catch {
|
||||||
|
print(error.localizedDescription)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Error Handling
|
### Error Handling
|
||||||
|
|
||||||
When an error occurs, the Appwrite Swift SDK responds with a result wrapping an `AppwriteError` object with `message` and `code` properties. You can handle any errors in the result's `.failure` case and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.
|
When an error occurs, the Appwrite Apple SDK throws an `AppwriteError` object with `message` and `code` properties. You can handle any errors in a catch block and present the `message` or `localizedDescription` to the user or handle it yourself based on the provided error information. Below is an example.
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
import Appwrite
|
import Appwrite
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
let users = Users(client: client)
|
let account = Account(client)
|
||||||
|
|
||||||
users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in
|
do {
|
||||||
switch result {
|
let account = try await account.get()
|
||||||
case .failure(let error):
|
print(String(describing: account.toMap()))
|
||||||
print(error.message)
|
} catch {
|
||||||
case .success(var response):
|
print(error.localizedDescription)
|
||||||
...
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
@ -1,83 +0,0 @@
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
### Init your SDK
|
|
||||||
|
|
||||||
Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key project API keys section.
|
|
||||||
|
|
||||||
```swift
|
|
||||||
import Appwrite
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
let client = Client()
|
|
||||||
.setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
|
|
||||||
.setProject("5df5acd0d48c2") // Your project ID
|
|
||||||
.setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
|
|
||||||
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Make Your First Request
|
|
||||||
|
|
||||||
Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.
|
|
||||||
|
|
||||||
```swift
|
|
||||||
let users = Users(client: client)
|
|
||||||
users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in
|
|
||||||
switch result {
|
|
||||||
case .failure(let error): print(error.message)
|
|
||||||
case .success(let user): print(String(describing: user))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Full Example
|
|
||||||
|
|
||||||
```swift
|
|
||||||
import Appwrite
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
let client = Client()
|
|
||||||
.setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
|
|
||||||
.setProject("5df5acd0d48c2") // Your project ID
|
|
||||||
.setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
|
|
||||||
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
|
|
||||||
|
|
||||||
let users = Users(client: client)
|
|
||||||
users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in
|
|
||||||
switch result {
|
|
||||||
case .failure(let error): print(error.message)
|
|
||||||
case .success(let user): print(String(describing: user))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Error Handling
|
|
||||||
|
|
||||||
When an error occurs, the Appwrite Swift SDK responds with a result wrapping an `AppwriteError` object with `message` and `code` properties. You can handle any errors in the result's `.failure` case and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.
|
|
||||||
|
|
||||||
```swift
|
|
||||||
import Appwrite
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
let users = Users(client: client)
|
|
||||||
|
|
||||||
users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in
|
|
||||||
switch result {
|
|
||||||
case .failure(let error):
|
|
||||||
print(error.message)
|
|
||||||
case .success(var response):
|
|
||||||
...
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Learn more
|
|
||||||
|
|
||||||
You can use the following resources to learn more and get help
|
|
||||||
|
|
||||||
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
|
|
||||||
- 📜 [Appwrite Docs](https://appwrite.io/docs)
|
|
||||||
- 💬 [Discord Community](https://appwrite.io/discord)
|
|
||||||
- 🚂 [Appwrite Swift Playground](https://github.com/appwrite/playground-for-swift-server)
|
|
||||||
91
docs/sdks/swift/GETTING_STARTED.md
Normal file
91
docs/sdks/swift/GETTING_STARTED.md
Normal file
|
|
@ -0,0 +1,91 @@
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
### Init your SDK
|
||||||
|
|
||||||
|
Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key project API keys section.
|
||||||
|
|
||||||
|
```swift
|
||||||
|
import Appwrite
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
let client = Client()
|
||||||
|
.setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
|
||||||
|
.setProject("5df5acd0d48c2") // Your project ID
|
||||||
|
.setKey("919c2d184...a2ae413dad2") // Your secret API key
|
||||||
|
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Make Your First Request
|
||||||
|
|
||||||
|
Once your SDK object is initialized, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.
|
||||||
|
|
||||||
|
```swift
|
||||||
|
let users = Users(client)
|
||||||
|
|
||||||
|
do {
|
||||||
|
let user = try await users.create(
|
||||||
|
userId: ID.unique(),
|
||||||
|
email: "email@example.com",
|
||||||
|
password: "password"
|
||||||
|
)
|
||||||
|
print(String(describing: user.toMap()))
|
||||||
|
} catch {
|
||||||
|
print(error.localizedDescription)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Full Example
|
||||||
|
|
||||||
|
```swift
|
||||||
|
import Appwrite
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
let client = Client()
|
||||||
|
.setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
|
||||||
|
.setProject("5df5acd0d48c2") // Your project ID
|
||||||
|
.setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
|
||||||
|
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
|
||||||
|
|
||||||
|
let users = Users(client)
|
||||||
|
|
||||||
|
do {
|
||||||
|
let user = try await users.create(
|
||||||
|
userId: ID.unique(),
|
||||||
|
email: "email@example.com",
|
||||||
|
password: "password"
|
||||||
|
)
|
||||||
|
print(String(describing: user.toMap()))
|
||||||
|
} catch {
|
||||||
|
print(error.localizedDescription)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Error Handling
|
||||||
|
|
||||||
|
When an error occurs, the Appwrite Swift SDK throws an `AppwriteError` object with `message` and `code` properties. You can handle any errors in a catch block and present the `message` or `localizedDescription` to the user or handle it yourself based on the provided error information. Below is an example.
|
||||||
|
|
||||||
|
```swift
|
||||||
|
import Appwrite
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
let users = Users(client)
|
||||||
|
|
||||||
|
do {
|
||||||
|
let users = try await users.list()
|
||||||
|
print(String(describing: users.toMap()))
|
||||||
|
} catch {
|
||||||
|
print(error.localizedDescription)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Learn more
|
||||||
|
|
||||||
|
You can use the following resources to learn more and get help
|
||||||
|
|
||||||
|
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
|
||||||
|
- 📜 [Appwrite Docs](https://appwrite.io/docs)
|
||||||
|
- 💬 [Discord Community](https://appwrite.io/discord)
|
||||||
|
- 🚂 [Appwrite Swift Playground](https://github.com/appwrite/playground-for-swift-server)
|
||||||
Loading…
Reference in a new issue