applican

マイページに戻る

Utilities

ファイルのダウンロードやZIPファイルの解凍など、役に立つ機能を提供します。このAPIは随時追加予定です。

【対応ランタイムバージョン】

ランタイムのバージョン毎に最適化したサンプルをダウンロードしてご使用ください。

メソッド

  • download(Object options, Function progressCallbak, Function successCallback, Function errorCallback)
  • unzip(Object options, Function successCallback, Function errorCallback)

download

メソッド説明

download(Object options, Function progressCallbak, Function successCallback, Function errorCallback)

ファイルのダウンロードを行います。

パラメータ

options オプションのパラメータは以下の通りです。
url: String
ダウンロードするファイルのURLを設定します。
timeout: Integer
タイムアウトの秒数を設定します。省略した場合は60秒が設定されます。
destination: String
ダウンロードするファイルの保存パスを設定します。「cache」または」documents」を設定してください。「cache」を設定した場合はキャッシュルート、「documents」を設定した場合はドキュメントルートに保存します。ファイルの保存ディレクトリについては、FileRootを参照ください。
progressCallback : Function ダウンロードのパーセンテージがCallbackされます。
※実際のダウンロード状況より、callbackが若干遅れて届く可能性があります。
successCallback : Function ダウンロードに成功した場合にCallbackされます。
errorCallback : Function ダウンロードに失敗した場合にCallbackされます。

Return

void

サンプルコード

// ファイルダウンロード
function download() {
	// ダウンロードオプション
	var options = {
		url : "http://domain/file.zip",
		timeout : 10,
		destination : "caches",
	};

	// ファイルダウンロード
	applican.utilities.download(options, progreeCallback, successCallback, errorCallback);
	function progreeCallback (percentage) {
		// ダウンロードパーセンテージ
		console.log(percentage);
	}

	function successCallback () {
		var dump = "download success";
		console.log(dump);
	}

	function errorCallback () {
		var dump = "download error";
		console.log(dump);
	}
}

unzip

メソッド説明

unzip(Object options, Function successCallback, Function errorCallback)

圧縮されたZIPファイルを解凍します。

パラメータ

options オプションのパラメータは以下の通りです。
source: String
ZIPファイルのパスを設定します。
target: String
解凍先のパスを設定します。ファイルの保存ディレクトリについては、FileRootを参照ください。
successCallback : Function ZIPファイルの解凍に成功した場合にCallbackされます。
errorCallback : Function UnzipError ZIPファイルの解凍に失敗した場合にエラーコードがCallbackされます。
ERROR_UNZIP_INVALID_PATH : 1
ERROR_UNZIP_UNZIP_ERROR: 2

Return

void

サンプルコード

// ファイルの解凍
function unzip() {

	// 解凍オプション
	var options = {
		source : "/SOURCE_TO_PATH/file.zip",
		target : "/UNZIP_PATH/"
	};

	applican.utilities.unzip(options, successCallback, errorCallback);

	function successCallback(path){
		var dump = "unzip successCallback path : " + path;
		console.log(dump);
	}

	function errorCallback(error){
		var dump = "unzip errorCallback\n";
		dump += "code:" + error.code + "\n";
		console.log(dump);
	}
}