com.amazonaws.mobileconnectors.s3.transferutility.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-android-sdk-s3 Show documentation

Amazon Web Services SDK for Android

There is a newer version: 2.9.1

/**
 * This package contains helper classes for managing upload and download tasks and a public
 * class {@link com.amazonaws.mobileconnectors.s3.transferservice.transferUtility}
 * which is a high level client that provides methods to control users' upload and download tasks.
 *
 * For starting transfer tasks, here is a sample usage.
 *
 *  * // Initializes TransferUtility
 * TransferUtility transferUtility = new TransferUtility(s3, getApplicationContext());
 * // Starts a download
 * TransferObserver observer = transferUtility.download("bucket_name", "key", file);
 * observer.setTransferListener(new TransferListener() {
 *     public void onStateChanged(int id, String newState) {
 *         // Do something in the callback.
 *     }
 *
 *     public void onProgressChanged(int id, long bytesCurrent, long bytesTotal) {
 *         // Do something in the callback.
 *     }
 *
 *     public void onError(int id, Exception e) {
 *         // Do something in the callback.
 *     }
 * });
 * 
 *
 * For pausing and resuming tasks:
 *
 *  * // Gets id of the transfer.
 * int id = observer.getId();
 *
 * // Pauses the transfer.
 * transferUtility.pause(id);
 *
 * // Resumes the transfer.
 * transferUtility.resume(id);
 * 
 *
 * For cancelling and deleting tasks:
 *
 *  * // Cancels the transfer.
 * transferUtility.cancel(id);
 *
 * // Deletes the transfer.
 * transferUtility.delete(id);
 * 
 */

package com.amazonaws.mobileconnectors.s3.transferutility;