Drive and Photo Service:Android SDK overview

Integrate the SDK

Import the SDK using Gradle.

implementation 'com.aliyun.pds:android-sdk:0.1.4'

Source code: aliyun-pds-android-sdk.

Initialization

Before using the software development kit (SDK), make sure you have activated Drive and Photo Service and created an instance in the console. For more information, see Get started with PDS.

// Obtain the access token from your account system. Your backend uses the AppKey and AppSecret from the PDS platform to request a token and returns it to the client.
val token = SDToken("your access token") 
// Get your API host from the PDS console.
val apiHost = "your API host"            
val config = SDConfig.Builder(token, apiHost, 3600)
    // Specifies whether to enable instant file transfer. Default: true. (Optional)
    .canFastUpload() 
    // The User-Agent for the request. (Optional)
    .userAgent() 
    // The maximum number of retries. Default: 3. (Optional)
    .maxRetryCount()
    // Specifies whether to enable debug mode. Default: false. (Optional)
    .isDebug()
    // The size of a download shard. Default: 10 MB. Do not set this value too small or too large. (Optional)
    .downloadBlockSize() 
    // The size of an upload shard. Default: 4 MB. Do not set this value too small or too large. (Optional)
    .uploadBlockSize() 
    // The timeout period for establishing a network connection. Default: 15s. (Optional)
    .connectTimeout()
    // The timeout period for a network connection response. Default: 60s. (Optional)
    .readTimeout()
    // The timeout period for a network transmission response. Default: 60s. (Optional)
    .writeTimeout()         
    .build()
SDClient.instance.init(this, config)

Task progress callback

// currentSize is the current progress. Note that the callback is not on the main thread.
interface OnProgressListener {
    fun onProgressChange(currentSize : Long)
}

Task completion callback

interface OnCompleteListener {
    fun onComplete(taskId: String, fileMeta : SDFileMeta, errorInfo: SDErrorInfo?)
}

The fileMeta parameter contains file information.

class SDFileMeta(
    // The file ID.
    val fileId: String?,
    // The file name.
    val fileName: String?,
    // The file path. For an upload task, this is the path of the file to upload. For a download task, this is the path where the file is saved.
    val filePath: String?,
    // The uploadId for the upload task. You can ignore this if it is not relevant to your business.
    val uploadId: String? = "" 
)

class SDErrorInfo(
    // The error code.
    val code: SDTransferError,
    // The error description.
    val message: String,
    // The exception, used to view the stack and handle errors.
    val exception: Exception?,
    // If a backend request error occurs, this value is returned to help with troubleshooting.
    var requestId: String? = "" 
)

Error codes

SDTransferError.Unknown // Unknown error.
SDTransferError.Network // Network error.
SDTransferError.Server // Server error.
SDTransferError.FileNotExist // During upload, the local file was not found.
SDTransferError.SpaceNotEnough // During download, there is not enough local storage space.
SDTransferError.TmpFileNotExist // During download, the local temporary file does not exist.
SDTransferError.PathRuleError // During download, the save path rule is invalid.