I needed a library that would use the new Dropbox API v2. Not finding any, I decided to create this module/document, which uses the Dropbox API v2 HTTP .
This module uses OAuth 2.0 authorization token flow, then you must first create a Dropbox App key. For each API method, it is available the complete documentation and a test. You can also consult the official documentation directly ;)
Enjoy
Vittorio Sorbera, AstrovicApps http://www.astrovicapps.com
- Download
- Requirements
- tiapp.xml
- Methods
- Example of use
- Screenshots
- Todos
- Guidelines for pull requests
- License
Download the latest release ZIP-file and consult the Titanium Documentation on how install it.
- The
ti.webdialogmodule - The
ti.deeplymodule (Android only) - Dropbox requires a redirect URI set to the Dropbox Console App, in order to get a valid token. This url is the same one you will use in the
redirectUriparameter of theTiDropbox.init()method. In this project I use the redirect URI https://astrovicapps.com/_apptest/tidropbox_cb.html. You will have to create your own and host it somewhere. You can use the contents of my tidropbox_cb.html file. You just need to replaceconst scheme = "dropbox";with the one used in you tiapp.xml:
<!-- tidropbox_cb.html file content --><html><head><metaname="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"><scripttype="text/javascript">constisAndroid=/(android)/i.test(navigator.userAgent);constisHuawei=/(huawei)/i.test(navigator.userAgent);consturlParams=newURLSearchParams(window.location.search);constcode=urlParams.get('code');constscheme="tidropbox";// <-- Must be the one used in the tiapp.xml public.mime-type string and android:scheme value, and in app_mime_scheme in TiDropbox.init()consthost="dropbox_token";varurl=scheme+"://"+host+"?"+(code||window.location.hash);varintent="intent://"+host+"?"+(code||window.location.hash)+"#Intent;scheme="+scheme+";action=android.intent.action.VIEW;end";console.log(window.location);console.log("isAndroid: --> ",isAndroid);console.log("isHuawei: --> ",isHuawei);setTimeout(function(){document.getElementById("token").href=isAndroid||isHuawei ? intent : url;//document.getElementById("write_token").innerText = isAndroid ? intent : url;if(isHuawei){window.location=intent;}else{window.location=isAndroid ? intent : url;}window.close();},100);functioncloseWindow(){window.close();}</script></head><body><divstyle="text-align:center;"><aid="token" href="" onclick="closeWindow()"><button>OPEN APP</button></a><!--p id="write_token"></p--></div></body></html>The login flow to obtain the token requires the use of the system browser. In order to get back to the app, you need to add an activity to your android manifest, which will be used by the ti.deeply module, and a public.mime-type string on iOS.
iOS public.mime-type key string, Android android:scheme value and app_mime_scheme value must be the ones you use in the tidropbox_cb.html redirect URI file:
| tidropbox_cb.html | tiapp.xml iOS | tiapp.xml Android | TiDropbox.init() |
|---|---|---|---|
scheme value | public.mime-type key string | android:scheme value | app_mime_scheme value |
<ios>
<enable-launch-screen-storyboard>true</enable-launch-screen-storyboard>
<use-app-thinning>true</use-app-thinning>
<plist> <key>UTExportedTypeDeclarations</key>
<array>
<dict> <key>UTTypeTagSpecification</key>
<dict>
<key>public.mime-type</key>
<string>tidropbox</string>
</dict>
</dict>
</array>
</plist>
</ios>
<androidxmlns:android="http://schemas.android.com/apk/res/android">
<manifestxmlns:android="http://schemas.android.com/apk/res/android" >
<application>
<!-- ti.dropbox required >>> -->
<activityandroid:name="ti.deeply.DeepLinkHandlerActivity"android:exported="true"android:noHistory="true"android:excludeFromRecents="true"android:launchMode="singleTask">
<intent-filter>
<actionandroid:name="android.intent.action.VIEW"/>
<categoryandroid:name="android.intent.category.DEFAULT"/>
<categoryandroid:name="android.intent.category.BROWSABLE"/>
<dataandroid:scheme="tidropbox"android:host="dropbox_token" />
</intent-filter> </activity>
<!-- <<< ti.dropbox required -->
</application>
</manifest>
</android>
<modules>
<moduleplatform="commonjs">ti.dropbox</module>
<module>ti.webdialog</module>
<moduleplatform="android"version="3.0.0">ti.deeply</module>
</modules>TiDropbox.init(parameters)
| Parameters | Type | Required | Description |
|---|---|---|---|
| APP_KEY | String | ✅ | App key in Dropbox Console App |
| APP_SECRET | String | ✅ | App secret in Dropbox Console App |
| redirectUri | String | ✅ | One of your OAuth2 Redirect URIs set to Dropbox Console App |
| response_type | String | ✅ | code or token. Token flow expires after 4 hours |
| app_mime_scheme | String | ✅ | App mime/scheme set to tiapp.xml and used inside your redirect URI page (https://../tidropbox_cb.html) to be able to get back to the app after login |
You need a Dropbox App key, and a redirectUri which must be configured on Redirect URIs field of your Dropbox App Settings, on OAuth 2 section.
varTiDropbox=require("ti.dropbox").TiDropbox;TiDropbox.init({APP_KEY: '<YOUR APP KEY HERE>',/*<YOUR APP KEY HERE>*/APP_SECRET: '<YOUR APP SECRET HERE>',/*<YOUR APP SECRET HERE>*/redirectUri: 'https://astrovicapps.com/_apptest/tidropbox_cb.html',/*<YOUR OAuth2 Redirect URI SET TO DROPBOX APP CONSOLE>*/response_type: "code",// "token" or "code". Token flow expires after 4 hours!app_mime_scheme: "tidropbox"// *<YOUR APP MIME SCHEME HERE SET TO TIAPP.XML>*/});TiDropbox.generateAuthUrl(callback)
| Callback parameters | Type | Description |
|---|---|---|
| success | Boolean | Response result |
| access_token | String | Access token key |
| msg | String | Description of the response result |
This allows you to generate a token to be able to invoke methods.
TiDropbox.generateAuthUrl(function(e){if(e.success){// I'm logged, now I can call any methodTitanium.UI.createAlertDialog({title: "AUTH SUCCESS",message: e.msg+"\n"+"Your access token is: "+e.access_token,buttonNames: ['OK']}).show();}else{Titanium.UI.createAlertDialog({title: "AUTH PROBLEM",message: e.msg,buttonNames: ['OK']}).show();};});TiDropbox.callMethod(parameters)
| Parameters | Type | Required | Description |
|---|---|---|---|
| methodStr | String | ✅ | Represent API target. It contains Dropbox's namespace and method name: "files/upload" or "sharing/share_folder" or more at /lib/dropboxAPIv2.js |
| paramsObj | Object | ✅ | Parameters object, depends on resource field |
| fileBin | Blob/null | ✅ | File to upload, depends on resource field |
| onSuccessCallback | Function | ✅ | Callback on succes |
| onErrorCallback | Function | ✅ | Callback on error |
| callMethodXhrObjCallback | Function | Return directly the TiDropbox.xhr object of the current TiDropbox.callMethod, so you can invoke all xhr methods you need: abort, onload, onsendstream, ecc.. |
After obtaining a valid token, you can call any method:
// Upload the a.txt file to my app's Dropbox home TiDropbox.callMethod({methodStr: "files/upload",paramsObj: {path: "/a.txt",mode: "add",autorename: true,mute: false},fileBin: Ti.Filesystem.getFile(Ti.Filesystem.resourcesDirectory,"a.txt").read(),onSuccessCallback: (xhr)=>{console.log("onSuccessCallback checkins response-> "+xhr.responseText);},onErrorCallback: (e)=>{console.error("onErrorCallback checkins response-> "+JSON.stringify(e));if(JSON.stringify(e).indexOf("invalid_access_token")!=-1){//The session has expired, I need a new token };// Do something... }},callMethodXhrObjCallback: (currentCallMethodXhr)=>{currentCallMethodXhr.onsendstream=function(e){if(e.progress){console.log(JSON.stringify('Upload progress --> '+(e.progress*100)+'%'));}}}});TiDropbox.revokeAccessToken(callback)
| Callback parameters | Type | Description |
|---|---|---|
| success | Boolean | Response result |
| access_token | String | Access token key |
| msg | String | Description of the response result |
Revoke the access token.
TiDropbox.revokeAccessToken(function(e){if(e.success){// Logout, do something...Titanium.UI.createAlertDialog({title: "REVOKE AUTH SUCCESS",message: e.msg,buttonNames: ['OK']}).show();}else{Titanium.UI.createAlertDialog({title: "REVOKE AUTH PROBLEM",message: e.msg,buttonNames: ['OK']}).show();};});That's all! :)
varTiDropbox=require("ti.dropbox").TiDropbox;TiDropbox.init({APP_KEY: '<YOUR APP KEY HERE>',/*<YOUR APP KEY HERE>*/APP_SECRET: '<YOUR APP SECRET HERE>',/*<YOUR APP SECRET HERE>*/redirectUri: 'https://astrovicapps.com/_apptest/tidropbox_cb.html',/*<YOUR OAuth2 Redirect URI SET TO DROPBOX APP CONSOLE>*/response_type: "code",// "token" or "code". Token flow expires after 4 hours!app_mime_scheme: "tidropbox"// *<YOUR APP MIME SCHEME HERE SET TO TIAPP.XML>*/});// Check if I have a tokenif(Ti.App.Properties.getString('DROPBOX_TOKENS',null)){login();}else{TiDropbox.revokeAccessToken(function(){// Logout, do something...});};functionlogin(){TiDropbox.generateAuthUrl(function(e){if(e.success){// I'm logged, now I can call any method (/lib/dropboxAPIv2.js)// For example, if I want upload a.txt file on Dropbox App root folderfileUpload();}else{Titanium.UI.createAlertDialog({title: "AUTH PROBLEM",message: e.msg,buttonNames: ['OK']}).show();};});};functionfileUpload(){TiDropbox.callMethod({methodStr: "files/upload",paramsObj: {path: "/a.txt",mode: "add",autorename: true,mute: false},fileBin: Ti.Filesystem.getFile(Ti.Filesystem.resourcesDirectory,"a.txt").read(),onSuccessCallback: onSuccessCallback,onErrorCallback: onErrorCallback,callMethodXhrObjCallback: callMethodXhrObjCallback});// callback functionsfunctiononSuccessCallback(xhr){Ti.API.info("onSuccessCallback checkins response-> "+xhr.responseText);Titanium.UI.createAlertDialog({title: "METHOD SUCCESS",message: xhr.responseText,buttonNames: ['OK']}).show();};functiononErrorCallback(e){Ti.API.info("onErrorCallback checkins response-> "+JSON.stringify(e));Titanium.UI.createAlertDialog({title: "METHOD FAILED",message: JSON.stringify(e),buttonNames: ['OK']}).show();if(JSON.stringify(e).indexOf("invalid_access_token")!=-1){//The session has expired, I need a new tokenTi.App.Properties.setString('DROPBOX_TOKENS',null);login();};};functioncallMethodXhrObjCallback(currentCallMethodXhr){currentCallMethodXhr.onsendstream=function(e){Ti.API.debug(JSON.stringify(e));if(e.progress){Ti.API.debug(JSON.stringify('Upload progress --> '+(e.progress*100)+'%'));}};};};varTiDropbox=require("ti.dropbox").TiDropbox;TiDropbox.init({APP_KEY: '<YOUR APP KEY HERE>',/*<YOUR APP KEY HERE>*/APP_SECRET: '<YOUR APP SECRET HERE>',/*<YOUR APP SECRET HERE>*/redirectUri: 'https://astrovicapps.com/_apptest/tidropbox_cb.html',/*<YOUR OAuth2 Redirect URI SET TO DROPBOX APP CONSOLE>*/response_type: "code",// "token" or "code". Token flow expires after 4 hours!app_mime_scheme: "tidropbox"// *<YOUR APP MIME SCHEME HERE SET TO TIAPP.XML>*/});// Check if I have a tokenif(Ti.App.Properties.getString('DROPBOX_TOKENS',null)){login();}else{TiDropbox.revokeAccessToken(function(){// Logout, do something...});};functionlogin(){TiDropbox.generateAuthUrl(function(){if(e.success){// I'm logged, now I can call any method (/lib/dropboxAPIv2.js)// For example, if I want download Prime_Numbers.txt file from Dropbox AppdownloadFile();}else{Titanium.UI.createAlertDialog({title: "AUTH PROBLEM",message: e.msg,buttonNames: ['OK']}).show();};});};functiondownloadFile(){TiDropbox.callMethod({methodStr: "files/download",paramsObj: {path: "/Homework/math/Prime_Numbers.txt"},fileBin: null,onSuccessCallback: onSuccessCallback,onErrorCallback: onErrorCallback,callMethodXhrObjCallback: callMethodXhrObjCallback});// callback functionsfunctiononSuccessCallback(xhr){Ti.API.debug("onSuccessCallback checkins response-> "+xhr.responseText);// Write downloaded data in a fileif(xhr.responseData){varfilePath=Titanium.Filesystem.applicationDataDirectory+"myDownloadedFile.txt";varf=Titanium.Filesystem.getFile(filePath);f.write(xhr.responseData);// I check if I saved the file properlysetTimeout(function(){Ti.API.debug(filePath+" exists? ---> "+file.exists());if(f.exists()){if(OS_IOS){Ti.UI.iOS.createDocumentViewer({url: filePath}).show();};}else{Titanium.UI.createAlertDialog({title: "DOWNLOAD FAILED",message: "Something went wrong in the file writing...",buttonNames: ['OK']}).show();};},1000);};};functiononErrorCallback(e){Ti.API.debug("onErrorCallback checkins response-> "+JSON.stringify(e));Titanium.UI.createAlertDialog({title: "METHOD FAILED",message: JSON.stringify(e),buttonNames: ['OK']}).show();if(JSON.stringify(e).indexOf("invalid_access_token")!=-1){//The session has expired, I need a new tokenTi.App.Properties.setString('DROPBOX_TOKENS',null);login();};};functioncallMethodXhrObjCallback(currentCallMethodXhr){currentCallMethodXhr.onsendstream=function(e){if(e.progress){console.log(JSON.stringify('Upload progress --> '+(e.progress*100)+'%'));}}}}Download and build this project to test other methods
- OAauth 2 code flow ✅ DONE!
Every contribution and pull requests are welcome! This repository is a module/document. So you can contribute both to the documentation, that to new versions of the module.
If you want to create a new module version, to edit or add new methods, do not edit the modules/ folder directly! But you have to delete modules/commonjs folder. You should edit the
source files in /lib folder instead.
After making your changes, to create a new version of the module you have to follow the following steps:
Increase the version number in package.json file, in the root folder.
Uses Titaniumifier to generate the zip module, with the command:
$ titaniumifier --in . --out ./distImport your new ti.dropbox-commonjs-x.x.x.zip module in the project. This will create the
modules/commonjsfolder you had removed earlier, with the new version of the module.
All done :) Now you can send your pull request.
Copyright (c) 2016-23 Vittorio Sorbera, AstrovicApps
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.