API Docs for:
Show:

NCMB.File Class

Defined in: lib/file.js:6

ファイルストアへの入出力を扱うクラスです。

このクラスはすべてクラスメソッドで構成されており、インスタンスを生成せずに利用します。 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){
      // エラー処理
      });
      

Methods

NCMB.FileConstructor#delete

(
  • fileName
  • [callback]
)
Promise

Defined in lib/file.js:162

指定したファイルを削除します。

Parameters:

  • fileName String

    削除するファイル名

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.FileConstructor#download

(
  • fileName
  • [responseType]
  • [callback]
)
Promise

Defined in lib/file.js:90

指定したファイルのバイナリデータを取得します。

Parameters:

  • fileName String

    取得するバイナリデータのファイル名

  • [responseType] String optional

    レスポンスバイナリのデータ形式 arraybuffer/blob (ブラウザ/Monaca利用時のみ必要)

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

ファイルのバイナリデータ(付加情報は取得しません)

NCMB.FileConstructor#updateACL

(
  • fileName
  • acl
  • [callback]
)
Promise

Defined in lib/file.js:126

指定したファイルのACL情報を更新します。

Parameters:

  • fileName String

    更新するファイル名

  • acl NCMB.Acl

    更新後のacl情報を設定したncmb.ACLインスタンス

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

APIレスポンス

NCMB.FileConstructor#upload

(
  • fileName
  • fileData
  • [acl]
  • [callback]
)
Promise

Defined in lib/file.js:46

ファイルストアにファイルを保存します。

Parameters:

  • fileName String

    取得するバイナリデータのファイル名

  • fileData Object

    保存するファイルデータ

  • [acl] NCMB.Acl | Function optional

    ファイルに対するアクセス権減

  • [callback] Function optional

Returns:

Promise:

APIレスポンス