NCMBFile Class Reference

Inherits from	NCMBObject : NSObject
Declared in	NCMBFile.h

Overview

NCMBFileクラスは、ニフクラ mobile backend上でアプリに必要な画像や動画、様々なバイナリデータを管理するクラスです。

このクラスはNCMBObjectを継承していますが、REST APIでファイルクラスのフィールド更新ができないため、 setObject:forKey: や addObject:forKey: などは対応していません。対応していないメソッドは以下の通りです。

relationForKey:
addObject:forKey:
addObjectsFromArray:forKey:
addUniqueObject:forKey:
addUniqueObjectsFromArray:forKey:
removeObject:forKey:
removeObjectsInArray:forKey:
removeObjectForKey:
incrementKey:
incrementKey:byAmount:
saveEventually:
refresh:
refreshInBackgroundWithBlock:
refreshInBackgroundWithTarget:selector:
fetch:
fetchInBackgroundWithBlock:
fetchInBackgroundWithTarget:selector:
deleteEventually:

Properties

`name`

ファイル名

@property (readonly) NSString *name

Declared In

NCMBFile.h

`url`

ファイルを取得するためのURL

@property (readonly) NSString *url

Declared In

NCMBFile.h

Create

`+ fileWithData:`

指定したデータ(NSData)を持つNCMBFileのインスタンスを生成

+ (id)fileWithData:(NSData *)data

Parameters

`data`	指定するデータ(NSData)

Return Value

id型 NCMBFileのインスタンス

Declared In

NCMBFile.h

`+ fileWithName:data:`

指定したファイル名とデータ(NSData)を持つNCMBFileのインスタンスを生成

+ (id)fileWithName:(NSString *)name data:(NSData *)data

Parameters

`name`	指定するファイル名
`data`	指定するデータ(NSData)

Return Value

id型 NCMBFileのインスタンス

Declared In

NCMBFile.h

`+ fileWithName:contentsAtPath:`

指定したファイルパスで取得したデータと指定したファイル名を持つNCMBFileのインスタンスを生成

+ (id)fileWithName:(NSString *)name contentsAtPath:(NSString *)path

Parameters

`name`	指定するファイル名
`path`	指定するファイルパス

Return Value

id型 NCMBFileのインスタンス

Declared In

NCMBFile.h

`isDirty`

指定したファイルがサーバ上と同じ内容かどうかを判断。変更があった場合や、生成のみで未保存状態の場合はtrueを返す。サーバにsave済の場合はfalseを返す。

@property (readonly) BOOL isDirty

Declared In

NCMBFile.h

Save

`– saveInBackgroundWithBlock:progressBlock:`

データを非同期で保存。保存の進度により定期的にprogressBlockを呼び出し、100パーセントに達し保存がし終わったらblockを呼び出す。

- (void)saveInBackgroundWithBlock:(NCMBErrorResultBlock)block progressBlock:(NCMBProgressBlock)progressBlock

Parameters

`block`	保存完了後に実行されるblock。blockは次の引数のシグネチャを持つ必要がある（NSError *error） errorにはエラーがあればエラーのポインタが渡され、なければnilが渡される。
`progressBlock`	保存進度により定期的に実行されるblock。blockは次の引数のシグネチャを持つ必要がある（int percentDone）

Declared In

NCMBFile.h

Get

`isDataAvailable`

データがあるかどうかを判断。データがあればtrueを返す。

@property (readonly) BOOL isDataAvailable

Declared In

NCMBFile.h

`– getData:`

データの取得。必要があればエラーをセットし、取得することもできる。

- (NSData *)getData:(NSError **)error

Parameters

`error`	処理中に起きたエラーのポインタ

Return Value

NSData型取得データ

Declared In

NCMBFile.h

`– getDataInBackgroundWithBlock:`

データを非同期で取得。取得し終わったら与えられたblockを呼び出す。

- (void)getDataInBackgroundWithBlock:(NCMBDataResultBlock)block

Parameters

`block`	通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある（NSData data, NSError error） resultには取得したデータが渡される。errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBFile.h

`– getDataInBackgroundWithBlock:progressBlock:`

データを非同期で取得。取得の進度により定期的にprogressBlockを呼び出し、100パーセントに達し取得し終わったらresultBlockを呼び出す。

- (void)getDataInBackgroundWithBlock:(NCMBDataResultBlock)resultBlock progressBlock:(NCMBProgressBlock)progressBlock

Parameters

`resultBlock`	取得完了後に実行されるblock。resultBlockは次の引数のシグネチャを持つ必要がある（NSData data, NSError error）
`progressBlock`	取得進度により定期的に実行されるblock。progressBlockは次の引数のシグネチャを持つ必要がある（int percentDone）

Declared In

NCMBFile.h

`– getDataInBackgroundWithTarget:selector:`

データを非同期で取得。取得し終わったら指定されたコールバックを呼び出す。

- (void)getDataInBackgroundWithTarget:(id)target selector:(SEL)selector

Parameters

`target`	呼び出すセレクタのターゲット
`selector`	呼び出すセレクタ。次のシグネチャを持つ必要がある。 (void)callbackWithResult:(NSData )result error:(NSError *)error resultには取得したデータが渡される。errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBFile.h

Transfer

`– cancel`

通信のキャンセルを行う

- (void)cancel

Declared In

NCMBFile.h

Query

`+ query`

ファイルを検索するためのNCMBQueryを生成

+ (NCMBQuery *)query

Return Value

NCMBQueryのインスタンス

Declared In

NCMBFile.h

`– refresh:`

同期通信を利用してmobile backendからobjectIdをキーにしてデータを取得する。

- (void)refresh:(NSError **)error

Parameters

`error`	エラーを保持するポインタ

Discussion

refreshを実行する前にセットされた値はリセットされる。

Declared In

NCMBObject.h

`– refreshInBackgroundWithBlock:`

非同期通信を利用してmobile backendからobjectIdをキーにしてデータを取得し、指定されたコールバックを呼び出す。

- (void)refreshInBackgroundWithBlock:(NCMBObjectResultBlock)block

Parameters

`block`	通信後に実行されるblock。引数にNSError *errorを持つ。

Discussion

refreshを実行する前にセットされた値はリセットされる。

Declared In

NCMBObject.h

`– refreshInBackgroundWithTarget:selector:`

非同期通信を利用してmobile backendからobjectIdをキーにしてデータを取得し、指定されたセレクタを呼び出す。

- (void)refreshInBackgroundWithTarget:(id)target selector:(SEL)selector

Parameters

`target`	呼び出すセレクタのターゲット
`selector`	実行するセレクタ

Discussion

refreshを実行する前にセットされた値はリセットされる。

Declared In

NCMBObject.h

`– fetch:`

同期通信を利用してmobile backendからobjectIdをキーにしてデータを取得する。

- (void)fetch:(NSError **)error

Parameters

`error`	エラーを保持するポインタ

Discussion

fetchを実行する前にセットされた値と統合されるが、サーバー上にすでにキーがあった値は上書きされる。

Declared In

NCMBObject.h

`– addObject:forKey:`

キーで指定された配列の末尾にオブジェクトを追加

- (void)addObject:(id)object forKey:(NSString *)key

Parameters

`object`	追加するオブジェクト
`key`	追加する配列のキー

Declared In

NCMBObject.h

`– addObjectsFromArray:forKey:`

キーで指定された配列の末尾に複数のオブジェクトを追加

- (void)addObjectsFromArray:(NSArray *)objects forKey:(NSString *)key

Parameters

`objects`	追加する複数のオブジェクト
`key`	追加する配列のキー

Declared In

NCMBObject.h

`– addUniqueObject:forKey:`

キーで指定した配列に指定したオブジェクトを追加する。オブジェクトの順序は保証されない。

- (void)addUniqueObject:(id)object forKey:(NSString *)key

Parameters

`object`	追加するオブジェクト
`key`	追加する配列のキー

Discussion

また、追加したオブジェクトが配列内に既に存在した場合は追加されません。

Declared In

NCMBObject.h

`– addUniqueObjectsFromArray:forKey:`

キーで指定した配列に指定した複数のオブジェクトを追加する。オブジェクトの順序は保証されない。

- (void)addUniqueObjectsFromArray:(NSArray *)objects forKey:(NSString *)key

Parameters

`objects`	追加する複数のオブジェクト
`key`	追加する配列のキー

Discussion

また、追加したオブジェクトが配列内に既に存在した場合は追加されない。

Declared In

NCMBObject.h

`– removeObject:forKey:`

指定したキーに設定された値から、指定されたオブジェクトを削除

- (void)removeObject:(id)object forKey:(NSString *)key

Parameters

`object`	削除するオブジェクト
`key`	指定するキー

Declared In

NCMBObject.h

`– removeObjectForKey:`

指定したキーに設定された値を全て削除する

- (void)removeObjectForKey:(NSString *)key

Parameters

`key`	指定するキー

Declared In

NCMBObject.h

`– incrementKey:`

指定したキーの値に１を足す。未登録のものは新規登録される。デフォルト値は１。

- (void)incrementKey:(NSString *)key

Parameters

`key`	指定するキー

Declared In

NCMBObject.h

`– incrementKey:byAmount:`

指定したキーの値にamountで指定した増減値を加える。未登録のものは新規登録される。デフォルトは０に増減値を加えた値になる。

- (void)incrementKey:(NSString *)key byAmount:(NSNumber *)amount

Parameters

`key`	指定するキー
`amount`	増減値

Declared In

NCMBObject.h

`– saveEventually:`

電波状況を見てmobile backendにオブジェクトを保存する。

- (void)saveEventually:(NCMBErrorResultBlock)callback

Parameters

`callback`	saveEventuallyを実行したあとに呼び出されるcallback。 callbackは次の引数を持つ必要がある（NSError *error） saveEventually実行時にオフラインだった場合はerrorにnilが渡される

callback

saveEventuallyを実行したあとに呼び出されるcallback。

callbackは次の引数を持つ必要がある（NSError *error）

saveEventually実行時にオフラインだった場合はerrorにnilが渡される

Discussion

通信できない場合は、次回オンライン時に保存される。

保存処理が完了する前にアプリが終了した場合は、次回アプリ起動後オンライン時に保存される。

この場合再度処理を実行しても指定したコールバックは実行されない。

Declared In

NCMBObject.h

`– deleteEventually:`

通信状況を見てmobile backendからオブジェクトを削除する。

- (void)deleteEventually:(NCMBErrorResultBlock)callback

Parameters

`callback`	saveEventuallyを実行したあとに呼び出されるcallback。 callbackは次の引数を持つ必要がある（NSError *error） deleteEventually実行時にオフラインだった場合はerrorにnilが渡される

callback

saveEventuallyを実行したあとに呼び出されるcallback。

callbackは次の引数を持つ必要がある（NSError *error）

deleteEventually実行時にオフラインだった場合はerrorにnilが渡される

Discussion

通信できない場合は、次回オンライン時に削除される。

削除処理が実行される前にアプリが終了した場合は、次回アプリ起動後オンライン時に削除される。

この場合再度処理を実行しても指定したコールバックは実行されない。

Declared In

NCMBObject.h