API Docs for:
Show:

NCMB.File Class

Defined in: lib/file.js:6

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

このクラスはすべてクラスメソッドで構成されており、インスタンスを生成せずに利用します。 Queryではファイルの付加情報(ファイル名、更新日時など)のみを検索・取得し、ファイルのバイナリデータそのものは取得しません。 バイナリデータを取得したい場合はdownloadメソッドを利用してください。

Methods

File.delete

(
  • fileName
  • callback
)

Defined in lib/file.js:142

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

Parameters:

  • fileName String

    削除するファイル名

  • callback Function

    コールバック関数

File.download

(
  • fileName
  • responseType
  • callback
)

Defined in lib/file.js:70

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

Parameters:

  • fileName String

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

  • responseType String

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

  • callback Function

    コールバック関数

Returns:

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

File.updateACL

(
  • fileName
  • acl
  • callback
)
Object

Defined in lib/file.js:106

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

Parameters:

  • fileName String

    更新するファイル名

  • acl ncmb.ACL

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

  • callback Function

    コールバック関数

Returns:

Object:

APIレスポンス

File.upload

(
  • fileName
  • fileData
  • acl
)
Object

Defined in lib/file.js:27

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

Parameters:

  • fileName String

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

  • fileData Object

    保存するファイルデータ

  • acl NCMB.Acl

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

Returns:

Object:

APIレスポンス