Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 2.46 KB

README.md

File metadata and controls

89 lines (60 loc) · 2.46 KB
Raw

amazon_s3_cognito

Amazon S3 plugin for Flutter

Unofficial Amazon S3 plugin written in Dart for Flutter.

Only supports Amazon SDK up to 2.20(excluded), since starting with 2.20, the SDK dropped the deprecated "AWSS3TransferManager" which is still in use within this plugin.

https://github.com/aws-amplify/aws-sdk-ios/releases/tag/2.20.0

The plugin is extension if flutter-amazon-s3 plugin which can be found here https://pub.dev/packages/flutter_amazon_s3. This plugin adds image list and delete functionality and also it allows user to upload image when region and sub-region are different.

Plugin in maintained by fäm properties[email protected].

Usage

To use this plugin, add amazon_s3_cognito as a dependency in your pubspec.yaml file.

dependencies:
The package is android-x compatible
  amazon_s3_cognito: '^0.2.0'

Example

import 'package:amazon_s3_cognito/amazon_s3_cognito.dart';
import 'package:amazon_s3_cognito/aws_region.dart';

//this method only supports image upload. 
String uploadedImageUrl = await AmazonS3Cognito.uploadImage(
          _image.path, BUCKET_NAME, IDENTITY_POOL_ID);
          

//Use the below code to specify the region and sub region for image upload
//Also this method allows to upload all file type including images and pdf etc.
//We recommend to use this method always. 
String uploadedImageUrl = await AmazonS3Cognito.upload(
            _image.path,
            BUCKET_NAME,
            IDENTITY_POOL_ID,
            IMAGE_NAME,
            AwsRegion.US_EAST_1,
            AwsRegion.AP_SOUTHEAST_1)
            
//use below code to delete an image
 String result = AmazonS3Cognito.delete(
            BUCKET_NAME,
            IDENTITY_POOL_ID,
            IMAGE_NAME,
            AwsRegion.US_EAST_1,
            AwsRegion.AP_SOUTHEAST_1)
            
//use below code to list files
 List<String> files = await AmazonS3Cognito.listFiles(
            BUCKET_NAME,
            IDENTITY_POOL_ID,
            PREFIX,
            AwsRegion.US_EAST_1,
            AwsRegion.AP_SOUTHEAST_1)

Installation

Android

No configuration required - the plugin should work out of the box.

iOS

No configuration required - the plugin should work out of the box.

Authors

the plugin is created and maintained by fäm properties. 
Android version written by Prachi Shrivastava
IOS version written by Prachi Shrivastava