Skip to content

Commit

Permalink
Merge pull request #3 from ptkdev/master
Browse files Browse the repository at this point in the history
[Update] Permissions and fix code minor issue
  • Loading branch information
tavosansal committed Mar 15, 2018
2 parents 98e5632 + b84cc6d commit a2be644
Showing 1 changed file with 37 additions and 20 deletions.
57 changes: 37 additions & 20 deletions README.md
Expand Up @@ -10,58 +10,75 @@ Note: Photo Library only available in iOS 8+
cordova plugin add https://github.com/CoSchedule/cordova-photo-library.git
```

Permissions (iOS)
------
Add PhotoLibrary Permission to plist file in `/platforms/ios/[APP NAME]/[APP NAME]-info.plist`
```
<key>NSPhotoLibraryUsageDescription</key>
<string>why app use permission</string>
```

Permissions (Android)
------
Add write permission to AndroidManifest.xml file in `/platforms/android/app/src/main/AndroidManifest.xml`
```
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
```

Methods
------

- Image from Image
```
const options = {
imgElm: //required,
albumName: //optional,
}
imgElm: "file://localhost/test.jpg", //required
albumName: "test" //optional
};
cordova.plugins.PhotoLibrary.imageFromImage(options, callback, errback) // imgElm must have been loaded
cordova.plugins.PhotoLibrary.imageFromImage(options, callback, errback); // imgElm must have been loaded
```
- Image from Canvas
```
const options = {
canvas: //required,
albumName: //optional,
}
canvas: "id_canvas", //required
albumName: "test" //optional
};
cordova.plugins.PhotoLibrary.imageFromCanvas(options, callback, errback)
cordova.plugins.PhotoLibrary.imageFromCanvas(options, callback, errback);
```
- Image from Base64
```
const options = {
base64String: //required,
albumName: //optional,
}
base64String: "hash_code", //required
albumName: "test" //optional
};
cordova.plugins.PhotoLibrary.imageFromBase64(options, callback, errback)
cordova.plugins.PhotoLibrary.imageFromBase64(options, callback, errback);
```

- Image from URL
```
const options = {
url: //required,
albumName: //optional,
}
url: "https://site.io/test.jpg", //required
albumName: "test" //optional
};
cordova.plugins.PhotoLibrary.imageFromUrl(options, callback, errback)
cordova.plugins.PhotoLibrary.imageFromUrl(options, callback, errback);
```
- Video from URL
```
const options = {
url: //required,
albumName: //optional,
}
url: "https://site.io/test.mp4", //required
albumName: "test" //optional
};
cordova.plugins.PhotoLibrary.videofromUrl(options, callback, errback)
cordova.plugins.PhotoLibrary.videofromUrl(options, callback, errback);
```

Note: if don't need callback success/fail replace with `null`: `(options, null, null)`

0 comments on commit a2be644

Please sign in to comment.