Trim docs that are already present in the open source docs site
Summary: A lot of these docs are already present in https://github.com/facebook/react-native-website. Closes https://github.com/facebook/react-native/pull/17776 Differential Revision: D6839783 Pulled By: hramos fbshipit-source-id: 945fde22afb8f181d0463617d224d3f3429faa24
This commit is contained in:
parent
33525fcc98
commit
6323497adb
102
CameraRoll.js
102
CameraRoll.js
|
@ -147,15 +147,9 @@ const getPhotosReturnChecker = createStrictShapeTypeChecker({
|
||||||
});
|
});
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* `CameraRoll` provides access to the local camera roll / gallery.
|
* `CameraRoll` provides access to the local camera roll or photo library.
|
||||||
* Before using this you must link the `RCTCameraRoll` library.
|
|
||||||
* You can refer to [Linking](docs/linking-libraries-ios.html) for help.
|
|
||||||
*
|
|
||||||
* ### Permissions
|
|
||||||
* The user's permission is required in order to access the Camera Roll on devices running iOS 10 or later.
|
|
||||||
* Add the `NSPhotoLibraryUsageDescription` key in your `Info.plist` with a string that describes how your
|
|
||||||
* app will use this data. This key will appear as `Privacy - Photo Library Usage Description` in Xcode.
|
|
||||||
*
|
*
|
||||||
|
* See https://facebook.github.io/react-native/docs/cameraroll.html
|
||||||
*/
|
*/
|
||||||
class CameraRoll {
|
class CameraRoll {
|
||||||
static GroupTypesOptions: Object = GROUP_TYPES_OPTIONS;
|
static GroupTypesOptions: Object = GROUP_TYPES_OPTIONS;
|
||||||
|
@ -176,18 +170,9 @@ class CameraRoll {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Saves the photo or video to the camera roll / gallery.
|
* Saves the photo or video to the camera roll or photo library.
|
||||||
*
|
*
|
||||||
* On Android, the tag must be a local image or video URI, such as `"file:///sdcard/img.png"`.
|
* See https://facebook.github.io/react-native/docs/cameraroll.html#savetocameraroll
|
||||||
*
|
|
||||||
* On iOS, the tag can be any image URI (including local, remote asset-library and base64 data URIs)
|
|
||||||
* or a local video file URI (remote or data URIs are not supported for saving video at this time).
|
|
||||||
*
|
|
||||||
* If the tag has a file extension of .mov or .mp4, it will be inferred as a video. Otherwise
|
|
||||||
* it will be treated as a photo. To override the automatic choice, you can pass an optional
|
|
||||||
* `type` parameter that must be one of 'photo' or 'video'.
|
|
||||||
*
|
|
||||||
* Returns a Promise which will resolve with the new URI.
|
|
||||||
*/
|
*/
|
||||||
static saveToCameraRoll(
|
static saveToCameraRoll(
|
||||||
tag: string,
|
tag: string,
|
||||||
|
@ -218,84 +203,7 @@ class CameraRoll {
|
||||||
* Returns a Promise with photo identifier objects from the local camera
|
* Returns a Promise with photo identifier objects from the local camera
|
||||||
* roll of the device matching shape defined by `getPhotosReturnChecker`.
|
* roll of the device matching shape defined by `getPhotosReturnChecker`.
|
||||||
*
|
*
|
||||||
* Expects a params object of the following shape:
|
* See https://facebook.github.io/react-native/docs/cameraroll.html#getphotos
|
||||||
*
|
|
||||||
* - `first` : {number} : The number of photos wanted in reverse order of the photo application (i.e. most recent first for SavedPhotos).
|
|
||||||
* - `after` : {string} : A cursor that matches `page_info { end_cursor }` returned from a previous call to `getPhotos`.
|
|
||||||
* - `groupTypes` : {string} : Specifies which group types to filter the results to. Valid values are:
|
|
||||||
* - `Album`
|
|
||||||
* - `All`
|
|
||||||
* - `Event`
|
|
||||||
* - `Faces`
|
|
||||||
* - `Library`
|
|
||||||
* - `PhotoStream`
|
|
||||||
* - `SavedPhotos` // default
|
|
||||||
* - `groupName` : {string} : Specifies filter on group names, like 'Recent Photos' or custom album titles.
|
|
||||||
* - `assetType` : {string} : Specifies filter on asset type. Valid values are:
|
|
||||||
* - `All`
|
|
||||||
* - `Videos`
|
|
||||||
* - `Photos` // default
|
|
||||||
* - `mimeTypes` : {string} : Filter by mimetype (e.g. image/jpeg).
|
|
||||||
*
|
|
||||||
* Returns a Promise which when resolved will be of the following shape:
|
|
||||||
*
|
|
||||||
* - `edges` : {Array<node>} An array of node objects
|
|
||||||
* - `node`: {object} An object with the following shape:
|
|
||||||
* - `type`: {string}
|
|
||||||
* - `group_name`: {string}
|
|
||||||
* - `image`: {object} : An object with the following shape:
|
|
||||||
* - `uri`: {string}
|
|
||||||
* - `height`: {number}
|
|
||||||
* - `width`: {number}
|
|
||||||
* - `isStored`: {boolean}
|
|
||||||
* - `timestamp`: {number}
|
|
||||||
* - `location`: {object} : An object with the following shape:
|
|
||||||
* - `latitude`: {number}
|
|
||||||
* - `longitude`: {number}
|
|
||||||
* - `altitude`: {number}
|
|
||||||
* - `heading`: {number}
|
|
||||||
* - `speed`: {number}
|
|
||||||
* - `page_info` : {object} : An object with the following shape:
|
|
||||||
* - `has_next_page`: {boolean}
|
|
||||||
* - `start_cursor`: {string}
|
|
||||||
* - `end_cursor`: {string}
|
|
||||||
*
|
|
||||||
* Loading images:
|
|
||||||
* ```
|
|
||||||
* _handleButtonPress = () => {
|
|
||||||
* CameraRoll.getPhotos({
|
|
||||||
* first: 20,
|
|
||||||
* assetType: 'All',
|
|
||||||
* })
|
|
||||||
* .then(r => {
|
|
||||||
* this.setState({ photos: r.edges });
|
|
||||||
* })
|
|
||||||
* .catch((err) => {
|
|
||||||
* //Error Loading Images
|
|
||||||
* });
|
|
||||||
* };
|
|
||||||
* render() {
|
|
||||||
* return (
|
|
||||||
* <View>
|
|
||||||
* <Button title="Load Images" onPress={this._handleButtonPress} />
|
|
||||||
* <ScrollView>
|
|
||||||
* {this.state.photos.map((p, i) => {
|
|
||||||
* return (
|
|
||||||
* <Image
|
|
||||||
* key={i}
|
|
||||||
* style={{
|
|
||||||
* width: 300,
|
|
||||||
* height: 100,
|
|
||||||
* }}
|
|
||||||
* source={{ uri: p.node.image.uri }}
|
|
||||||
* />
|
|
||||||
* );
|
|
||||||
* })}
|
|
||||||
* </ScrollView>
|
|
||||||
* </View>
|
|
||||||
* );
|
|
||||||
* }
|
|
||||||
* ```
|
|
||||||
*/
|
*/
|
||||||
static getPhotos(params: GetPhotosParams): GetPhotosReturn {
|
static getPhotos(params: GetPhotosParams): GetPhotosReturn {
|
||||||
if (__DEV__) {
|
if (__DEV__) {
|
||||||
|
|
Loading…
Reference in New Issue