https://github.com/m1ga/ti.appwrite

Titanium Android module for Appwrite.io
https://github.com/m1ga/ti.appwrite

android appwrite titanium titanium-mobile titanium-module

Last synced: about 1 month ago
JSON representation

Titanium Android module for Appwrite.io

• Host: GitHub
• URL: https://github.com/m1ga/ti.appwrite
• Owner: m1ga
• License: mit
• Created: 2021-10-02T20:23:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-19T11:52:32.000Z (over 2 years ago)
• Last Synced: 2024-06-07T09:35:52.699Z (3 months ago)
• Topics: android, appwrite, titanium, titanium-mobile, titanium-module
• Language: Java
• Homepage:
• Size: 85 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-appwrite - Appwrite Appcelerator Titanium SDK

README

        
# Titanium module for Appwrite



Titanium Android module using [Appwrite's Android SDK](https://github.com/appwrite/sdk-for-android)

## What is Appwrite:

> 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 Android 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

## Installation

* create and run an Appwrite docker machine: https://appwrite.io/docs/installation

* download `ti.appwrite` module

* add `ti.appwrite` to your `tiapp.xml`

* add the following section to your `` section:

```xml

	

		

			

			

			

			

		

	

```

## Appwrite setup

Start the docker machine and create a new project. Make sure to add an `Android platform` with your package name. Under `Settings` you will find the `Project ID`.

## Titanium setup

```js

var appwrite = require("ti.appwrite");

appwrite.create({

	endpoint: SERVER_URL,

	project: PROJECT_ID,

	selfSigned: true,

	channels: ["files", "account"]

});

```

Full example: [app.js](example/app.js)


Full tutorial at: [from zero to app: Appwrite + Titanium: A step by step guide](https://fromzerotoapp.com/appwrite-appcelerator-titanium-a-step-by-step-guide/)

## Methods

* create()

* checkConnection()

* createAccount()

* deleteAccount()

* createSession()

* getAccount()

* getDocuments()

* getDocument()

* deleteDocument()

* createDocument({})

* subscribe([])

* unsubscribe([])

* createFile({file, read[], write[]})

* listFiles();

* getFile(id)

* getPreview({id:string, width?:int, height?:int, quality?:int})

* downloadFile(id)

* deleteFile(id);

## Events

* account

* error: action, message, code, response

* realtimeEvent

* database: e.documents for list

* storage: e.blob for file download, e.files for file list

* connection: status (true/false)

## Author

* Michael Gangolf (@MichaelGangolf / Web)