applican

マイページに戻る

FileEntry ver.2.0

ファイルシステム上のファイルに対してのアクションを提供する機能です。

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

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

プロパティ

fileSystem : FileSystem ファイルシステムです。
fullPath : String ルートディレクトリからのこのファイルを参照出来るパスです。
isDirectory : Boolean 自身がディレクトリかを表します。
isFile : Boolean 自身がファイルかを表します。
name : String パス情報を含まないファイル名です。

メソッド

ver.2.0用

copyTo

メソッド説明

copyTo(DirectoryEntry or FileEntry entry, String name, Function<File> successCallback, Function<FileError> errorCallback)

ファイルをコピーします。

パラメータ

entry : DirectoryEntry or FileEntry 移動先のディレクトリを指定します。
name : String コピー時の新しい名前を指定します。未指定の場合は現在の名前を利用します。
successCallback : Function<File> ファイルをコピーに成功した場合にCallbackされます。
errorCallback : Function<FileError> ファイルのコピーに失敗した場合にCallbackされます。

Return

void

ver.2.0用サンプルコード

//ファイルコピー
function copyTo() {
	applican.filesystem.requestFileSystem(LocalFileSystem.PERSISTENT, 0, copyToGotFS, copyToFail);
}

function copyToGotFS(fileSystem) {
	fileSystem.root.getFile("readme.txt", null, copyToGotFileEntry, copyToFail);
}

function copyToGotFileEntry(fileEntry) {
	const tmp = fileEntry.fullPath;
	const parentPath = tmp.substring(0, tmp.lastIndexOf('/'));
	const parentName = parentPath.substring(parentPath.lastIndexOf('/') + 1);
	const parentEntry = new applican.filesystem.createDirectoryEntry(parentName, parentPath);
	fileEntry.copyTo(parentEntry, "readme3.txt", copyToCopyToSuccess, copyToFail);
}

function copyToCopyToSuccess(entry) {
	const dump = "copyToCopyToSuccess\n";
	dump += entry.name + "\n"+entry.fullPath + "\n";
	document.getElementById("dumpAreaFile").value = dump;
}

function copyToFail(error) {
	alert("copyToFail: " + error);
}
filesystem.requestFileSystemの第二引数には、サイズの指定が入ります。
現状はサイズ指定に未対応の為、どんな値を設定しても、OSが許す範囲まで自由に使えます。

createWriter

メソッド説明

createWriter(Function<FileWriter> successCallback, Function<FileError> errorCallback)

ファイルにデータを書き込むWriterオブジェクトを生成します。

パラメータ

successCallback : Function<FileWriter> Writerの生成に成功した場合にCallbackされます。
errorCallback : Function<FileError> Writerの生成に失敗した場合にCallbackされます。

サンプルコード

//ファイル書き込み
function writeFile() {
	applican.filesystem.requestFileSystem(LocalFileSystem.PERSISTENT, 0, writeFileGotFS, writeFileFail);
}

function writeFileGotFS(fileSystem) {
	fileSystem.root.getFile("readme.txt", {create: true, exclusive: false}, writeFileGotFileEntry, writeFileFail);
}

function writeFileGotFileEntry(fileEntry) {
	fileEntry.createWriter(writeFileGotFileWriter, writeFileFail);
}

function writeFile_gotFileWriter(writer) {
	var dump = "writeFile_gotFileWriter\n";
	document.getElementById("dumpAreaFile").value = dump;

	writer.onwritestart = function(evt) {
		document.getElementById("dumpAreaFile").value += "onwritestart\n";
	};
	writer.onabort = function(evt) {
		document.getElementById("dumpAreaFile").value += "onabort\n";
	};
	writer.onwrite = function(evt) {
		document.getElementById("dumpAreaFile").value += "onwrite\n";
	};
	writer.onerror = function(evt) {
		document.getElementById("dumpAreaFile").value += "onerror\n";
	};
	writer.onwriteend = function(evt) {
		document.getElementById("dumpAreaFile").value += "onwriteend\n"
	};
	writer.write("some sample text");
}

function writeFileFail(error) {
	var dump = "writeFileFail\n";
	dump += "code:" + error + "\n";
	document.getElementById("dumpAreaFile").value = dump;
}
requestFileSystemの第二引数には、サイズの指定が入ります。
現状はサイズ指定に未対応の為、どんな値を設定しても、OSが許す範囲まで自由に使えます。

file

メソッド説明

file(Function<File> successCallback, Function<FileError> errorCallback)

ファイル属性情報を取得します。

パラメータ

successCallback : Function<File> ファイル属性の取得に成功した場合にCallbackされます。
errorCallback : Function<FileError> ファイル属性の取得に失敗した場合にCallbackされます。

Return

void

getParent

メソッド説明

getParent(Function<DirectoryEntry> successCallback, Function<FileError> errorCallback)

親ディレクトリを取得します。

パラメータ

successCallback : Function<DirectoryEntry> 親ディレクトリの取得に成功した場合にCallbackされます。
errorCallback : Function<FileError> 親ディレクトリの取得に失敗した場合にCallbackされます。

Return

void

サンプルコード

//親ディレクトリ
function getParent() {
	applican.filesystem.requestFileSystem(LocalFileSystem.PERSISTENT, 0, getParentGotFS, getParentFail);
}

function getParentGotFS(fileSystem) {
	fileSystem.root.getFile("readme.txt", null, getParentGotFileEntry, getParentFail);
}

function getParentGotFileEntry(fileEntry) {
	fileEntry.getParent(getParentSuccess, getParentFail);
}

function getParentSuccess(entry) {
	var dump = "getParentSuccess\n";
	dump += entry.name + "\n" + entry.fullPath + "\n";
	document.getElementById("dumpAreaFile").value = dump;
}

function getParentFail(error) {
	alert("getParentFail: " + error);
}
requestFileSystemの第二引数には、サイズの指定が入ります。
現状はサイズ指定に未対応の為、どんな値を設定しても、OSが許す範囲まで自由に使えます。

moveTo

メソッド説明

moveTo(DirectoryEntry or FileEntry entry, String name, Function<File> successCallback, Function<FileError> errorCallback)

ファイルを移動します。

移動先に同名のファイルが存在する場合は移動先のファイルを削除します。

パラメータ

entry : DirectoryEntry or FileEntry 移動先のディレクトリを指定します。
name : String 移動時の新しい名前を指定します。未指定の場合は現在の名前を利用します。
successCallback : Function<File> ファイルの移動に成功した場合にCallbackされます。
errorCallback : Function<FileError> ファイルの移動に失敗した場合にCallbackされます。

Return

void

ver.2.0用サンプルコード

//ファイル移動
function moveTo() {
	applican.filesystem.requestFileSystem(LocalFileSystem.PERSISTENT, 0, moveToGotFS, moveToFail);
}

function moveToGotFS(fileSystem) {
	fileSystem.root.getFile("readme.txt", null, moveToGotFileEntry, moveToFail);
}

function moveToGotFileEntry(fileEntry) {
	var tmp = fileEntry.fullPath;
	var parentPath = tmp.substring(0, tmp.lastIndexOf('/'));
	var parentName = parentPath.substring(parentPath.lastIndexOf('/') + 1);
	var parentEntry = new DirectoryEntry(parentName, parentPath);
	fileEntry.moveTo(parentEntry, "readme2.txt", moveToSuccess, moveToFail);
}

function moveToSuccess(entry) {
	var dump = "moveToSuccess\n";
	dump += entry.name + "\n" + entry.fullPath + "\n";
	document.getElementById("dumpAreaFile").value = dump;
}

function moveToFail(error){
	alert("moveToFail: " + error);
}
filesystem.requestFileSystemの第二引数には、サイズの指定が入ります。
現状はサイズ指定に未対応の為、どんな値を設定しても、OSが許す範囲まで自由に使えます。

remove

メソッド説明

remove(Function successCallback, Function<FileError> errorCallback)

ファイルを削除します。

パラメータ

successCallback : Function ファイルの削除に成功した場合にCallbackされます。
errorCallback : Function<FileError> ファイルの削除に失敗した場合にCallbackされます。

Return

void

サンプルコード

//ファイル削除
function removeFile() {
	applican.filesystem.requestFileSystem(LocalFileSystem.PERSISTENT, 0, deleteFileGotFS, deleteFileFail);
}

function removeFileGotFS(fileSystem) {
	fileSystem.root.getFile("readme.txt", null, removeFileGotFileEntry, removeFileFail);
}

function removeFileGotFileEntry(fileEntry) {
	fileEntry.remove(removeFileSuccess, removeFileFail);
}

function removeFileSuccess() {
	var dump = "removeFileSuccess\n";
	document.getElementById("dumpAreaFile").value = dump;
}

function removeFileFail(error) {
	alert("removeFileFail: " + error);
}
requestFileSystemの第二引数には、サイズの指定が入ります。
現状はサイズ指定に未対応の為、どんな値を設定しても、OSが許す範囲まで自由に使えます。

toURL

メソッド説明

toURL() : String

ファイルをアクセス可能な文字列に変換します。

Return

String URL形式の文字列

サンプルコード

//ファイルtoURL
function fileToURL() {
	applican.filesystem.requestFileSystem(LocalFileSystem.PERSISTENT, 0, fileToURLGotFS, fileToURLFail);
}

function fileToURLGotFS(fileSystem) {
	fileSystem.root.getFile("readme.txt", null, fileToURLGotFileEntry, fileToURLFail);
}

function fileToURLGotFileEntry(fileEntry) {
	var fileURL = fileEntry.toURL();
	var dump = "fileToURLGotFileEntry\n";
	dump += fileURL + "\n";
	document.getElementById("dumpAreaFile").value = dump;
}

function fileToURLFail(error) {
	alert("fileToURL_fail: " + error);
}
requestFileSystemの第二引数には、サイズの指定が入ります。
現状はサイズ指定に未対応の為、どんな値を設定しても、OSが許す範囲まで自由に使えます。

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

FileEntry

// ver.1.0
var entry = new FileEntry("bar", "file:///var/.../");

// ver.2.0
var entry = applican.filesystem.createFileEntry("bar", "file:///var/.../");
loading