NCMBObject Class Reference

Inherits from NSObject
Declared in NCMBObject.h

Overview

NCMBObjectクラスは、ニフクラ mobile backendとアプリ間のデータの送受信を管理するクラスです。 アプリケーション内オブジェクトの取得・保存・削除などを管理するメインのクラスです。

Create

– initWithClassName:

クラス名を指定してNCMBObjectのインスタンスを生成

- (id)initWithClassName:(NSString *)className

Parameters

className

指定するクラス名

Declared In

NCMBObject.h

+ objectWithClassName:

指定されたクラス名でNCMBObjectのインスタンスを作成する

+ (NCMBObject *)objectWithClassName:(NSString *)className

Parameters

className

指定するクラス名

Declared In

NCMBObject.h

Object

  objectId

objectId オブジェクトのobjectID(ニフクラ mobile backend上で自動的に生成)

@property (nonatomic) NSString *objectId

Declared In

NCMBObject.h

  updateDate

updatedAt オブジェクトの更新日時

@property (nonatomic, readonly) NSDate *updateDate

Declared In

NCMBObject.h

  createDate

createdAt オブジェクトの登録日時

@property (nonatomic, readonly) NSDate *createDate

Declared In

NCMBObject.h

  ACL

ACL オブジェクトのアクセス権限情報

@property (nonatomic) NCMBACL *ACL

Declared In

NCMBObject.h

  ncmbClassName

ncmbClassName オブジェクトのクラス名

@property (nonatomic, readonly) NSString *ncmbClassName

Declared In

NCMBObject.h

– allKeys

オブジェクトのキーを取得する。createdAt、updatedAt、objectIdは含まれない。

- (NSArray *)allKeys

Return Value

オブジェクトのキーが格納された配列

Declared In

NCMBObject.h

– objectForKey:

キーで指定した値を取得する

- (id)objectForKey:(NSString *)key

Parameters

key

指定するキー

Return Value

指定されたキーの値

Declared In

NCMBObject.h

– setObject:forKey:

指定したキーに指定したオブジェクトを設定

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

Parameters

object

設定するオブジェクト

key

指定するキー

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

– incrementKey:

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

- (void)incrementKey:(NSString *)key

Parameters

key

指定するキー

Declared In

NCMBObject.h

– incrementKey:byAmount:

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

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

Parameters

key

指定するキー

amount

増減値

Declared In

NCMBObject.h

– removeObject:forKey:

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

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

Parameters

object

削除するオブジェクト

key

指定するキー

Declared In

NCMBObject.h

– removeObjectsInArray:forKey:

指定したキーに設定された値から、指定された配列に含まれるオブジェクトと一致するものを削除

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

Parameters

objects

削除する複数のオブジェクト

key

指定するキー

Declared In

NCMBObject.h

– removeObjectForKey:

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

- (void)removeObjectForKey:(NSString *)key

Parameters

key

指定するキー

Declared In

NCMBObject.h

– relationforKey:

指定したキーのリレーションを取得する

- (NCMBRelation *)relationforKey:(NSString *)key

Parameters

key

指定するキー

Return Value

NCMBRelationのインスタンス

Declared In

NCMBObject.h

Save

– save:

mobile backendにオブジェクトを保存する。エラーをセットし、エラー内容を見る事もできる。

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

Parameters

error

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

Declared In

NCMBObject.h

– saveInBackgroundWithBlock:

mobile backendにオブジェクトを保存する。非同期通信を行う。

- (void)saveInBackgroundWithBlock:(NCMBErrorResultBlock)userBlock

Parameters

userBlock

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

Declared In

NCMBObject.h

– saveInBackgroundWithTarget:selector:

非同期通信を利用してmobile backendにオブジェクトを保存する。通信後は指定されたセレクタを実行する。

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

Parameters

target

APIリクエスト後に実行するターゲット

selector

APIリクエスト後に実行するセレクタ

Declared In

NCMBObject.h

– saveEventually:

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

- (void)saveEventually:(NCMBErrorResultBlock)callback

Parameters

callback

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

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

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

Discussion

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

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

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

Declared In

NCMBObject.h

– refresh:

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

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

Parameters

error

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

Discussion

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

Declared In

NCMBObject.h

– refreshInBackgroundWithBlock:

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

- (void)refreshInBackgroundWithBlock:(NCMBErrorResultBlock)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

– fetchInBackgroundWithBlock:

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

- (void)fetchInBackgroundWithBlock:(NCMBErrorResultBlock)block

Parameters

block

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

Discussion

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

Declared In

NCMBObject.h

– fetchInBackgroundWithTarget:selector:

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

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

Parameters

target

呼び出すセレクタのターゲット

selector

実行するセレクタ

Discussion

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

Declared In

NCMBObject.h

– delete:

同期通信を利用してオブジェクトをmobile backendとローカル上から削除する。

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

Parameters

error

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

Declared In

NCMBObject.h

– deleteInBackgroundWithBlock:

非同期通信を利用してオブジェクトをmobile backendとローカル上から削除し、指定されたコールバックを呼び出す。

- (void)deleteInBackgroundWithBlock:(NCMBErrorResultBlock)userBlock

Parameters

userBlock

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

Declared In

NCMBObject.h

– deleteInBackgroundWithTarget:selector:

非同期通信を利用してオブジェクトをmobile backendとローカル上から削除し、指定されたセレクタを呼び出す。

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

Parameters

target

呼び出すセレクタのターゲット

selector

実行するセレクタ

Declared In

NCMBObject.h

– deleteEventually:

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

- (void)deleteEventually:(NCMBErrorResultBlock)callback

Parameters

callback

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

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

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

Discussion

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

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

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

Declared In

NCMBObject.h