From 28d60b68ad7bc5b7ebda6b720981feacd3bde337 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Ramos?= Date: Mon, 29 Jan 2018 16:10:49 -0800 Subject: [PATCH] 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 --- Libraries/CameraRoll/CameraRoll.js | 102 +----- Libraries/Geolocation/Geolocation.js | 65 +--- Libraries/Image/Image.android.js | 85 +---- Libraries/Image/Image.ios.js | 228 ++---------- Libraries/Linking/Linking.js | 150 +------- Libraries/Modal/Modal.js | 111 ++---- Libraries/Network/NetInfo.js | 171 +++------ .../PermissionsAndroid/PermissionsAndroid.js | 61 +--- .../PushNotificationIOS.js | 191 +++------- Libraries/Text/Text.js | 330 +++--------------- Libraries/Vibration/Vibration.js | 52 +-- 11 files changed, 261 insertions(+), 1285 deletions(-) diff --git a/Libraries/CameraRoll/CameraRoll.js b/Libraries/CameraRoll/CameraRoll.js index 78f8d365aaea24..91fba6d8fe893c 100644 --- a/Libraries/CameraRoll/CameraRoll.js +++ b/Libraries/CameraRoll/CameraRoll.js @@ -147,15 +147,9 @@ const getPhotosReturnChecker = createStrictShapeTypeChecker({ }); /** - * `CameraRoll` provides access to the local camera roll / gallery. - * 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. + * `CameraRoll` provides access to the local camera roll or photo library. * + * See https://facebook.github.io/react-native/docs/cameraroll.html */ class CameraRoll { static GroupTypesOptions: Object = GROUP_TYPES_OPTIONS; @@ -176,18 +170,9 @@ class CameraRoll { } /** - * Saves the photo or video to the camera roll / gallery. - * - * On Android, the tag must be a local image or video URI, such as `"file:///sdcard/img.png"`. - * - * 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'. + * Saves the photo or video to the camera roll or photo library. * - * Returns a Promise which will resolve with the new URI. + * See https://facebook.github.io/react-native/docs/cameraroll.html#savetocameraroll */ static saveToCameraRoll( tag: string, @@ -218,84 +203,7 @@ class CameraRoll { * Returns a Promise with photo identifier objects from the local camera * roll of the device matching shape defined by `getPhotosReturnChecker`. * - * Expects a params object of the following shape: - * - * - `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} 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 ( - * - *