Merge pull request #1267 from appwrite/feat-android-support

Feat android support
2024-06-29 03:30:34 +12:00 · 2021-06-09 14:36:12 +03:00 · 2021-06-09 14:36:12 +03:00 · 11edc63a71
parent 2238097b3a 02e5d23669
commit 11edc63a71
3 changed files with 134 additions and 3 deletions
--- a/app/views/console/home/index.phtml
+++ b/app/views/console/home/index.phtml
@ -240,11 +240,11 @@ $usageStatsEnabled = $this->getParam('usageStatsEnabled',true);
            <li>
                <div class="link flutter-new"><img src="/images/clients/flutter.png?v=<?php echo APP_CACHE_BUSTER; ?>" alt="Flutter Platform Logo" class="avatar xxs margin-end-small" loading="lazy" /> New Flutter App &nbsp;<span class="text-size-tiny">(beta)</span></div>
            </li>
-            <li class="disabled">
-                <div class="link ios-new"><img src="/images/clients/ios.png?v=<?php echo APP_CACHE_BUSTER; ?>" alt="iOS Platform Logo" class="avatar xxs margin-end-small" loading="lazy" /> New iOS App <span class="text-fade text-size-small">(soon)</span></div>
+            <li>
+                <div class="link android-new"><img src="/images/clients/android.png?v=<?php echo APP_CACHE_BUSTER; ?>" alt="Android Platform Logo" class="avatar xxs margin-end-small" loading="lazy" /> New Android App</div>
            </li>
            <li class="disabled">
-                <div class="link android-new"><img src="/images/clients/android.png?v=<?php echo APP_CACHE_BUSTER; ?>" alt="Android Platform Logo" class="avatar xxs margin-end-small" loading="lazy" /> New Android App  <span class="text-fade text-size-small">(soon)</span></div>
+                <div class="link ios-new"><img src="/images/clients/ios.png?v=<?php echo APP_CACHE_BUSTER; ?>" alt="iOS Platform Logo" class="avatar xxs margin-end-small" loading="lazy" /> New iOS App <span class="text-fade text-size-small">(soon)</span></div>
            </li>
            <li class="disabled">
                <div class="link unity-new"><img src="/images/clients/unity.png?v=<?php echo APP_CACHE_BUSTER; ?>" alt="Unity Platform Logo" class="avatar xxs margin-end-small" loading="lazy" /> New Unity Game  <span class="text-fade text-size-small">(soon)</span></div>
@ -329,6 +329,42 @@ $usageStatsEnabled = $this->getParam('usageStatsEnabled',true);
    </form>
 </script>

+<div data-ui-modal class="modal box close" data-button-alias=".android-new">
+    <button type="button" class="close pull-end" data-ui-modal-close=""><i class="icon-cancel"></i></button>
+
+    <h1 class="margin-bottom-xl">Register your Android App</h1>
+
+    <form
+        data-analytics
+        data-analytics-activity
+        data-analytics-event="submit"
+        data-analytics-category="console"
+        data-analytics-label="Create Project Platform (Android)"
+        data-service="projects.createPlatform"
+        data-scope="console"
+        data-event="submit"
+        data-success="alert,trigger,reset"
+        data-success-param-alert-text="Registered new platform successfully"
+        data-success-param-trigger-events="projects.createPlatform"
+        data-failure="alert"
+        data-failure-param-alert-text="Failed to register platform"
+        data-failure-param-alert-classname="error">
+
+        <input type="hidden" name="projectId" data-ls-bind="{{router.params.project}}" />
+        <input type="hidden" name="type" data-ls-bind="android" />
+
+        <label for="name">Name <span class="tooltip large" data-tooltip="Choose any name that will help you distinguish between your different apps."><i class="icon-question"></i></span></label>
+        <input type="text" class="full-width" name="name" required autocomplete="off" placeholder="My Android App" maxlength="128" />
+
+        <label for="key">Package Name <span class="tooltip large" data-tooltip="Your package name is generally the applicationId in your app-level build.gradle file."><i class="icon-question"></i></span></label>
+        <input type="text" class="full-width" name="key" required autocomplete="off" placeholder="com.company.appname" />
+
+        <hr />
+
+        <button type="submit">Register</button> &nbsp; <button data-ui-modal-close="" type="button" class="reverse">Back</button>
+    </form>
+</div>
+
 <div data-ui-modal class="modal box close width-large" data-button-alias=".flutter-new">
    <button type="button" class="close pull-end" data-ui-modal-close=""><i class="icon-cancel"></i></button>

--- a/docs/sdks/android/CHANGELOG.md
+++ b/docs/sdks/android/CHANGELOG.md
@ -0,0 +1 @@
+# Change Log
--- a/docs/sdks/android/GETTING_STARTED.md
+++ b/docs/sdks/android/GETTING_STARTED.md
@ -0,0 +1,94 @@
+## Getting Started
+
+### Add your Android Platform
+To init your SDK and start interacting with Appwrite services, you need to add a new Flutter platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before, and click the 'Add Platform' button.
+
+From the options, choose to add a new **Flutter** platform and add your app credentials, ignoring iOS.
+
+Add your app <u>name</u> and <u>package name</u>, Your package name is generally the applicationId in your app-level build.gradle file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.
+
+### OAuth
+In order to capture the Appwrite OAuth callback url, the following activity needs to be added to your [AndroidManifest.xml](https://github.com/appwrite/playground-for-flutter/blob/master/android/app/src/main/AndroidManifest.xml). Be sure to relpace the **[PROJECT_ID]** string with your actual Appwrite project ID. You can find your Appwrite project ID in you project settings screen in your Appwrite console.
+
+```xml
+<manifest>
+    <application>
+        <activity android:name="io.appwrite.views.CallbackActivity" >
+            <intent-filter android:label="android_web_auth">
+                <action android:name="android.intent.action.VIEW" />
+                <category android:name="android.intent.category.DEFAULT" />
+                <category android:name="android.intent.category.BROWSABLE" />
+                <data android:scheme="appwrite-callback-[PROJECT_ID]" />
+            </intent-filter>
+        </activity>
+    </application>
+</manifest>
+```
+
+### Init your SDK
+
+<p>Initialize your SDK code with your project ID, which can be found in your project settings page.
+
+```kotlin
+import io.appwrite.Client
+import io.appwrite.services.Account
+
+val client = Client(context)
+  .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
+  .setProject("5df5acd0d48c2") // Your project ID
+  .setSelfSigned(true) // Remove in production
+```
+
+Before starting to send any API calls to your new Appwrite instance, make sure your Android emulators has network access to the Appwrite server hostname or IP address.
+
+When trying to connect to Appwrite from an emulator or a mobile device, localhost is the hostname for the device or emulator and not your local Appwrite instance. You should replace localhost with your private IP as the Appwrite endpoint's hostname. You can also use a service like [ngrok](https://ngrok.com/) to proxy the Appwrite API.
+
+### Make Your First Request
+
+<p>Once your SDK object is set, access any of the Appwrite services 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 section.
+
+```kotlin
+// Register User
+val account = Account(client)
+val response = account.create(
+    "email@example.com", 
+    "password"
+)
+```
+
+### Full Example
+
+```kotlin
+import io.appwrite.Client
+import io.appwrite.services.Account
+
+val client = Client(context)
+  .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
+  .setProject("5df5acd0d48c2") // Your project ID
+  .setSelfSigned(true) // Remove in production
+
+val account = Account(client)
+val response = account.create(
+    "email@example.com", 
+    "password"
+)
+```
+
+### Error Handling
+The Apopwrite Android 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 provided error information. Below is an example.
+
+```kotlin
+try {
+    var response = account.create("email@example.com", "password")
+    Log.d("Appwrite response", response.body?.string())
+} catch(e : AppwriteException) {
+    Log.e("AppwriteException",e.message.toString())
+}
+```
+
+### Learn more
+You can use followng resources to learn more and get help
+- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-android)
+- 📜 [Appwrite Docs](https://appwrite.io/docs)
+- 💬 [Discord Community](https://appwrite.io/discord)
+- - 🚂 [Appwrite Android Playground](https://github.com/appwrite/playground-for-android)