- Notifications
You must be signed in to change notification settings - Fork14
[READ-ONLY] Official Appwrite Kotlin SDK 💙🧡
License
appwrite/sdk-for-kotlin
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
This SDK is compatible with Appwrite server version 1.7.x. For older versions, please checkprevious releases.
This is the Kotlin SDK for integrating with Appwrite from your Kotlin server-side code. If you're looking for the Android SDK you should checkappwrite/sdk-for-android
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 Kotlin 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 tohttps://appwrite.io/docs
Appwrite's Kotlin SDK is hosted on Maven Central. In order to fetch the Appwrite SDK, add this to your root levelbuild.gradle(.kts)
file:
repositories { mavenCentral()}
If you would like to fetch our SNAPSHOT releases, you need to add the SNAPSHOT maven repository to yourbuild.gradle(.kts)
:
repositories { maven { url"https://s01.oss.sonatype.org/content/repositories/snapshots/" }}
Next, add the dependency to your project'sbuild.gradle(.kts)
file:
implementation("io.appwrite:sdk-for-kotlin:9.0.0")
Add this to your project'spom.xml
file:
<dependencies> <dependency> <groupId>io.appwrite</groupId> <artifactId>sdk-for-kotlin</artifactId> <version>9.0.0</version> </dependency></dependencies>
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.
importio.appwrite.Clientimportio.appwrite.services.Accountsuspendfunmain() {val client=Client(context) .setEndpoint("https://[HOSTNAME_OR_IP]/v1")// Your API Endpoint .setProject("5df5acd0d48c2")// Your project ID .setKey('919c2d18fb5d4...a2ae413da83346ad2')// Your secret API key .setSelfSigned(true)// Use only on dev mode with a self-signed SSL cert}
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 theAPI References section.
val users=Users(client)val user= users.create( user=ID.unique(), email="email@example.com", phone="+123456789", password="password", name="Walter O'Brien")
importio.appwrite.Clientimportio.appwrite.services.Usersimportio.appwrite.IDsuspendfunmain() {val client=Client(context) .setEndpoint("https://[HOSTNAME_OR_IP]/v1")// Your API Endpoint .setProject("5df5acd0d48c2")// Your project ID .setKey('919c2d18fb5d4...a2ae413da83346ad2')// Your secret API key .setSelfSigned(true)// Use only on dev mode with a self-signed SSL certval users=Users(client)val user= users.create( user=ID.unique(), email="email@example.com", phone="+123456789", password="password", name="Walter O'Brien" )}
The Appwrite Kotlin SDK raisesAppwriteException
object withmessage
,code
andresponse
properties. You can handle any errors by catchingAppwriteException
and present themessage
to the user or handle it yourself based on the provided error information. Below is an example.
importio.appwrite.Clientimportio.appwrite.IDimportio.appwrite.services.Userssuspendfunmain() {val users=Users(client)try {val user= users.create( user=ID.unique(), email="email@example.com", phone="+123456789", password="password", name="Walter O'Brien" ) }catch (e:AppwriteException) { e.printStackTrace() }}
You can use the following resources to learn more and get help
This library is auto-generated by Appwrite customSDK Generator. To learn more about how you can help us improve this SDK, please check thecontribution guide before sending a pull-request.
Please see theBSD-3-Clause license file for more information.
About
[READ-ONLY] Official Appwrite Kotlin SDK 💙🧡
Topics
Resources
License
Code of conduct
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.
Contributors11
Uh oh!
There was an error while loading.Please reload this page.