Drive and Photo Service:Android SDK の概要

SDK の統合

Gradle を使用して SDK をインポートします。

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

ソースコード： aliyun-pds-android-sdk。

初期化

ソフトウェア開発キット (SDK) を使用する前に、Drive and Photo Service を有効化し、コンソールでインスタンスを作成していることを確認してください。詳細については、「PDS の使用開始」をご参照ください。

// アカウントシステムからアクセストークンを取得します。 バックエンドは PDS プラットフォームの AppKey と AppSecret を使用してトークンをリクエストし、クライアントに返します。
val token = SDToken("your access token") 
// PDS コンソールから API ホストを取得します。
val apiHost = "your API host"            
val config = SDConfig.Builder(token, apiHost, 3600)
    // 高速ファイル転送を有効にするかどうかを指定します。 デフォルト： true。(オプション)
    .canFastUpload() 
    // リクエストの User-Agent。(オプション)
    .userAgent() 
    // 最大リトライ回数。 デフォルト： 3。(オプション)
    .maxRetryCount()
    // デバッグモードを有効にするかどうかを指定します。 デフォルト： false。(オプション)
    .isDebug()
    // ダウンロードシャードのサイズ。 デフォルト： 10 MB。この値を小さすぎたり、大きすぎたりしないように設定してください。(オプション)
    .downloadBlockSize() 
    // アップロードシャードのサイズ。 デフォルト： 4 MB。この値を小さすぎたり、大きすぎたりしないように設定してください。(オプション)
    .uploadBlockSize() 
    // ネットワーク接続を確立するためのタイムアウト期間。 デフォルト： 15 秒。(オプション)
    .connectTimeout()
    // ネットワーク接続応答のタイムアウト期間。 デフォルト： 60 秒。(オプション)
    .readTimeout()
    // ネットワーク送信応答のタイムアウト期間。 デフォルト： 60 秒。(オプション)
    .writeTimeout()         
    .build()
SDClient.instance.init(this, config)

タスク進捗コールバック

// currentSize は現在の進捗です。 コールバックはメインスレッドではないことに注意してください。
interface OnProgressListener {
    fun onProgressChange(currentSize : Long)
}

タスク完了コールバック

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

fileMeta パラメーターにはファイル情報が含まれています。

class SDFileMeta(
    // ファイル ID。
    val fileId: String?,
    // ファイル名。
    val fileName: String?,
    // ファイルパス。 アップロードタスクの場合、これはアップロードするファイルのパスです。 ダウンロードタスクの場合、これはファイルが保存されるパスです。
    val filePath: String?,
    // アップロードタスクの uploadId。 ビジネスに関連しない場合は無視できます。
    val uploadId: String? = "" 
)

class SDErrorInfo(
    // エラーコード。
    val code: SDTransferError,
    // エラーの説明。
    val message: String,
    // 例外。スタックの表示やエラー処理に使用します。
    val exception: Exception?,
    // バックエンドリクエストエラーが発生した場合、この値が返され、トラブルシューティングに役立ちます。
    var requestId: String? = "" 
)

エラーコード

SDTransferError.Unknown // 不明なエラー。
SDTransferError.Network // ネットワークエラー。
SDTransferError.Server // サーバーエラー。
SDTransferError.FileNotExist // アップロード中に、ローカルファイルが見つかりませんでした。
SDTransferError.SpaceNotEnough // ダウンロード中に、ローカルストレージの容量が不足しています。
SDTransferError.TmpFileNotExist // ダウンロード中に、ローカルの一時ファイルが存在しません。
SDTransferError.PathRuleError // ダウンロード中に、保存パスのルールが無効です。