NCMBUser Class Reference

Inherits from NCMBObject : NSObject
Declared in NCMBUser.h

Overview

NCMBUserクラスは、ニフクラ mobile backend上に保存されたユーザデータを管理するクラスです。 ユーザの新規登録やログイン/ログアウト、会員情報の更新・取得・削除を行います。 また、パスワードリセットやメールアドレス認証のリクエスト送信も行います。

User

  userName

ユーザ名

@property (nonatomic, copy) NSString *userName

Declared In

NCMBUser.h

  password

パスワード

@property (nonatomic, copy) NSString *password

Declared In

NCMBUser.h

  mailAddress

メールアドレス

@property (nonatomic, copy) NSString *mailAddress

Declared In

NCMBUser.h

  isNew

NCMBUserオブジェクトの登録の有無

@property (readonly, assign) BOOL isNew

Declared In

NCMBUser.h

  sessionToken

セッショントークン

@property (nonatomic, copy) NSString *sessionToken

Declared In

NCMBUser.h

+ user

NCMBUserのインスタンスを新規生成

+ (NCMBUser *)user

Return Value

新規生成したNCMBUserのインスタンス

Declared In

NCMBUser.h

+ query

NCMBQueryのインスタンスを新規作成する

+ (NCMBQuery *)query

Return Value

userクラスがセットされたNCMBQueryインスタンスを返却する

Declared In

NCMBUser.h

+ currentUser

現在ログインしているユーザ情報を取得する もしログインしているユーザーがいない場合にはnilが返ってくる

+ (NCMBUser *)currentUser

Return Value

現在ログインしているユーザオブジェクト

Declared In

NCMBUser.h

+ automaticCurrentUserWithBlock:

enableAutomaticUserを設定した場合に、anonymous認証による自動会員登録を実行する。

+ (void)automaticCurrentUserWithBlock:(NCMBUserResultBlock)block

Parameters

block

anonymous認証による会員登録がリクエストされたあとに実行されるブロック

Discussion

enableAutomaticUserが設定されていない場合や、すでにログイン済みの会員が存在している場合はcurrentUserと同じ処理を行う。

Declared In

NCMBUser.h

+ automaticCurrentUserWithTarget:selector:

enableAutomaticUserを設定した場合に、anonymous認証による自動会員登録を実行する。

+ (void)automaticCurrentUserWithTarget:(id)target selector:(SEL)selector

Parameters

target

anonymous認証による会員登録がリクエストされたあとに実行されるセレクタのターゲット

selector

anonymous認証による会員登録がリクエストされたあとに実行されるセレクタ

Discussion

enableAutomaticUserが設定されていない場合や、すでにログイン済みの会員が存在している場合はcurrentUserと同じ処理を行う。

Declared In

NCMBUser.h

– isAuthenticated

ユーザが認証済みかを判定

- (BOOL)isAuthenticated

Return Value

BOOL型YES=認証済、NO=未認証

Declared In

NCMBUser.h

+ enableAutomaticUser

匿名ユーザの自動生成を有効化

+ (void)enableAutomaticUser

Declared In

NCMBUser.h

Signup

– signUp:

ユーザの新規登録。必要があればエラーをセットし、取得することもできる。

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

Parameters

error

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

Declared In

NCMBUser.h

– signUpInBackgroundWithBlock:

ユーザを非同期で新規登録。新規登録し終わったら与えられたblockを呼び出す。

- (void)signUpInBackgroundWithBlock:(NCMBErrorResultBlock)block

Parameters

block

通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NSError *error) errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

– signUpInBackgroundWithTarget:selector:

ユーザを非同期で新規登録。新規登録し終わったら指定されたコールバックを呼び出す。

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

Parameters

target

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

selector

呼び出すセレクタ。次のシグネチャを持つ必要がある。 (void)callbackWithResult:(NSError **)error errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

– signUpWithGoogleToken:withBlock:

googleのauthDataをもとにニフクラ mobile backendへの会員登録(ログイン)を行う

- (void)signUpWithGoogleToken:(NSDictionary *)googleInfo withBlock:(NCMBErrorResultBlock)block

Parameters

googleInfo

google認証に必要なauthData

block

サインアップ後に実行されるblock

Declared In

NCMBUser.h

– signUpWithTwitterToken:withBlock:

twitterのauthDataをもとにニフクラ mobile backendへの会員登録(ログイン)を行う

- (void)signUpWithTwitterToken:(NSDictionary *)twitterInfo withBlock:(NCMBErrorResultBlock)block

Parameters

twitterInfo

twitter認証に必要なauthData

block

サインアップ後に実行されるblock

Declared In

NCMBUser.h

– signUpWithFacebookToken:withBlock:

facebookのauthDataをもとにニフクラ mobile backendへの会員登録(ログイン)を行う

- (void)signUpWithFacebookToken:(NSDictionary *)facebookInfo withBlock:(NCMBErrorResultBlock)block

Parameters

facebookInfo

facebook認証に必要なauthData

block

サインアップ後に実行されるblock

Declared In

NCMBUser.h

requestAuthenticationMail

+ requestAuthenticationMail:error:

指定したメールアドレスに対して、会員登録を行うためのメールを送信するよう要求する。必要があればエラーをセットし、取得することもできる。

+ (void)requestAuthenticationMail:(NSString *)email error:(NSError **)error

Parameters

email

指定するメールアドレス

error

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

Declared In

NCMBUser.h

+ requestAuthenticationMailInBackground:target:selector:

指定したメールアドレスに対して、会員登録を行うためのメールを送信するよう要求する。終わったら指定されたコールバックを呼び出す。

+ (void)requestAuthenticationMailInBackground:(NSString *)email target:(id)target selector:(SEL)selector

Parameters

email

指定するメールアドレス

target

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

selector

呼び出すセレクタ。次のシグネチャを持つ必要がある。 (void)callbackWithResult:(NSError **)error errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

+ requestAuthenticationMailInBackground:block:

指定したメールアドレスに対して、会員登録を行うためのメールを送信するよう要求する。終わったら与えられたblockを呼び出す。

+ (void)requestAuthenticationMailInBackground:(NSString *)email block:(NCMBErrorResultBlock)block

Parameters

email

指定するメールアドレス

block

通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある (NSError *error) errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

LogIn

+ logInWithUsername:password:error:

ユーザ名とパスワードを指定してログイン。必要があればエラーをセットし、取得することもできる。

+ (NCMBUser *)logInWithUsername:(NSString *)username password:(NSString *)password error:(NSError **)error

Parameters

username

ログイン時に指定するユーザ名

password

ログイン時に指定するパスワード

error

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

Return Value

ログインしたユーザの情報

Declared In

NCMBUser.h

+ logInWithUsernameInBackground:password:target:selector:

ユーザ名とパスワードを指定して非同期でログイン。ログインし終わったら指定されたコールバックを呼び出す。

+ (void)logInWithUsernameInBackground:(NSString *)username password:(NSString *)password target:(id)target selector:(SEL)selector

Parameters

username

ログイン時に指定するユーザ名

password

ログイン時に指定するパスワード

target

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

selector

呼び出すセレクタ。次のシグネチャを持つ必要がある。(void)callbackWithResult:(NCMBUser *)user error:(NSError **)error userにはログインしたユーザの情報が渡される。errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

+ logInWithUsernameInBackground:password:block:

ユーザ名とパスワードを指定して非同期でログイン。ログインし終わったら与えられたblockを呼び出す。

+ (void)logInWithUsernameInBackground:(NSString *)username password:(NSString *)password block:(NCMBUserResultBlock)block

Parameters

username

ログイン時に指定するユーザ名

password

ログイン時に指定するパスワード

block

通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NCMBUser user, NSError error) userにはログインしたユーザの情報が渡される。errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

+ logInWithMailAddress:password:error:

メールアドレスとパスワードを指定してログイン。必要があればエラーをセットし、取得することもできる。

+ (NCMBUser *)logInWithMailAddress:(NSString *)email password:(NSString *)password error:(NSError **)error

Parameters

email

ログイン時に指定するメールアドレス

password

ログイン時に指定するパスワード

error

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

Return Value

ログインしたユーザの情報

Declared In

NCMBUser.h

+ logInWithMailAddressInBackground:password:target:selector:

メールアドレスとパスワードを指定して非同期でログイン。ログインし終わったら与えられたコールバックを呼び出す。

+ (void)logInWithMailAddressInBackground:(NSString *)email password:(NSString *)password target:(id)target selector:(SEL)selector

Parameters

email

ログイン時に指定するメールアドレス

password

ログイン時に指定するパスワード

target

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

selector

呼び出すセレクタ。次のシグネチャを持つ必要がある。(void)callbackWithResult:(NCMBUser *)user error:(NSError **)error userにはログインしたユーザの情報が渡される。errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

+ logInWithMailAddressInBackground:password:block:

メールアドレスとパスワードを指定して非同期でログイン。ログインし終わったら与えられたblockを呼び出す。

+ (void)logInWithMailAddressInBackground:(NSString *)email password:(NSString *)password block:(NCMBUserResultBlock)block

Parameters

email

ログイン時に指定するメールアドレス

password

ログイン時に指定するパスワード

block

通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NCMBUser user, NSError error) userにはログインしたユーザの情報が渡される。errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

Logout

+ logOut

ログアウト

+ (void)logOut

Declared In

NCMBUser.h

+ logOutInBackgroundWithBlock:

非同期でログアウトを行う

+ (void)logOutInBackgroundWithBlock:(NCMBErrorResultBlock)block

Parameters

block

ログアウトのリクエストをした後に実行されるblock

Declared In

NCMBUser.h

requestPasswordReset

+ requestPasswordResetForEmail:error:

指定したメールアドレスを持つユーザのパスワードリセットを要求。ユーザが存在した場合、パスワードをリセットし、再設定のメールを送信する。必要があればエラーをセットし、取得することもできる。

+ (void)requestPasswordResetForEmail:(NSString *)email error:(NSError **)error

Parameters

email

指定するメールアドレス

error

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

Declared In

NCMBUser.h

+ requestPasswordResetForEmailInBackground:target:selector:

指定したメールアドレスを持つユーザのパスワードリセットを非同期で要求。ユーザが存在した場合、パスワードをリセットし、再設定のメールを送信する。リセットし終わったら指定されたコールバックを呼び出す。

+ (void)requestPasswordResetForEmailInBackground:(NSString *)email target:(id)target selector:(SEL)selector

Parameters

email

指定するメールアドレス

target

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

selector

呼び出すセレクタ。次のシグネチャを持つ必要がある。 (void)callbackWithResult:(NSNumber *)result error:(NSError **)error resultにはリセットの有無をNSNumber型で渡される。errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

+ requestPasswordResetForEmailInBackground:block:

指定したメールアドレスを持つユーザのパスワードリセットを非同期で要求。ユーザが存在した場合、パスワードをリセットし、再設定のメールを送信する。リセットし終わったら与えられたblockを呼び出す。

+ (void)requestPasswordResetForEmailInBackground:(NSString *)email block:(NCMBErrorResultBlock)block

Parameters

email

指定するメールアドレス

block

通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある (NSError *error)errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

– signUpFromAnonymous:password:error:

匿名会員を正規会員として同期で登録する。2回のAPIリクエストが発生する。objectiId,createDate,updateDate,authdata以外の情報を引き継ぐ。必要があればエラーをセットし、取得することもできる。

- (void)signUpFromAnonymous:(NSString *)userName password:(NSString *)password error:(NSError **)error

Parameters

userName

正規会員のユーザー名

password

正規会員のパスワード

error

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

Declared In

NCMBUser.h

– signUpFromAnonymousInBackgroundWithBlock:password:block:

匿名会員を正規会員として非同期で登録する。2回のAPIリクエストが発生する。objectiId,createDate,updateDate,authdata以外の情報を引き継ぐ。必要があればエラーをセットし、取得することもできる。

- (void)signUpFromAnonymousInBackgroundWithBlock:(NSString *)userName password:(NSString *)password block:(NCMBErrorResultBlock)block

Parameters

userName

正規会員のユーザー名

password

正規会員のパスワード

block

通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NSError *error) errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

– signUpFromAnonymousInBackgroundWithTarget:password:target:selector:

匿名会員を正規会員として非同期で登録する。2回のAPIリクエストが発生する。objectiId,createDate,updateDate,authdata以外の情報を引き継ぐ。必要があればエラーをセットし、取得することもできる。

- (void)signUpFromAnonymousInBackgroundWithTarget:(NSString *)userName password:(NSString *)password target:(id)target selector:(SEL)selector

Parameters

userName

正規会員のユーザー名

password

正規会員のパスワード

target

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

selector

呼び出すセレクタ。次のシグネチャを持つ必要がある。 (void)callbackWithResult:(NSError **)error errorにはエラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

link

– linkWithGoogleToken:withBlock:

ログイン中のユーザー情報に、googleの認証情報を紐付ける

- (void)linkWithGoogleToken:(NSDictionary *)googleInfo withBlock:(NCMBErrorResultBlock)block

Parameters

googleInfo

googleの認証情報(idとaccess_token)

block

既存のauthDataのgoogle情報のみ更新後実行されるblock。エラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

– linkWithTwitterToken:withBlock:

ログイン中のユーザー情報に、twitterの認証情報を紐付ける

- (void)linkWithTwitterToken:(NSDictionary *)twitterInfo withBlock:(NCMBErrorResultBlock)block

Parameters

twitterInfo

twitterの認証情報

block

既存のauthDataのtwitter情報のみ更新後実行されるblock。エラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

– linkWithFacebookToken:withBlock:

ログイン中のユーザー情報に、facebookの認証情報を紐付ける

- (void)linkWithFacebookToken:(NSDictionary *)facebookInfo withBlock:(NCMBErrorResultBlock)block

Parameters

facebookInfo

facebookの認証情報

block

既存のauthDataのfacebook情報のみ更新後実行されるblock。エラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

– isLinkedWith:

会員情報に、引数で指定したtypeの認証情報が含まれているか確認する

- (BOOL)isLinkedWith:(NSString *)type

Parameters

type

認証情報のtype(googleもしくはtwitter、facebook、anonymous)

Return Value

引数で指定したtypeの会員情報が含まれている場合はYESを返す

Declared In

NCMBUser.h

– unlink:withBlock:

会員情報から、引数で指定したtypeの認証情報を削除する

- (void)unlink:(NSString *)type withBlock:(NCMBErrorResultBlock)block

Parameters

type

認証情報のtype(googleもしくはtwitter、facebook、anonymous)

block

エラー情報を返却するblock エラーがあればエラーのポインタが、なければnilが渡される。

Declared In

NCMBUser.h

mailAddressConfirm

– isMailAddressConfirm

メールアドレスが確認済みのものかを把握する

- (BOOL)isMailAddressConfirm

Return Value

メールアドレスが確認済みの場合はYESを返す

Declared In

NCMBUser.h