applican

マイページに戻る

FileSystemFactory

ファイルシステムに関係するオブジェクトや情報を取得します。

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

  1. アプリカンAPIのver1.0系のFileRootとRequestFileSystemがこのFileSystemFactoryに統合されました。それぞれのリファレンスは以下からご確認ください(FileRootRequestFileSystem)。

メソッド

createDirectoryEntry

メソッド説明

createDirectoryEntry(String name, String path) : DirectoryEntry

指定したパスのDirectoryEntryを生成します。

パラメータ

name : String ディレクトリ名を指定します。
path : String ディレクトリのフルパスを指定します。

Return

DirectoryEntry 指定パスのDirectoryEntryです。

サンプルコード

var directoryEntry = applican.filesystem.createDirectoryEntry("", "file:///...");

createDirectoryReader

メソッド説明

createDirectoryReader(String path) : DirectoryReader

指定したディレクトリのReaderオブジェクトを生成します。

パラメータ

path : String ディレクトリのフルパスを指定します。

Return

DirectoryReader 指定したパスのDirectoryReaderです。

サンプルコード

var reader = applican.filesystem.createDirectoryReader("file:///.../");

createFileEntry

メソッド説明

createFileEntry(String name, String path) : FileEntry

フルパスで指定したファイルのFileEntryを生成します。

パラメータ

name : String ファイルの名前を指定します。
path : String ファイルのフルパスを指定します。

Return

FileEntry 取得したFileEntryを返却します。

サンプルコード

var file = applican.filesystem.createFileEntry("", "file:///.../foo.txt");

createFileReader

メソッド説明

createFileReader() : FileReader

ファイル読み込みのためのReaderオブジェクトを生成します。

Return

FileReader Readerオブジェクトを返却します。

サンプルコード

var reader = applican.filesystem.createFileReader("file:///.../foo.txt");

createFileTransfer

メソッド説明

createFileTransfer() : FileTransfer

ファイルのアップロードダウンロードを扱うFileTransferを生成します。

Return

FileTransfer 生成したFileTransferを返却します。

サンプルコード

ver transfer = applican.filesystem.createFileTransfer();

createFileWriter

メソッド説明

createFileWriter(File file) : FileWriter

指定したファイルのWriterオブジェクトを生成します。

パラメータ

file : File 書き込みをしたいファイルを指定します。

Return

FileWriter 生成したいFileWriterを返却します。

サンプルコード

var writer = applican.filesystem.createFileReader("file:///.../foo.txt");

getApplicationCacheRoot

メソッド説明

getApplicationCacheRoot(Function<String> successCallback, Function<FileError> errorCallback)

アプリケーション内部の一時ファイル保存ディレクトリのパスを取得します。

パラメータ

successCallback : Function<String> パスの取得に成功した場合にCallbackされます。
errorCallback : Function<FileError> パスの取得に失敗した場合にCallbackされます。

Return

void

サンプルコード

function success(result) {
	console.log("getApplicationCacheRoot() successful.", result);
}

function failure(error) {
	console.log("getApplicationCacheRoot() failure.", error);
}

applican.filesystem.getApplicationCacheRoot(success, failure);

getApplicationExternalCacheRoot

メソッド説明

getApplicationExternalCacheRoot(Function<String> successCallback, Function<FileError> errorCallback)

SDカード等アプリ外部の一時ファイル保存ディレクトリのパスを取得します。

パラメータ

successCallback : Function<String> パスの取得に成功した場合にCallbackされます。
errorCallback : Function<FileError> パスの取得に失敗した場合にCallbackされます。

Return

void

サンプルコード

function success(result) {
	console.log("getApplicationExternalCacheRoot() successful.", result);
}

function failure(error) {
	console.log("getApplicationExternalCacheRoot() failure.", error);
}

applican.filesystem.getApplicationExternalCacheRoot(success, result);

getApplicationExternalFilesRoot

メソッド説明

getApplicationExternalFilesRoot(Function<String> successCallback, Function<FileError> errorCallback)

SDカード等アプリ外部のファイル保存ディレクトリのパスを取得します。

パラメータ

successCallback : Function<String> パスの取得に成功した場合にCallbackされます。
errorCallback : Function<FileError> パスの取得に失敗した場合にCallbackされます。

Return

void

サンプルコード

function success(result) {
	console.log("getApplicationExternalFilesRoot() successful.", result);
}

function failure(error) {
	console.log("getApplicationExternalFilesRoot() failure.", error);
}

applican.filesystem.getApplicationExternalFilesRoot(success, failure);

getApplicationFilesRoot

メソッド説明

getApplicationFilesRoot(Function<String> successCallback, Function<FileError> errorCallback)

アプリ内部のファイル保存ディレクトリのパスを取得します。

Androidの場合、アプリ情報から「ファイル削除」又は「データ削除」を実行すると、このメソッドにより取得されるディレクトリの中身が全て削除されます。

※iPhoneの場合、filesystem.getApplicationExternalFilesRootfilesystem.getApplicationFilesRootで取得できる結果は同じです。

パラメータ

successCallback : Function<String> パスの取得に成功した場合にCallbackされます。
errorCallback : Function<FileError> パスの取得に失敗した場合にCallbackされます。

Return

void

サンプルコード

function success(result) {
	console.log("getApplicationFilesRoot() successful.", result);
}

function failure(error) {
	console.log("getApplicationFilesRoot() failure.", error);
}

applican.filesystem.getApplicationFilesRoot(success, failure);

requestFileSystem

メソッド説明

requestFileSystem(LocalFileSystemType type, Number size, Function<FileSystem> successCallback, Function<FileError> errorCallback)

ファイルの作成を要求します。

パラメータ

type : LocalFileSystemType 一時的な保存か、永続的な保存かを指定します。
size : Number ファイルのサイズを指定します。
successCallback : Function<FileSystem> 要求が成功した場合にCallbackされます。
errorCallback : Function<FileError> 要求が失敗した場合にCallbackされます。

Return

void

サンプルコード

var fileSystem;

function success(result) {
	console.log("requestFileSystem() successful.");
	fileSystem = result;
}

function failure(error) {
	console.log("requestFileSystem() failure.", error);
}

applican.filesystem.requestFileSystem(LocalFileSystem.TEMPORARY, 4096, success, failure);
loading