Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mix1009/flutterdropbox
Dropbox Client API for Flutter/Dart
https://github.com/mix1009/flutterdropbox
Last synced: 29 days ago
JSON representation
Dropbox Client API for Flutter/Dart
- Host: GitHub
- URL: https://github.com/mix1009/flutterdropbox
- Owner: mix1009
- License: mit
- Created: 2020-04-07T11:40:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-02T14:10:25.000Z (11 months ago)
- Last Synced: 2024-04-24T06:46:41.067Z (7 months ago)
- Language: Dart
- Homepage:
- Size: 136 KB
- Stars: 15
- Watchers: 5
- Forks: 27
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dropbox client
[](https://pub.dartlang.org/packages/dropbox_client)
A flutter plugin for accessing Dropbox.
## Setup
Register a Dropbox API app from https://www.dropbox.com/developers .
You need dropbox key and dropbox secret.
For Android, add below in AndroidManifest.xml (replace DROPBOXKEY with your key)
If you need more help setting up Android, please read https://github.com/dropbox/dropbox-sdk-java#setup .
For iOS,
1) add below in Info.plist
LSApplicationQueriesSchemes
dbapi-8-emm
dbapi-2
2) add below in Info.plist (replace DROPBOXKEY with your key)
CFBundleURLTypes
CFBundleURLSchemes
db-DROPBOXKEY
CFBundleURLName
3.a) If you are using Swift, add below code to AppDelegate.swift
import ObjectiveDropboxOfficial
// should be inside AppDelegate class
override func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
if let authResult = DBClientsManager.handleRedirectURL(url) {
if authResult.isSuccess() {
print("dropbox auth success")
} else if (authResult.isCancel()) {
print("dropbox auth cancel")
} else if (authResult.isError()) {
print("dropbox auth error \(authResult.errorDescription)")
}
}
return true
}
// if your are linked with ObjectiveDropboxOfficial 6.x use below code instead
override func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
DBClientsManager.handleRedirectURL(url, completion:{ (authResult) in
if let authResult = authResult {
if authResult.isSuccess() {
print("dropbox auth success")
} else if (authResult.isCancel()) {
print("dropbox auth cancel")
} else if (authResult.isError()) {
print("dropbox auth error \(authResult.errorDescription)")
}
}
});
return true
}
3.b) If you are using Objective C, add below code to AppDelegate.m
#import
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url
options:(NSDictionary *)options {
DBOAuthResult *authResult = [DBClientsManager handleRedirectURL:url];
if (authResult != nil) {
if ([authResult isSuccess]) {
NSLog(@"Success! User is logged into Dropbox.");
} else if ([authResult isCancel]) {
NSLog(@"Authorization flow was manually canceled by user!");
} else if ([authResult isError]) {
NSLog(@"Error: %@", authResult);
}
}
return NO;
}
// if your are linked with ObjectiveDropboxOfficial 6.x use below code instead
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url
options:(NSDictionary *)options {
BOOL result = [DBClientsManager handleRedirectURL:url completion: ^(DBOAuthResult *authResult) {
if (authResult != nil) {
if ([authResult isSuccess]) {
NSLog(@"Success! User is logged into Dropbox.");
} else if ([authResult isCancel]) {
NSLog(@"Authorization flow was manually canceled by user!");
} else if ([authResult isError]) {
NSLog(@"Error: %@", authResult);
}
}
}];
return NO;
}
4) Update Deployment Target to iOS 9.0 or above from Xcode. (dropbox_client 0.7.0 and above)
If you need more help setting up for iOS, please read https://github.com/dropbox/dropbox-sdk-obj-c#get-started .
## Usage
```
import 'package:dropbox_client/dropbox_client.dart';
Future initDropbox() async {
// init dropbox client. (call only once!)
await Dropbox.init(dropbox_clientId, dropbox_key, dropbox_secret);
}
```
```
// Legacy Authorization
String accessToken;
Future testLogin() async {
// this will run Dropbox app if possible, if not it will run authorization using a web browser.
await Dropbox.authorize();
}
Future getAccessToken() async {
accessToken = await Dropbox.getAccessToken();
}
Future loginWithAccessToken() async {
await Dropbox.authorizeWithAccessToken(accessToken);
}
Future testLogout() async {
// unlink removes authorization
await Dropbox.unlink();
}
```
```
// OAuth 2 code flow with PKCE that grants a short-lived token
String credentials;
Future testLogin() async {
// this will run Dropbox app if possible, if not it will run authorization using a web browser.
await Dropbox.authorizePKCE();
}
Future getCredentials() async {
credentials = await Dropbox.getCredentials();
}
Future loginWithCredentials() async {
await Dropbox.authorizeWithCredentials(credentials);
}
Future testLogout() async {
// unlink removes authorization
await Dropbox.unlink();
}
```
```
// List / Upload / Download
Future testListFolder() async {
final result = await Dropbox.listFolder(''); // list root folder
print(result);
final url = await Dropbox.getTemporaryLink('/file.txt');
print(url);
}
Future testUpload() async {
final filepath = '/path/to/local/file.txt';
final result = await Dropbox.upload(filepath, '/file.txt', (uploaded, total) {
print('progress $uploaded / $total');
});
}
Future testDownload() async {
final filepath = '/path/to/local/file.txt';
final result = await Dropbox.download('/dropbox_file.txt', filepath, (downloaded, total) {
print('progress $downloaded / $total');
});
}
```
Example can be found in example folder.