You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

aliyun-test

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

aliyun-test

A cross-platform React Native SDK for AliyunOSS Services, providing most of the OSS APIs, like client initialization, uploading & downloading etc.


Version published
Maintainers
1
Created

Readme

Source

aliyun-test

A React Native SDK for AliyunOSS Services, providing most of the Native OSS APIs, like client initialization, uploading & downloading etc. A truly cross-platform SDK for Aliyun OSS Users. Supports images, videos and any files for uploading.

The latest version 1.1.0 supports iOS11, which allows you to upload the new HEIF Files (High Efficiency Image File Format - HEIC and HEVC). Considering the compatibility of all special formats on iOS, images and videos will be converted to JPEG and MPEG4 respectively before uploading.

Getting started

  • NPM:
npm install aliyun-test —save
  • YARN:
yarn add aliyun-test

Installation

iOS
  • CocoaPods

    pod 'aliyun-oss-react-native-sdk', :path => '../node_modules/aliyun-oss-react-native-sdk'

  • Non-CocoaPods

    • In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]. Go to node_modulesaliyun-oss-react-native-sdk and add RNAliyunOss.xcodeproj
    • In XCode, in the project navigator, select your project. Add libRNAliyunOSS.a to your project's Build PhasesLink Binary With Libraries
    • In XCode, in the project navigator, right click FrameworksAdd Files to [your project's name]. Go to node_modulesaliyun-oss-react-native-sdkAliyunSDK. Add AliyunOSSiOS.framework, and select Copy items if needed in the pop-up box.
Android
  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import com.reactlibrary.RNAliyunOSSPackage; to the imports at the top of the file
  • Add new RNAliyunOSSPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    	include ':aliyun-oss-react-native-sdk'
    	project(':aliyun-oss-react-native-sdk').projectDir = new File(rootProject.projectDir, 	'../node_modules/aliyun-oss-react-native-sdk/android')
    
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
       compile project(':aliyun-oss-react-native-sdk')
    

Usage

Import library:
import AliyunOSS from 'aliyun-oss-react-native-sdk';
Enable the dev mode: (optional)
AliyunOSS.enableDevMode();
Initialization Configuration: (optional)
const configuration = {
   maxRetryCount: 3,	
   timeoutIntervalForRequest: 30,
   timeoutIntervalForResource: 24 * 60 * 60
};
Initialization for OSS Client: (required - either one of them)
  1. PlainTextAKSK

    AliyunOSS.initWithPlainTextAccessKey(accessKey, secretKey, endPoint, configuration);
    
  2. ImplementedSigner

    AliyunOSS.initWithImplementedSigner(signature, accessKey, endPoint, configuration);
    
  3. SecurityToken (recommended)

    AliyunOSS.initWithSecurityToken(securityToken, accessKey, secretKey, endPoint, configuration);
    
Asynchronously uploading:
AliyunOSS.asyncUpload(bucketName, objectKey, filepath);
  • Supported three common types of filepath: (prefix)
    • assets-library://
    • file://
    • data://
  • Also, supported localIdentifier if you are using PhotoKit (iOS Only):
    • localIdentifier://
  • Before uploading, all images will be converted to JPEG, and all videos will be encoded by MPEG4 on iOS, while all images and videos will stay the original format on Android.
Asynchronously downloading:
AliyunOSS.asyncDownload(bucketName, objectKey, filepath);
Supported two events: (optional)
  • uploadProgress

    AliyunOSS.addEventListener('uploadPress', (event) => {
      console.log(event);
    });
    
  • downloadProgress

    AliyunOSS.addEventListener('downloadProgress', (event) => {
      console.log(event);
    });
    
Properties for Initialization:
PropertyTypeDescription
accessKeyString (required)The access key of your OSS service
secretKeyString (required)The secret key of your OSS service
endPointString (required)The end point of your OSS service
configurationObject (optional)maxRetryCount = 3, timeoutIntervalForRequest = 30 , timeoutIntervalForResource = 86400 (all of them are numbers)
signatureString (optional)Also known as: Signed URL Authorization
securityTokenString (optional)Also known as: STS Authorization
Properties for Upload and Download:
PropertyTypeDescription
bucketNameString (required)The bucket name of your OSS service
objectKeyString (required)The cloud path for storing your remote file
filepathString (required)The local path for loading or saving your file

TO-DO-LIST:

  • Implement android side ✔︎
  • Bucket management
  • Advanced upload modes
  • Advanced download modes

Liscence

MIT

Keywords

FAQs

Package last updated on 03 Jul 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc