NCMB Unity SDK Library Project
NCMB.NCMBUser クラス

会員管理を操作するクラスです。 [詳解]

NCMB.NCMBUser の継承関係図
NCMB.NCMBObject

公開メンバ関数

 NCMBUser ()
 コンストラクター。 [詳解]
 
override void Add (string key, object value)
 ユーザを追加します。
すでにあるキーを指定した場合はExceptionを投げます。 [詳解]
 
override void Remove (string key)
 指定したキーのフィールドが存在する場合、フィールドを削除します。 [詳解]
 
override void DeleteAsync ()
 ユーザの削除を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
override void DeleteAsync (NCMBCallback callback)
 ユーザの削除を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
void SignUpAsync (NCMBCallback callback)
 非同期処理でユーザを登録します。
オブジェクトIDが登録されていない新規会員ならログインし、登録を行います。
オブジェクトIDが登録されている既存会員ならログインせず、更新を行います。
既存会員のログインはLogInAsyncメソッドをご利用下さい。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
void SignUpAsync ()
 非同期処理でユーザを登録します。
ユーザ登録が成功の場合、自動的にログインの状態になります。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
override void SaveAsync ()
 非同期処理でユーザの保存を行います。
SaveAsync()を実行してから編集などをしていなく、保存をする必要が無い場合は通信を行いません。
オブジェクトIDが登録されていない新規会員ならログインし、登録を行います。
オブジェクトIDが登録されている既存会員ならログインせず、更新を行います。
既存会員のログインはLogInAsyncメソッドをご利用下さい。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
override void SaveAsync (NCMBCallback callback)
 非同期処理でユーザの保存を行います。
SaveAsync()を実行してから編集などをしていなく、保存をする必要が無い場合は通信を行いません。
オブジェクトIDが登録されていない新規会員ならログインし、登録を行います。
オブジェクトIDが登録されている既存会員ならログインせず、更新を行います。
既存会員のログインはLogInAsyncメソッドをご利用下さい。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
bool IsAuthenticated ()
 認証済みか判定を行います。 [詳解]
 
void LogInWithAuthDataAsync (NCMBCallback callback)
 非同期処理でauthDataを用いて、ユーザを登録します。
既存会員のauthData登録はLinkWithAuthDataAsyncメソッドをご利用下さい。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
void LogInWithAuthDataAsync ()
 非同期処理でauthDataを用いて、ユーザを登録します。
ユーザ登録が成功の場合、自動的にログインの状態になります。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
void LinkWithAuthDataAsync (Dictionary< string, object > linkParam, NCMBCallback callback)
 非同期処理で現在ログインしているユーザに、authDataの追加を行います。
authDataが登録されていないユーザならログインし、authDataの登録を行います。
authDataが登録されているユーザなら、authDataの追加を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
void LinkWithAuthDataAsync (Dictionary< string, object > linkParam)
 非同期処理で現在ログインしているユーザに、authDataの追加を行います。
authDataが登録されていないユーザならログインし、authDataの登録を行います。
authDataが登録されているユーザなら、authDataの追加を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
void UnLinkWithAuthDataAsync (string provider, NCMBCallback callback)
 非同期処理で現在ログインしているユーザのauthDataの削除を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
void UnLinkWithAuthDataAsync (string provider)
 非同期処理で現在ログインしているユーザのauthDataの削除を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
bool IsLinkWith (string provider)
 SNSのauthDataが登録されているか判定を行います。 [詳解]
 
Dictionary< string, object > GetAuthDataForProvider (string provider)
 指定されたSNSのauthDataを取得します。 [詳解]
 
- 基底クラス NCMB.NCMBObject に属する継承公開メンバ関数
NCMBRelation< T > GetRelation< T > (String key)
 指定キーのNCMBRelationを生成します。 [詳解]
 
 NCMBObject (string className)
 コンストラクター。
指定クラス名のオブジェクトを生成します。 [詳解]
 
void Revert ()
 最後に保存を行った状態に戻します。 [詳解]
 
void RemoveRangeFromList (string key, IEnumerable values)
 キーで指定された配列から一致する複数のオブジェクトを削除します。
saveAsync()実行時に指定したオブジェクトの削除を行います。 [詳解]
 
void AddToList (string key, object value)
 キーで指定された配列にオブジェクトを追加します。
挿入位置は最後に追加します。 [詳解]
 
void AddRangeToList (string key, IEnumerable values)
 キーで指定された配列に複数のオブジェクトを追加します。
挿入位置は最後に追加します。 [詳解]
 
void AddUniqueToList (string key, object value)
 キーで指定された配列にオブジェクトを追加します。
今までに登録されていない値のみの追加を行います。
挿入位置は保証されません。 [詳解]
 
void AddRangeUniqueToList (string key, IEnumerable values)
 キーで指定された配列に複数のオブジェクトを追加します。
今までに登録されていない値のみの追加を行います。
挿入位置は保証されません。 [詳解]
 
void Increment (string key)
 オブジェクトに対し、インクリメントを行います。
インクリメントした結果の型はlong(Int64)型になります。 [詳解]
 
void Increment (string key, long amount)
 オブジェクトに対し、インクリメントを行います。
インクリメントした結果の型はlong(Int64)型になります。 [詳解]
 
void Increment (string key, double amount)
 オブジェクトに対し、インクリメントを行います。
インクリメントした結果の型はdouble型になります。 [詳解]
 
virtual void FetchAsync (NCMBCallback callback)
 非同期処理でオブジェクトの取得を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
virtual void FetchAsync ()
 非同期処理でオブジェクトの取得を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
bool ContainsKey (string key)
 オブジェクトに指定したkeyが、存在しているかの判断を行います。 [詳解]
 

静的公開メンバ関数

static NCMBQuery< NCMBUserGetQuery ()
 ユーザ内のオブジェクトで使用出来るクエリを取得します。 [詳解]
 
static void RequestPasswordResetAsync (string email)
 非同期処理でユーザのパスワード再発行依頼を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
static void RequestPasswordResetAsync (string email, NCMBCallback callback)
 非同期処理でユーザのパスワード再発行依頼を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
static void LogInAsync (string name, string password)
 非同期処理でユーザ名とパスワードを指定して、ユーザのログインを行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
static void LogInAsync (string name, string password, NCMBCallback callback)
 非同期処理でユーザ名とパスワードを指定して、ユーザのログインを行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
static void LogInWithMailAddressAsync (string email, string password, NCMBCallback callback)
 非同期処理でメールアドレスとパスワードを指定して、ユーザのログインを行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
static void LogInWithMailAddressAsync (string email, string password)
 非同期処理でメールアドレスとパスワードを指定して、ユーザのログインを行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
static void RequestAuthenticationMailAsync (string email)
 非同期処理で指定したメールアドレスに対して、
会員登録を行うためのメールを送信するよう要求します。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
static void RequestAuthenticationMailAsync (string email, NCMBCallback callback)
 非同期処理で指定したメールアドレスに対して、
会員登録を行うためのメールを送信するよう要求します。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
static void LogOutAsync ()
 非同期処理でユーザのログアウトを行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。 [詳解]
 
static void LogOutAsync (NCMBCallback callback)
 非同期処理でユーザのログアウトを行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。 [詳解]
 
- 基底クラス NCMB.NCMBObject に属する継承静的公開メンバ関数
static NCMBObject CreateWithoutData (String className, String objectId)
 指定したクラス名,ObjectIdのオブジェクト生成を行います。
[詳解]
 

プロパティ

string UserName [get, set]
 ユーザ名の取得、または設定を行います。 [詳解]
 
string Email [get, set]
 Eメールの取得、または設定を行います。 [詳解]
 
string Password [set]
 パスワードの設定を行います。 [詳解]
 
Dictionary< string, object > AuthData [get]
 ログイン中のユーザセッショントークンを取得を行います。 [詳解]
 
string SessionToken [get]
 ログイン中のユーザセッショントークンを取得を行います。 [詳解]
 
static NCMBUser CurrentUser [get]
 ログイン中のユーザ情報の取得を行います。 [詳解]
 
- 基底クラス NCMB.NCMBObject に属する継承プロパティ
virtual object this[string key] [get, set]
 オブジェクトの取得、または設定を行います。 [詳解]
 
string ClassName [get]
 オブジェクトクラス名の取得を行います。 [詳解]
 
string ObjectId [get, set]
 objectIdの取得、または設定を行います。 [詳解]
 
DateTime UpdateDate [get]
 オブジェクト更新時刻の取得を行います。 [詳解]
 
DateTime CreateDate [get, set]
 オブジェクト登録日時の取得を行います。 [詳解]
 
NCMBACL ACL [get, set]
 ACLの取得、または設定を行います。 [詳解]
 
bool IsDirty [get]
 オブジェクトが変更済みかどうか、判定の取得を行います。 [詳解]
 
ICollection< string > Keys [get]
 オブジェクトに格納されている、Keyの取得を行います。 [詳解]
 

詳解

会員管理を操作するクラスです。

構築子と解体子

◆ NCMBUser()

NCMB.NCMBUser.NCMBUser ( )

コンストラクター。

メソッド詳解

◆ Add()

override void NCMB.NCMBUser.Add ( string  key,
object  value 
)
virtual

ユーザを追加します。
すでにあるキーを指定した場合はExceptionを投げます。

引数
keyキー
value

NCMB.NCMBObjectを再実装しています。

◆ DeleteAsync() [1/2]

override void NCMB.NCMBUser.DeleteAsync ( )
virtual

ユーザの削除を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

NCMB.NCMBObjectを再実装しています。

◆ DeleteAsync() [2/2]

override void NCMB.NCMBUser.DeleteAsync ( NCMBCallback  callback)
virtual

ユーザの削除を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
callbackコールバック

NCMB.NCMBObjectを再実装しています。

◆ GetAuthDataForProvider()

Dictionary<string, object> NCMB.NCMBUser.GetAuthDataForProvider ( string  provider)

指定されたSNSのauthDataを取得します。

引数
providerSNS名
戻り値
指定されたSNSのauthData

◆ GetQuery()

static NCMBQuery<NCMBUser> NCMB.NCMBUser.GetQuery ( )
static

ユーザ内のオブジェクトで使用出来るクエリを取得します。

戻り値
クエリ

◆ IsAuthenticated()

bool NCMB.NCMBUser.IsAuthenticated ( )

認証済みか判定を行います。

戻り値
true:認証済 false:未認証

◆ IsLinkWith()

bool NCMB.NCMBUser.IsLinkWith ( string  provider)

SNSのauthDataが登録されているか判定を行います。

引数
providerSNS名
戻り値
true:登録済 false:未登録

◆ LinkWithAuthDataAsync() [1/2]

void NCMB.NCMBUser.LinkWithAuthDataAsync ( Dictionary< string, object >  linkParam,
NCMBCallback  callback 
)

非同期処理で現在ログインしているユーザに、authDataの追加を行います。
authDataが登録されていないユーザならログインし、authDataの登録を行います。
authDataが登録されているユーザなら、authDataの追加を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
linkParamauthData
callbackコールバック

◆ LinkWithAuthDataAsync() [2/2]

void NCMB.NCMBUser.LinkWithAuthDataAsync ( Dictionary< string, object >  linkParam)

非同期処理で現在ログインしているユーザに、authDataの追加を行います。
authDataが登録されていないユーザならログインし、authDataの登録を行います。
authDataが登録されているユーザなら、authDataの追加を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

引数
linkParamauthData

◆ LogInAsync() [1/2]

static void NCMB.NCMBUser.LogInAsync ( string  name,
string  password 
)
static

非同期処理でユーザ名とパスワードを指定して、ユーザのログインを行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

引数
nameユーザ名
passwordパスワード

◆ LogInAsync() [2/2]

static void NCMB.NCMBUser.LogInAsync ( string  name,
string  password,
NCMBCallback  callback 
)
static

非同期処理でユーザ名とパスワードを指定して、ユーザのログインを行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
nameユーザ名
passwordパスワード
callbackコールバック

◆ LogInWithAuthDataAsync() [1/2]

void NCMB.NCMBUser.LogInWithAuthDataAsync ( NCMBCallback  callback)

非同期処理でauthDataを用いて、ユーザを登録します。
既存会員のauthData登録はLinkWithAuthDataAsyncメソッドをご利用下さい。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
callbackコールバック

◆ LogInWithAuthDataAsync() [2/2]

void NCMB.NCMBUser.LogInWithAuthDataAsync ( )

非同期処理でauthDataを用いて、ユーザを登録します。
ユーザ登録が成功の場合、自動的にログインの状態になります。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

◆ LogInWithMailAddressAsync() [1/2]

static void NCMB.NCMBUser.LogInWithMailAddressAsync ( string  email,
string  password,
NCMBCallback  callback 
)
static

非同期処理でメールアドレスとパスワードを指定して、ユーザのログインを行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
emailメールアドレス
passwordパスワード
callbackコールバック

◆ LogInWithMailAddressAsync() [2/2]

static void NCMB.NCMBUser.LogInWithMailAddressAsync ( string  email,
string  password 
)
static

非同期処理でメールアドレスとパスワードを指定して、ユーザのログインを行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

引数
emailメールアドレス
passwordパスワード

◆ LogOutAsync() [1/2]

static void NCMB.NCMBUser.LogOutAsync ( )
static

非同期処理でユーザのログアウトを行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

◆ LogOutAsync() [2/2]

static void NCMB.NCMBUser.LogOutAsync ( NCMBCallback  callback)
static

非同期処理でユーザのログアウトを行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
callbackコールバック

◆ Remove()

override void NCMB.NCMBUser.Remove ( string  key)
virtual

指定したキーのフィールドが存在する場合、フィールドを削除します。

引数
keyフィールド名

NCMB.NCMBObjectを再実装しています。

◆ RequestAuthenticationMailAsync() [1/2]

static void NCMB.NCMBUser.RequestAuthenticationMailAsync ( string  email)
static

非同期処理で指定したメールアドレスに対して、
会員登録を行うためのメールを送信するよう要求します。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

引数
emailメールアドレス

◆ RequestAuthenticationMailAsync() [2/2]

static void NCMB.NCMBUser.RequestAuthenticationMailAsync ( string  email,
NCMBCallback  callback 
)
static

非同期処理で指定したメールアドレスに対して、
会員登録を行うためのメールを送信するよう要求します。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
emailメールアドレス
callbackコールバック

◆ RequestPasswordResetAsync() [1/2]

static void NCMB.NCMBUser.RequestPasswordResetAsync ( string  email)
static

非同期処理でユーザのパスワード再発行依頼を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

引数
emailメールアドレス

◆ RequestPasswordResetAsync() [2/2]

static void NCMB.NCMBUser.RequestPasswordResetAsync ( string  email,
NCMBCallback  callback 
)
static

非同期処理でユーザのパスワード再発行依頼を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
emailメールアドレス
callbackコールバック

◆ SaveAsync() [1/2]

override void NCMB.NCMBUser.SaveAsync ( )
virtual

非同期処理でユーザの保存を行います。
SaveAsync()を実行してから編集などをしていなく、保存をする必要が無い場合は通信を行いません。
オブジェクトIDが登録されていない新規会員ならログインし、登録を行います。
オブジェクトIDが登録されている既存会員ならログインせず、更新を行います。
既存会員のログインはLogInAsyncメソッドをご利用下さい。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

NCMB.NCMBObjectを再実装しています。

◆ SaveAsync() [2/2]

override void NCMB.NCMBUser.SaveAsync ( NCMBCallback  callback)
virtual

非同期処理でユーザの保存を行います。
SaveAsync()を実行してから編集などをしていなく、保存をする必要が無い場合は通信を行いません。
オブジェクトIDが登録されていない新規会員ならログインし、登録を行います。
オブジェクトIDが登録されている既存会員ならログインせず、更新を行います。
既存会員のログインはLogInAsyncメソッドをご利用下さい。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
callbackコールバック

NCMB.NCMBObjectを再実装しています。

◆ SignUpAsync() [1/2]

void NCMB.NCMBUser.SignUpAsync ( NCMBCallback  callback)

非同期処理でユーザを登録します。
オブジェクトIDが登録されていない新規会員ならログインし、登録を行います。
オブジェクトIDが登録されている既存会員ならログインせず、更新を行います。
既存会員のログインはLogInAsyncメソッドをご利用下さい。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
callbackコールバック

◆ SignUpAsync() [2/2]

void NCMB.NCMBUser.SignUpAsync ( )

非同期処理でユーザを登録します。
ユーザ登録が成功の場合、自動的にログインの状態になります。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

◆ UnLinkWithAuthDataAsync() [1/2]

void NCMB.NCMBUser.UnLinkWithAuthDataAsync ( string  provider,
NCMBCallback  callback 
)

非同期処理で現在ログインしているユーザのauthDataの削除を行います。
通信結果が必要な場合はコールバックを指定するこちらを使用します。

引数
providerSNS名
callbackコールバック

◆ UnLinkWithAuthDataAsync() [2/2]

void NCMB.NCMBUser.UnLinkWithAuthDataAsync ( string  provider)

非同期処理で現在ログインしているユーザのauthDataの削除を行います。
通信結果が不要な場合はコールバックを指定しないこちらを使用します。

引数
providerSNS名

プロパティ詳解

◆ AuthData

Dictionary<string,object> NCMB.NCMBUser.AuthData
get

ログイン中のユーザセッショントークンを取得を行います。

◆ CurrentUser

NCMBUser NCMB.NCMBUser.CurrentUser
staticget

ログイン中のユーザ情報の取得を行います。

◆ Email

string NCMB.NCMBUser.Email
getset

Eメールの取得、または設定を行います。

◆ Password

string NCMB.NCMBUser.Password
set

パスワードの設定を行います。

◆ SessionToken

string NCMB.NCMBUser.SessionToken
get

ログイン中のユーザセッショントークンを取得を行います。

◆ UserName

string NCMB.NCMBUser.UserName
getset

ユーザ名の取得、または設定を行います。


このクラス詳解は次のファイルから抽出されました: