applican

マイページに戻る

FileWriter ver.2.0

ファイルにデータを書き込むためのオブジェクトに関する機能です。

アプリカンAPIのver.2.0系のFileSystemのFileWriterのリファレンスです

  1. アプリカンAPIのver.1.0系のFileSystemのFileWriterのリファレンスはこちらからご確認ください。

プロパティ

fileName : String ファイル名です。
length : Number ファイル長です。
onabort : Function abort() メソッド実行時や書き込み処理が強制終了した場合にCallbackされます。
onerror : Function 書き込み失敗時にCallbackされます。
onprogress : Function 書き込みの進捗が変わるたびにCallbackされます。
onwrite : Function 書き込み終了時にCallbackされます。
onwriteend : Function 成功、失敗を問わず処理時にCallbackされます。
onwritestart : Function 書き込み開始時にCallbackされます。

メソッド

abort

メソッド説明

abort()

ファイルへの書き込みを中断します。
2018年11月14日時点で未実装のため、動作しません。

Return

void

write

メソッド説明

write(String text)

ファイルへ書き込みます。

パラメータ

text : String ファイルへ書き込むデータ内容を指定します。

Return

void

サンプルコード

// ファイルシステム取得時
function writeFileGotFS(fileSystem) {
	var fileName = 'sample.txt'
	fileSystem.root.getFile(fileName, {create : true, exclusive : false}, writeFileGotFileEntry, writeFileError);
}

// FileEntry取得時
function writeFileGotFileEntry(fileEntry) {
	fileEntry.createWriter(writeFileGotFileWriter, writeFileError);
}

// FileWriter取得成功時
function writeFileGotFileWriter(writer) {
	// 状態変更時のコールバックを設定
	// 書き込み開始
	writer.onwritestart = function(evt) {
		// do something
	};

	// 書き込み中断
	writer.onabort = function(evt) {
		// do something
	};

	// 書き込み中
	writer.onwrite = function(evt) {
		// do something
	};

	// 書き込みエラー
	writer.onerror = function(evt) {
		// do something
	};

	// 書き込み終了
	writer.onwriteend = function(evt) {
		// do something
	};

	// 書き込み
	var outputContent = "some sample text 1";
	writer.write(outputContent);
}

// 書き込み失敗時
function writeFileError(error) {
	var dump = "ファイルの書き込みに失敗しました。\n";
	dump    += "code : "    + error.code                 + "\n";
	dump    += "message : " + errMessageList[error.code] + "\n";
	alert(dump);
}

applican.filesystem.requestFileSystem(LocalFileSystem.PRESISTENT, 0, writeFileGotFS, writeFileError);

new で生成できなくなった API

FileWriter

// ver.1.0
var writer = new FileWriter();

// ver.2.0
const writer = applican.filesystem.createFileWriter();
loading