BoxStorageオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.4 |
since | 8.0.4 |
Boxのファイルサービスにアクセスするためのクラスです。
saveメソッドなどStorage互換のAPIを提供します。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
saveメソッドなどStorage互換のAPIを提供します。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
- Box にてアプリケーションが登録・設定されていること
- intra-mart Accel Platformのユーザに対応するBoxユーザIDが存在すること
- モジュール構成にて「Box 連携」モジュールを選択し WARファイルが作成されていること
- Box 開発者コンソールからダウンロードした設定ファイルを intra-mart Accel Platform にアップロードされていること
- 実装例は以下の通りです。
var boxStorage = new BoxStorage('/foo/bar/baz.pdf', boxUserId); boxStorage.save(request.uploadFile);
コンストラクタの概要
BoxStorage (String path , String boxUserId ) コンストラクタ。path を指し、boxUserId で指定するユーザでアクセスする BoxStorage を作成します。標準のクライアントIDを用います。 |
BoxStorage (String path , String boxUserId , String clientId ) コンストラクタ。path を指し、boxUserId で指定するユーザでアクセスする BoxStorage を作成します。clientIdで指定したクライアントIDを用います。 |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
Boolean | append (String src , String [charsetName] ) 文字列を指定されたキャラセット名で変換しこのストレージに追記します。 |
void | clearCache () このストレージが持つファイルのメタ情報のキャッシュを削除します。 |
Boolean | copy (BoxStorage to , Boolean [overwrite] ) このファイル、またはディレクトリを引数で指定された対象にコピーします。 |
BoxStorage[] | directoriesStorages (Boolean [recursive] ) このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。 |
String[] | directories (Boolean [recursive] ) このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。 |
Boolean | exists () このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。 |
BoxStorage[] | filesStorages (Boolean recursive ) このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。 |
String[] | files (Boolean [recursive] ) このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。 |
String | getCanonicalPath () 正規化したパスを返します。 |
String | getName () このストレージが示すファイルまたはディレクトリの名前を返します。 |
BoxStorage | getParentStorage () 親ストレージを返します。 |
String | getParent () 親パスを返します。 |
String | getPath () パス名文字列を返します。 |
String | getRelativePath (BoxStorage target ) このストレージとの相対パスを返します。 |
BoxStorage | getRootStorage () ルートストレージを返します。 |
Boolean | hasContentCache () ファイルコンテンツの情報をキャッシュしているか否かを取得します。 |
Boolean | hasInfoCache () ファイルのメタ情報をキャッシュしているか否かを取得します。 |
Boolean | isDirectory () このストレージが示すファイルがディレクトリであるかどうかを判定します。 |
Boolean | isFile () このストレージが示すファイルが普通のファイルかどうかを判定します。ファイルは、それがディレクトリではなく、システムに依存するほかの基準を満たす場合に「普通」のファイルと見なされます。 |
Number | lastModified () このストレージが示すファイルが最後に変更された時刻を返します。 |
Number | length () このストレージが指定されているファイルの長さを返します。パス名にディレクトリが指定されている場合、戻り値は指定されません。 |
BoxStorage[] | listStorages (Object [filterOrRecursive] ) このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。 |
String[] | list (Object [filterOrRecursive] ) このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。 |
String | load () 非推奨 このストレージの内容を取得します。
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
|
Boolean | makeDirectories () このストレージが示すディレクトリを生成します。 |
String | read (String [charsetName] ) 非推奨このストレージの内容を指定されたキャラセット名で変換し文字列で取得します。
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、 転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
|
Boolean | remove (Boolean [recursive] ) このストレージが示すファイルまたはディレクトリを削除します。 |
BoxStorage | resolve (String other ) このストレージから相対ストレージを返します。 |
Boolean | save (String byteStream ) ファイルの中身をこのストレージに書き込みます。 |
Boolean | write (String src , String [charsetName] ) 文字列を指定されたキャラセット名でこのストレージに書き込みます。 |
コンストラクタの詳細
BoxStorage (String path , String boxUserId )
コンストラクタ。path を指し、boxUserId で指定するユーザでアクセスする BoxStorage を作成します。標準のクライアントIDを用います。
パラメータ
|
BoxStorage (String path , String boxUserId , String clientId )
コンストラクタ。path を指し、boxUserId で指定するユーザでアクセスする BoxStorage を作成します。clientIdで指定したクライアントIDを用います。
パラメータ
|
メソッドの詳細
Boolean append (String src , String [charsetName] )
文字列を指定されたキャラセット名で変換しこのストレージに追記します。
パラメータ
返却値
|
void clearCache ()
このストレージが持つファイルのメタ情報のキャッシュを削除します。
返却値
|
Boolean copy (BoxStorage to , Boolean [overwrite] )
このファイル、またはディレクトリを引数で指定された対象にコピーします。
このインスタンスが存在しない場合:
パラメータ
返却値
|
BoxStorage[] directoriesStorages (Boolean [recursive] )
このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。
パラメータ
返却値
|
String[] directories (Boolean [recursive] )
このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。 ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。 ROOT ┗directory-1 ┗directory-1-1 ┣directory-1-1-1 ┃┣directory-1-1-1-1 ┃┗file-1-1-1-2 ┣directory-1-1-2 ┣file-1-1-3 ┗file-1-1-4上記のようなファイル構成である場合、 directory-1-1に対してdirectories(false)を実行した場合の戻り値は以下の通りです。
パラメータ
返却値
|
Boolean exists ()
このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。
返却値
|
BoxStorage[] filesStorages (Boolean recursive )
このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。
パラメータ
返却値
|
String[] files (Boolean [recursive] )
このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。 ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。 ROOT ┗directory-1 ┗directory-1-1 ┣directory-1-1-1 ┃┣directory-1-1-1-1 ┃┗file-1-1-1-2 ┣directory-1-1-2 ┣file-1-1-3 ┗file-1-1-4上記のようなファイル構成である場合、 directory-1-1に対してfiles(false)を実行した場合の戻り値は以下の通りです。
パラメータ
返却値
|
String getCanonicalPath ()
正規化したパスを返します。
返却値
|
String getName ()
このストレージが示すファイルまたはディレクトリの名前を返します。
返却値
|
BoxStorage getParentStorage ()
親ストレージを返します。
返却値
|
String getParent ()
親パスを返します。
返却値
|
String getPath ()
パス名文字列を返します。
返却値
|
String getRelativePath (BoxStorage target )
このストレージとの相対パスを返します。
パラメータ
返却値
|
BoxStorage getRootStorage ()
ルートストレージを返します。
返却値
|
Boolean hasContentCache ()
ファイルコンテンツの情報をキャッシュしているか否かを取得します。
返却値
|
Boolean hasInfoCache ()
ファイルのメタ情報をキャッシュしているか否かを取得します。
返却値
|
Boolean isDirectory ()
このストレージが示すファイルがディレクトリであるかどうかを判定します。
返却値
|
Boolean isFile ()
このストレージが示すファイルが普通のファイルかどうかを判定します。ファイルは、それがディレクトリではなく、システムに依存するほかの基準を満たす場合に「普通」のファイルと見なされます。
アプリケーションが生成したディレクトリ以外のファイルは、必ず普通のファイルです。
返却値
|
Number lastModified ()
このストレージが示すファイルが最後に変更された時刻を返します。
返却値
|
Number length ()
このストレージが指定されているファイルの長さを返します。パス名にディレクトリが指定されている場合、戻り値は指定されません。
返却値
|
BoxStorage[] listStorages (Object [filterOrRecursive] )
このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。
パラメータ
返却値
|
String[] list (Object [filterOrRecursive] )
このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。 引数にファイル名フィルタが渡された場合、関数 の第 1 引数に listを実行した BoxStorage が、第 2 引数に 対象のファイル名 を渡します。 関数の戻り値がtrueである場合、対象が取得対象となります。 ディレクトリが空の場合は空コレクションを返します。 このストレージがディレクトリを示さない場合は null を返します。 ROOT ┗directory-1 ┗directory-1-1 ┣directory-1-1-1 ┃┣directory-1-1-1-1 ┃┗file-1-1-1-2 ┣directory-1-1-2 ┣file-1-1-3 ┗file-1-1-4上記のようなファイル構成である場合、 directory-1-1に対してlist(false)を実行した場合の戻り値は以下の通りです。
パラメータ
返却値
|
String load ()
非推奨
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
このストレージの内容を取得します。
返却値
|
Boolean makeDirectories ()
このストレージが示すディレクトリを生成します。
返却値
|
String read (String [charsetName] )
非推奨
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、 転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに
openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
このストレージの内容を指定されたキャラセット名で変換し文字列で取得します。
パラメータ
返却値
|
Boolean remove (Boolean [recursive] )
このストレージが示すファイルまたはディレクトリを削除します。
recursive に明示的に true が渡されたときのみ、再帰的に削除します。
パラメータ
返却値
|
BoxStorage resolve (String other )
このストレージから相対ストレージを返します。
現在のパスから other だけ移動した新しい BoxStorage を返す。 例: new BoxStorage('a/b/c').resolve('..') -> 'a/b' を指す BoxStorage
パラメータ
返却値
|
Boolean save (String byteStream )
ファイルの中身をこのストレージに書き込みます。
パラメータ
返却値
|
Boolean write (String src , String [charsetName] )
文字列を指定されたキャラセット名でこのストレージに書き込みます。
パラメータ
返却値
|