tencent cloud

Resources

• Download the XML Android SDK source code here.
• Download the demo here.
• For SDK APIs and parameters, please see SDK API Reference.
• For the complete sample code, please see SDK Sample Code.
• For the SDK changelog, please see ChangeLog.
• For SDK FAQs, please see Android SDK FAQs.

Note：

If you encounter errors such as non-existent functions or methods when using the XML version of the SDK, please update the SDK to the latest version and try again.

Preparations

1. You need an Android app, which can be one of your existing projects or a new one.
2. Make sure that your Android app’s target API level is 15 (Ice Cream Sandwich) or above.
3. Prepare a remote address that can be used to obtain your Tencent Cloud temporary key. For more information on temporary keys, please see Implementing Direct Upload for Mobile Apps.

Step 1. Install the SDK

Method 1. Automatic integration (recommended)

Note：

As the Bintray repository is no longer available, COS’s SDK has been migrated to Maven Central. The import path is different and thus you need to use the new import path during the update.

Using the Maven Central repository

Add the following code to the project-level build.gradle file (usually in the root directory):

repositories {
   google()
   // Add the following line
   mavenCentral()
}

Standard SDK

Add dependencies to the app-level build.gradle file (usually under the app module).

dependencies {
...
   // Add the following line
   implementation 'com.qcloud.cos:cos-android:5.7.+'
}

Simplified SDK

Add dependencies to the app-level build.gradle file (usually under the app module).

dependencies {
...
   // Add the following line
   implementation 'com.qcloud.cos:cos-android-lite:5.7.+'
}

Disabling the beacon report feature (applicable to 5.5.8 or later)

We have introduced the Tencent Beacon into the SDK to track down and optimize the SDK quality for a better user experience.

Note：

Tencent Beacon monitors only the COS-side request performance, and will not report the business-side data.

To disable the beacon analysis feature, add the following statement to the app-level build.gradle file (usually under the app module):

dependencies {
...
  implementation ('com.qcloud.cos:cos-android:x.x.x'){
      // Add the following line
      exclude group: 'com.tencent.qcloud', module: 'beacon-android-release'
  }
}

Method 2: Manually integrate

1. Download the SDK version

You can directly download the latest SDK version here or find all versions at SDK Releases.

After downloading and decompressing the file, you can see that it contains multiple JAR or AAR packages as described below. Please choose the ones you want to integrate.

Required libraries:

• cosxml: COS protocol implementation
• qcloud-foundation: foundation library
• bolts-tasks: third-party task library
• okhttp: third-party networking library
• okio: third-party I/O library

Optional libraries:

• beacon: mobile beacon analysis to improve the SDK
• LogUtils: log module for improving the SDK
• quic: QUIC protocol, required if you transfer data over QUIC

2. Integrate the SDK into your project

Put your libraries in the app-module libs folder and add dependencies to the app-level build.gradle file (usually under the app module):

dependencies {
...
  // Add the following line
  implementation fileTree(dir: 'libs', include: ['*.jar', '*.aar'])
}

Step 2. Configure Permissions

Network permissions

The SDK needs network permission to communicate with the COS server. Please add the following permission declarations to AndroidManifest.xml under the app module:

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

Storage permissions

If you need to read and write files from external storage, please add the following permission declarations to AndroidManifest.xml under the app module:

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

Note：

For Android 6.0 (API level 23) or above, you need to dynamically request storage permissions at runtime.

Step 3. Use the SDK

1. Obtain a temporary key

Implement a BasicLifecycleCredentialProvider subclass to request a temporary key and return the result.

public static class MySessionCredentialProvider
      extends BasicLifecycleCredentialProvider {
   @Override
  protected QCloudLifecycleCredentials fetchNewCredentials()
          throws QCloudClientException {
       // First, obtain the response containing the key from your temporary key server
       // Then, parse the response to obtain the temporary key
      String tmpSecretId = "SECRETID"; // SecretId of the temporary key
      String tmpSecretKey = "SECRETKEY"; // SecretKey of the temporary key
      String sessionToken = "SESSIONTOKEN"; // Token of the temporary key
      long expiredTime = 1556183496L;// End timestamp (in seconds) of the effective period of the temporary key
       // To avoid request expiration caused by the large discrepancy between the phone’s local time and the standard time, we recommend that the time returning to the server be used as the signature start time.
      // Time returning to the server as the signature start time
      long startTime = 1556182000L; // Start timestamp (in seconds) of the effective period of the temporary key
       // Finally, return the temporary key object
      return new SessionQCloudCredentials(tmpSecretId, tmpSecretKey,
              sessionToken, startTime, expiredTime);
  }
}

The following takes MySessionCredentialProvider as the class name example to initialize an instance to provide a key for the SDK.

QCloudCredentialProvider myCredentialProvider = new MySessionCredentialProvider();

Using a permanent key for local debugging

You can use your Tencent Cloud permanent key for local debugging during the development phase. Since this method exposes the key to leakage risks, please be sure to replace it with a temporary key before launching your application.

String secretId = "SECRETID"; // SecretId of the permanent key
String secretKey = "SECRETKEY"; // SecretKey of the permanent key
// keyDuration is the effective duration (in seconds) of the key in your request
QCloudCredentialProvider myCredentialProvider =
  new ShortTimeCredentialProvider(secretId, secretKey, 300);

2. Initialize a COS instance

Use your myCredentialProvider instance that provides the key to initialize a CosXmlService instance.

CosXmlService provides all APIs for accessing COS. We recommend you use it as an application singleton.

// Bucket region abbreviation. For example, "ap-guangzhou" is the abbreviation of the Guangzhou region
String region = "COS_REGION";
// Create a `CosXmlServiceConfig` object and modify the default configuration parameters as needed
CosXmlServiceConfig serviceConfig = new CosXmlServiceConfig.Builder()
      .setRegion(region)
      .isHttps(true) // Use the HTTPS request. HTTP is used by default
      .builder();
// Initialize the COS service to obtain the instance
CosXmlService cosXmlService = new CosXmlService(context,
  serviceConfig, myCredentialProvider);

Note：

For more information on the abbreviations of the COS bucket regions, please see Regions and Access Endpoints.

Step 4. Access COS

Uploading an object

The SDK supports uploading local files, binary data, URIs, and input streams. The following uses uploading a local file as an example:

// Initialize TransferConfig. The default configuration is used here. To customize the configuration, please see the SDK API documentation.
TransferConfig transferConfig = new TransferConfig.Builder().build();
// Initialize TransferManager
TransferManager transferManager = new TransferManager(cosXmlService,
       transferConfig);
// Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
String bucket = "examplebucket-1250000000";
String cosPath = "exampleobject"; // Location identifier of the object in the bucket, i.e., the object key
String srcPath = new File(context.getCacheDir(), "exampleobject")
       .toString(); // Absolute path of the local file
// If there is an uploadId for the initialized multipart upload, assign the value of uploadId here to resume the upload. Otherwise, assign null
String uploadId = null;
// Upload the object
COSXMLUploadTask cosxmlUploadTask = transferManager.upload(bucket, cosPath,
       srcPath, uploadId);
// Set the upload progress callback
cosxmlUploadTask.setCosXmlProgressListener(new CosXmlProgressListener() {
   @Override
   public void onProgress(long complete, long target) {
       // todo Do something to update progress...
   }
});
// Set the response callback
cosxmlUploadTask.setCosXmlResultListener(new CosXmlResultListener() {
   @Override
   public void onSuccess(CosXmlRequest request, CosXmlResult result) {
       COSXMLUploadTask.COSXMLUploadTaskResult uploadResult =
               (COSXMLUploadTask.COSXMLUploadTaskResult) result;
   }
    // If you use the Kotlin language to call this, please note that the exception in the callback method is nullable; otherwise, the onFail method will not be called back, that is:
   // clientException is of type CosXmlClientException? and serviceException is of type CosXmlServiceException?
   @Override
   public void onFail(CosXmlRequest request,
                      @Nullable CosXmlClientException clientException,
                      @Nullable CosXmlServiceException serviceException) {
       if (clientException != null) {
           clientException.printStackTrace();
       } else {
           serviceException.printStackTrace();
       }
   }
});
// Set the job status callback to view the job progress
cosxmlUploadTask.setTransferStateListener(new TransferStateListener() {
   @Override
   public void onStateChanged(TransferState state) {
       // todo notify transfer state
   }
});

Note：

• For the complete sample, please visit GitHub.
• After the upload, you can generate a download URL for the uploaded file with the same key. For detailed directions, please see Generating Pre-signed Links. Please note that for private-read files, the download URL is only valid for a limited period of time.

Downloading an object

// The advanced download API supports checkpoint restart. Therefore, a HEAD request will be sent before the download to obtain the file information.
// If you are using a temporary key or accessing with a sub-account, ensure that your permission list includes HeadObject.
// Initialize TransferConfig. The default configuration is used here. To customize the configuration, please see the SDK API documentation.
TransferConfig transferConfig = new TransferConfig.Builder().build();
// Initialize TransferManager
TransferManager transferManager = new TransferManager(cosXmlService,
       transferConfig);
// Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
String bucket = "examplebucket-1250000000";
String cosPath = "exampleobject"; // Location identifier of the object in the bucket, i.e., the object key
// Path of the local directory
String savePathDir = context.getExternalCacheDir().toString();
// File name saved locally. If not specified (null), it will be the same as the COS file name
String savedFileName = "exampleobject";
Context applicationContext = context.getApplicationContext(); // application
// context
COSXMLDownloadTask cosxmlDownloadTask =
       transferManager.download(applicationContext,
               bucket, cosPath, savePathDir, savedFileName);
// Set the download progress callback
cosxmlDownloadTask.setCosXmlProgressListener(new CosXmlProgressListener() {
   @Override
   public void onProgress(long complete, long target) {
       // todo Do something to update progress...
   }
});
// Set the response callback
cosxmlDownloadTask.setCosXmlResultListener(new CosXmlResultListener() {
   @Override
   public void onSuccess(CosXmlRequest request, CosXmlResult result) {
       COSXMLDownloadTask.COSXMLDownloadTaskResult downloadTaskResult =
               (COSXMLDownloadTask.COSXMLDownloadTaskResult) result;
   }
    // If you use the Kotlin language to call this, please note that the exception in the callback method is nullable; otherwise, the onFail method will not be called back, that is:
   // clientException is of type CosXmlClientException? and serviceException is of type CosXmlServiceException?
   @Override
   public void onFail(CosXmlRequest request,
                      @Nullable CosXmlClientException clientException,
                      @Nullable CosXmlServiceException serviceException) {
       if (clientException != null) {
           clientException.printStackTrace();
       } else {
           serviceException.printStackTrace();
       }
   }
});
// Set the job status callback to view the job progress
cosxmlDownloadTask.setTransferStateListener(new TransferStateListener() {
   @Override
   public void onStateChanged(TransferState state) {
       // todo notify transfer state
   }
});

Note：

• For the complete sample, please visit GitHub.
• The advanced download API supports checkpoint restart. Therefore, a HEAD request will be sent before the download to obtain the file information. If you are using a temporary key or accessing with a sub-account, ensure that your permission list includes HeadObject.