オプションを変更する

説明

DEXTUploadX5 HDアプリケーションのデフォルトのオプション情報を確認したり、オプションを変更することができます。

HDアプリケーションのオプションを確認するには、getOptionsOfHDメソッドを使用します。getOptionsOfHDメソッドは、成功コールバック関数のパラメータとして与えられるJSONオブジェクトです。

{
	// ファイルが追加されると、HDプログラムは自動的にアクティブになります。
	autoActivation: true,
	// ファイルが追加されると、HDプログラムは自動的にダウンロードを開始します。
	autoDownload: true,
	// ファイルが削除されると、その一時ファイルも削除されます。
	deleteTemporary: false,
	// ダウンロードを停止しているファイルがある場合、HDプログラムが起動するとダウンロードを開始します。
	resumeDownload: true,
	// プログラムが終了しても保持されるオプション
	saveStatus: {
		// 待機中または停止中の項目
		waitStop: true,
		// ダウンロード中のアイテム
		downloading: true,
		// 完了したアイテム
		complete: true,
		// エラーが発生した項目
		error: true
	}
}

逆に、オプションを設定するときは、主要なオプションを個別に設定することもできるし、上記のJSONオブジェクトを使って一度に設定することもできる。オプションを設定するために使用されるすべてのメソッドは、設定が正常に完了したときに成功コールバック関数を呼び出します。

// 個別の起動オプションを設定する
// 自動起動オプションを設定する。
dx.setAutoActivationOptionOfHD(true, function () { ... });
// 自動ダウンロードオプションを設定します。
dx.setAutoDownloadOptionOfHD(true, function () { ... });
// 一時削除オプションを設定します。
dx.setDeleteTemporaryOptionOfHD(false, function () { ... });
// 再ダウンロードオプションを設定します。
dx.setResumeDownloadOptionOfHD(true, function () { ... });
// 保持する項目を設定する。
dx.setSaveStatusOptionOfHD(15, function () { ... });

// 一度に
dx.setOptionsOfHD({
	autoActivation: true,
	autoDownload: true,
	deleteTemporary: false,
	resumeDownload: true,
	saveStatus: {
		waitStop: true,
		downloading: true,
		complete: true,
		error: true
	}
}, function () { ... });

setSaveStatusOptionOfHDメソッドには、none = 0、waitStop = 1、downloading = 2、complete = 4、error = 8が設定されている。複数の値を同時に設定するには、オブジェクトの合計（1～15）を設定する。例えば、waitStopとcompleteオブジェクトだけを保持したい場合は、パラメータ値として5（＝waitStop＋complete）を設定します。

例