Documentation

Class: FileBucket

FileBucket

ファイルバケット

new FileBucket(name)

FileBucket インスタンスを生成する

Parameters:
Name Type Description
name

バケット名
Example
var bucket = new Nebula.FileBucket("bucket1");

Methods

<static> getBucketList(callbacks)

ファイルバケットのバケット名一覧を取得する

Parameters:
Name Type Description
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(bucketList)
            bucketList : ファイルバケット名の配列
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
callbacks = {
         success: function(bucketList) {....},
         error: function(error) {....}
     };
     Nebula.FileBucket.getBucketList(callbacks);

<static> loadBucket(name, callbacks)

ファイルバケットを取得する

Parameters:
Name Type Description
name String

ファイルバケット名
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(bucket)
            bucket : Nebula.FileBucketインスタンス
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : ファイルバケット名(nameに同じ)
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
callbacks = {
         success: function(bucket) {....},
         error: function(err) {....}
     };
     Nebula.FileBucket.loadBucket(callbacks);

<static> selectDirectory(callbacks)

ディレクトリを選択する(SDE4SD).

本APIはオフライン(SDE4SD)のみで利用可能

Parameters:
Name Type Description
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(dir)
            dir : 選択したディレクトリへのパス(文字列)
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var callbacks = {
         success: function(dir) {....},
         error: function(err) {....}
     };
     Nebula.FileBucket.selectDirectory(callbacks);

<static> selectUploadFile(callbacks)

アップロードするファイルを選択する(SDE4SD).

本APIはオフライン(SDE4SD)のみで利用可能

Parameters:
Name Type Description
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(fileInfo)
            fileInfo : 選択したファイル情報(以下のJSON形式)
                         { "path" : "ファイルのパス情報",
                           "name" : "ファイル名",
                           "type" : "コンテンツタイプ" }
                         ※ コンテンツタイプを特定できない場合は空白
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var callbacks = {
         success: function(fileInfo) {....},
         error: function(err) {....}
     };
     Nebula.FileBucket.selectUploadFile(callbacks);

delete()

ファイルバケットからファイルを削除する(Deprecated)

Deprecated:
  • since v4.0.1
Example
・本APIは Deprecated である。remove() を使用すること。

deleteBucket(callbacks)

ファイルバケットを削除する

Parameters:
Name Type Description
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(bucket)
            bucket : Nebula.FileBucket インスタンス
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : Nebula.FileBucket インスタンス
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = new Nebula.FileBucket("Person");
     ....
     callbacks = {
         success: function(bucket) {....},
         error: function(err) {....}
     };
     bucket.deleteBucket(callbacks);

downloadFile(fileName, filePath, callbacks)

ファイルをダウンロードする (SDE4SD).

本APIはオフライン(SDE4SD)のみで利用可能

Parameters:
Name Type Description
fileName String

ファイルバケットからダウンロードするファイルの名前
filePath String

ダウンロードするファイルの保存先(ファイル名を含む絶対パス)
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(fileName)
            fileName : ダウンロードが完了したファイル名
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     callbacks = {
         success: function(fileName) {....},
         error: function(err) {....}
     };
     bucket.download("MyFile.jpg", "/sdcard/MyFile.jpg", callbacks);

getAcl()

ファイルバケットのACLを取得する.

ファイルバケットのACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある

Returns:

ファイルバケットのACL

Type
Acl
Example
var bucket = ....;
     ....
     var acl = bucket.getAcl();

getBucketName()

ファイルバケット名を取得する

Returns:

ファイルバケット名

Type
String
Example
var bucket = ....;
     ....
     var bucketName = bucket.getBucketName();

getContentAcl()

ファイルバケットのコンテンツACLを取得する.

ファイルバケットのコンテンツACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある

Returns:

ファイルバケットのコンテンツACL

Type
Acl
Example
var bucket = ....;
     ....
     var acl = bucket.getAcl();

getDescription()

ファイルバケットの「説明文」を取得する.

ファイルバケットのコンテンツACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある

Returns:

ファイルバケットの「説明文」

Type
String
Example
var bucket = ....;
     ....
     var description = bucket.getDescription();

getList(callbacks)

ファイルバケットからファイル一覧を取得する

Parameters:
Name Type Description
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : ファイルのメタデータ(Nebula.FileMetadataインスタンス)の配列
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     callbacks = {
         success: function(metadata) {....},
         error: function(err) {....}
     };
     bucket.getList(callbacks);

getMetadata(fileName, callbacks)

ファイルバケットから指定されたファイルのメタデータを取得する

Parameters:
Name Type Description
fileName String

メタデータを取得するファイルの名前
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : ファイルのメタデータ(Nebula.FileMetadataインスタンス)
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     callbacks = {
         success: function(metadata) {....},
         error: function(err) {....}
     };
     bucket.getMetadata("MyFile.jpg", callbacks);

getPublishedList(callbacks)

ファイルバケットから公開ファイル一覧を取得する

Parameters:
Name Type Description
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : ファイルのメタデータ(Nebula.FileMetadataインスタンス)の配列
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     callbacks = {
         success: function(metadata) {....},
         error: function(err) {....}
     };
     bucket.getPublishedList(callbacks);

load(fileName, callbacks)

ファイルバケットからファイルを読み込む.

HTML5 File APIに対応しているブラウザ、または Node.js のみで実行可能。

Parameters:
Name Type Description
fileName String

ファイルバケットから読み込むファイルの名前
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(data)
            data : ファイルの内容が格納されたBlobオブジェクト (node.js の場合は Buffer オブジェクト)
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     callbacks = {
         success: function(blob) {....},
         error: function(err) {....}
     };
     bucket.load("MyFile.jpg", callbacks);

publish(fileName, callbacks)

ファイルバケットのファイルを公開する.

既に公開されたファイルを再公開しても公開 URL は変更されない。

Parameters:
Name Type Description
fileName String

公開するファイルの名前
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : このファイルのメタデータ
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     callbacks = {
         success: function(metadata) {....},
         error: function(err) {....}
     };
     bucket.publish("MyFile.jpg", callbacks);

remove(fileName, callbacks)

ファイルバケットからファイルを削除する.

Parameters:
Name Type Description
fileName String

ファイルバケットから削除するファイルの名前
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(fileName)
            fileName : 引数で指定されたfileNameと同じ
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Since:
  • v4.0.1
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     callbacks = {
         success: function(fileName) {....},
         error: function(err) {....}
     };
     bucket.remove("fileName", callbacks);

save(fileName, data, callbacks)

ファイルバケットのファイルを保存する.

HTML5 File APIに対応しているブラウザ、または Node.js のみで実行可能。

Parameters:
Name Type Description
fileName String

ファイルバケットへ保存するファイル名
data Object

文字列、File/Blobオブジェクト、または Buffer オブジェクト

サーバに保存するファイルのデータを以下のいずれかで指定する。
・保存するファイルにバインドされたFileオブジェクト
・保存するファイルのデータ。文字列/Blobオブジェクト/Bufferオブジェクトのいずれか。
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : Nebula.FileMetadata インスタンス
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     var file = ....;
     ....
     callbacks = {
         success: function(metadata) {....},
         error: function(err) {....}
     };
     bucket.save("MyFileName.jpg", file, callbacks);

saveAs(fileName, data, metadata, callbacks)

ファイルバケットへファイルを新規保存する.

HTML5 File APIに対応しているブラウザ、もしくは Node.js のみで実行可能。

Parameters:
Name Type Description
fileName String

ファイルバケットへ保存するファイル名
data Object

文字列、File/Blobオブジェクト、または Buffer オブジェクト

サーバに保存するファイルのデータを以下のいずれかで指定する。
・保存するファイルにバインドされたFileオブジェクト
・保存するファイルのデータ。文字列/Blobオブジェクト/Bufferオブジェクトのいずれか。
metadata FileMetadata

保存するファイルのメタデータ

指定できるメタデータは以下の通りである。(他のメタデータは参照されない)
・ACL (オプション、省略可)
・コンテンツタイプ (必須、省略不可)
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : Nebula.FileMetadata インスタンス
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     var file = ....;
     ....
     var meta = new Nebula.FileMetadata();
     meta.setContentType("image/jpeg");
     callbacks = {
         success: function(metadata) {....},
         error: function(err) {....}
     };
     bucket.saveAs("MyFileName.jpg", file, meta, callbacks);

saveBucket(callbacks)

ファイルバケットを保存する

Parameters:
Name Type Description
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(bucket)
            bucket : Nebula.FileBucket インスタンス
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ
                 "data"          : Nebula.FileBucket インスタンス
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = new Nebula.FileBucket("Person");
     ....
     callbacks = {
         success: function(bucket) {....},
         error: function(err) {....}
     };
     bucket.saveBucket(callbacks);

setAcl(acl)

ファイルバケットのACLを設定する.

本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
サーバと同期するには、saveBucket()を呼び出す必要がある。

Parameters:
Name Type Description
acl Acl

Aclインスタンス
Returns:

this

Type
FileBucket
Example
var bucket = ....;
     var acl = new Nebula.Acl();
     ....
     acl.addEntry(....);
     ....
     bucket.setAcl(acl);

setContentAcl(acl)

ファイルバケットのコンテンツACLを設定する.

本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
サーバと同期するには、saveBucket()を呼び出す必要がある。

Parameters:
Name Type Description
acl Acl

Nebula.ACL のインスタンス
Returns:

this

Type
FileBucket
Example
var bucket = ....;
     var acl = new Nebula.Acl();
     ....
     acl.addEntry(....);
     ....
     bucket.setContentAcl(acl);

setDescription(description)

ファイルバケットに「説明文」を設定する.

本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
サーバと同期するには、saveBucket()を呼び出す必要がある。

Parameters:
Name Type Description
description String

設定する「説明文」
Returns:

this

Type
FileBucket
Example
var bucket = ....;
     var acl = new Nebula.Acl();
     ....
     acl.addEntry(....);
     ....
     bucket.setDescription("このバケットの説明文”);

unpublish(fileName, callbacks)

ファイルバケットのファイルを非公開する

Parameters:
Name Type Description
fileName String

非公開にするファイルの名前
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : このファイルのメタデータ
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     callbacks = {
         success: function(metadata) {....},
         error: function(err) {....}
     };
     bucket.unpublish("MyFile.jpg", callbacks);

updateMetadata(fileName, metadata, callbacks)

ファイルバケットの指定されたファイルのメタデータを更新する

Parameters:
Name Type Description
fileName String

メタデータを更新するファイルの名前
metadata FileMetadata

更新メタデータ
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : ファイルのメタデータ(Nebula.FileMetadataインスタンス)
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     ....
     var meta = ....;
     ....
     callbacks = {
         success: function(metadata) {....},
         error: function(err) {....}
     };
     bucket.updateMetadata("MyFile.jpg", meta, callbacks);

uploadNewFile(fileName, filePath, metadata, callbacks)

ファイルを新規アップロードする(SDE4SD).

本APIはオフライン(SDE4SD)のみで利用可能

Parameters:
Name Type Description
fileName String

ファイルバケットへ保存するファイル名
filePath String

保存する元ファイルの絶対パス(ファイル名含む)
metadata FileMetadata

保存するファイルのメタデータ

指定できるメタデータは以下の通りである。(他のメタデータは参照されない)
・ACL (オプション、省略可)
・コンテンツタイプ (必須、省略不可)
・キャッシュフラグ (必須、省略不可)
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : Nebula.FileMetadata インスタンス
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     Nebula.FileBucket.selectUploadFile({
         success: function(fileInfo) {
             var meta = new Nebula.FileMetadata();
             meta.setContentType(fileInfo.type);
             meta.setCacheDisabled(false);

             var callbacks = {
                 success: function(metadata) {....},
                 error: function(err) {....}
             };
             bucket.uploadNewFile(fileInfo.name, fileInfo.path, meta, callbacks);
         },
         error: function(err) {....}
     });

uploadUpdateFile(fileName, filePath, metadata, callbacks)

ファイルを更新アップロードする(SDE4SD).

本APIはオフライン(SDE4SD)のみで利用可能

Parameters:
Name Type Description
fileName String

ファイルバケットへ保存するファイル名
filePath String

保存する元ファイルの絶対パス(ファイル名含む)
metadata FileMetadata

保存するファイルのメタデータ

指定できるメタデータは以下の通りである。(他のメタデータは参照されない)
・ACL (オプション、省略可)
・コンテンツタイプ (必須、省略不可)
・キャッシュフラグ (必須、省略不可)
callbacks Callbacks

成功時と失敗時の応答コールバック

・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(metadata)
            metadata : Nebula.FileMetadata インスタンス
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(err)
            err : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ,
                 "data"          : 引数で指定されたfileName
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise
Example
var bucket = ....;
     Nebula.FileBucket.selectUploadFile({
         success: function(fileInfo) {
             var meta = new Nebula.FileMetadata();
             meta.setContentType(fileInfo.type);
             meta.setCacheDisabled(false);

             var callbacks = {
                 success: function(metadata) {....},
                 error: function(err) {....}
             };
             bucket.uploadUpdateFile(fileInfo.name, fileInfo.path, meta, callbacks);
         },
         error: function(err) {....}
     });