NCMB.File Class
ファイルストアへの入出力を扱うクラスです。
このクラスはすべてクラスメソッドで構成されており、インスタンスを生成せずに利用します。 Queryではファイルの付加情報(ファイル名、更新日時など)のみを検索・取得し、ファイルのバイナリデータそのものは取得しません。 バイナリデータを取得したい場合はdownloadメソッドを利用してください。
※注意: 2種類のメソッド(インスタンスメソッド Instance method とスタティックメソッド Static method)があります。 それぞれリファレンス上の表記と利用時のメソッドが異なりますので、下記を参考にご利用ください。
- リファレンス上の表記が「NCMB.File#メソッド名」: インスタンスメソッド Instance method
- Fileの場合は、お客様に提供するインスタンスメソッドはありません
- リファレンス上の表記が「NCMB.FileConstructor#メソッド名」: スタティックメソッド Static method
- 利用例)NCMB.FileConstructor#download
ncmb.File.download("abc.txt") .then(function(fileData){ // ファイル取得後処理 }) .catch(function(err){ // エラー処理 });
- 利用例)NCMB.FileConstructor#download
Item Index
Methods
NCMB.FileConstructor#delete
(
Promise-
fileName
-
[callback]
指定したファイルを削除します。
Parameters:
-
fileName
String削除するファイル名
-
[callback]
Function optionalコールバック関数
Returns:
Promise :
NCMB.FileConstructor#download
(
Promise-
fileName
-
[responseType]
-
[callback]
指定したファイルのバイナリデータを取得します。
Parameters:
-
fileName
String取得するバイナリデータのファイル名
-
[responseType]
String optionalレスポンスバイナリのデータ形式 arraybuffer/blob (ブラウザ/Monaca利用時のみ必要)
-
[callback]
Function optionalコールバック関数
Returns:
Promise :
ファイルのバイナリデータ(付加情報は取得しません)
NCMB.FileConstructor#updateACL
(
Promise-
fileName
-
acl
-
[callback]
指定したファイルのACL情報を更新します。
Parameters:
-
fileName
String更新するファイル名
-
acl
NCMB.Acl更新後のacl情報を設定したncmb.ACLインスタンス
-
[callback]
Function optionalコールバック関数
Returns:
Promise :
APIレスポンス
NCMB.FileConstructor#upload
(
Promise-
fileName
-
fileData
-
[acl]
-
[callback]
ファイルストアにファイルを保存します。
Parameters:
-
fileName
String取得するバイナリデータのファイル名
-
fileData
Object保存するファイルデータ
-
[acl]
NCMB.Acl | Function optionalファイルに対するアクセス権減
-
[callback]
Function optional
Returns:
Promise :
APIレスポンス