API Docs for:
Show:

NCMB.User Class

Extends Operation
Defined in: lib/user.js:19

会員および会員権限によるオブジェクトへのアクセスの管理を扱うクラスです。

サインアップで登録の後、ログインすることでセッショントークンを取得します。 セッショントークンを保持しているユーザをカレントユーザーに設定することで、そのユーザの権限でオブジェクトにアクセスできるようになります。 セッショントークンの有効期限はデフォルトで24時間です。期限切れの場合は一度ログアウトした後再度ログインを行ってください。（有効期限はダッシュボードで変更できます。）

サインアップできるユーザ種別は、ユーザ名/パスワードでの認証、メールアドレス/パスワードでの認証、SNS連携(Facebook/Twitter/Google/Apple)での認証があります。 認証方法によって登録時・ログイン時に使用するメソッドが変わります。

※注意： ２種類のメソッド（インスタンスメソッド Instance method とスタティックメソッド Static method）があります。 それぞれリファレンス上の表記と利用時のメソッドが異なりますので、下記を参考にご利用ください。

  • リファレンス上の表記が「NCMB.User#メソッド名」: インスタンスメソッド Instance method
    • 利用例）NCMB.User#login
      var user = new ncmb.User({userName:"Yamada Tarou", password:"password"});
user.login();
  • リファレンス上の表記が「NCMB.UserConstructor#メソッド名」: スタティックメソッド Static method
    • 利用例）NCMB.UserConstructor#login
      ncmb.User.login("Yamada Tarou", "password");

Methods

linkWith

(
  • provider
  • data
  • callback
)

Defined in lib/user.js:893

Facebook/Google/Twiter/Apple等のSNSアカウントと連絡を行います。

Parameters:

  • provider String

    連携するサービスプロバイダ名 Facebook/Twitter/Google/Apple

  • data Object

    認証に必要な情報を保持したJSON形式のオブジェクト

  • callback Function

    コールバック関数

Returns:

this.

NCMB.User#delete

(
  • [callback]
)
Promise

Defined in lib/user.js:380

ユーザ情報の削除を行います。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.User#isCurrentUser

() Boolean

Defined in lib/user.js:136

現在セッションに使用しているユーザかどうかを判別します。

Returns:

Boolean:

true/false

NCMB.User#isMailAddressConfirmed

() Boolean

Defined in lib/user.js:881

メールアドレスの確認を行っているかどうかを判別します。

Returns:

Boolean:

確認済みの場合はtrue/以外はfalse

NCMB.User#login

(
  • [callback]
)
Promise

Defined in lib/user.js:456

ログイン（セッショントークンの取得）を行います。 カレントユーザーへの設定は行いません。 userNameおよびpasswordプロパティを保持している必要があります。 すでにセッショントークンを保持している場合、更新処理は行いません。 セッショントークンの期限切れが発生している場合、一度ログアウトしてから再度ログインしてください。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.User#loginAsAnonymous

(
  • uuid
  • [callback]
)
Promise

Defined in lib/user.js:625

匿名ユーザとしてログイン（セッショントークンの取得）を行います。 すでにセッショントークンを保持している場合、更新処理は行いません。 UUIDは省略可能です。省略した場合、UUIDを乱数で自動生成します。 userNameもしくはauthDataプロパティを持つインスタンスではログインできません。

Parameters:

  • uuid String

    端末固有のUUID

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.User#loginWith

(
  • [provider]
  • [data]
  • [callback]
)
Promise

Defined in lib/user.js:742

SNS連携認証ユーザとしてログイン（セッショントークンの取得）を行います。 authDataプロパティをもつ場合、第一・第二引数を省略可能です。 また、authDataに複数のSNS連携情報を持つ場合、第一引数で認証に使用するプロバイダを指定する必要があります。 authDataプロパティをもち、かつprovide, dataを入力した場合、入力された情報で認証を行います。 すでにセッショントークンを保持している場合、更新処理は行いません。 セッショントークンの期限切れが発生している場合、一度ログアウトしてから再度ログインしてください。 ログインのみ実施しますが、カレントユーザーへの反映を行いません。カレントユーザーを反映したい場合、ncmb.User.loginWith(user)を行ってください。

Parameters:

  • [provider] String optional

    連携するサービスプロバイダ名 Facebook/Twitter/Google/Apple

  • [data] Object optional

    認証に必要な情報を保持したJSON形式のオブジェクト

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.User#loginWithMailAddress

(
  • [callback]
)
Promise

Defined in lib/user.js:542

ログイン（セッショントークンの取得）を行います。 カレントユーザーへの設定は行いません。 mailAddressおよびpasswordプロパティを保持している必要があります。 すでにセッショントークンを保持している場合、更新処理は行いません。 セッショントークンの期限切れが発生している場合、一度ログアウトしてから再度ログインしてください。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.User#logout

(
  • [callback]
)
Promise

Defined in lib/user.js:836

インスタンスのセッショントークンの破棄を行います。 カレントユーザーに設定されているユーザをこのメソッドでログアウトした場合でもカレントユーザー情報は破棄されません。 そのままAPIリクエストを行った場合、不正なセッショントークン利用でエラーが返ります。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.User#requestPasswordReset

(
  • [callback]
)
Promise

Defined in lib/user.js:246

メールアドレス認証ユーザの登録メールアドレス宛にパスワード再設定のメールを送信します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

APIレスポンス

NCMB.User#signUpByAccount

(
  • [callback]
)
Promise

Defined in lib/user.js:147

ユーザ名とパスワード認証でユーザを登録します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.User#signUpWith

(
  • provider
  • data
  • [callback]
)
Promise

Defined in lib/user.js:186

SNS連携認証でユーザを登録します。 インスタンスのauthDataプロパティに適切なJSONオブジェクトが設定されている場合、providerおよびdataは省略可能です。 複数のプロバイダ情報を一度に登録することは出来ません。 会員登録のみ実施し、ログイン処理および、カレントユーザーへの反映を行いません。カレントユーザーを反映したい場合、ncmb.User.loginWith(user)を行ってください。

Parameters:

  • provider String

    連携するサービスプロバイダ名 Facebook/Twitter/Google/Apple

  • data Object

    認証に必要な情報を保持したJSON形式のオブジェクト

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.User#update

(
  • [callback]
)
Promise

Defined in lib/user.js:333

ユーザ情報の更新を行います。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

NCMB.UserConstructor#getCurrentUser

() NCMB.User

Defined in lib/user.js:110

現在セッションに使用しているユーザの情報を取得します。 セッションにセッショントークンを利用していない場合、nullが返ります。 また、画面遷移などでログイン中にセッショントークン情報が失われてしまった場合、 getCurrentUserを実行することで、ローカルに保存されているカレントユーザー情報から セッショントークンを設定し直します。

Returns:

NCMB.User:

セッション中のユーザオブジェクト

NCMB.UserConstructor#login

(
  • userName
  • [password]
  • [callback]
)
Promise

Defined in lib/user.js:411

ログイン（セッショントークンの取得）およびカレントユーザーへの設定を行います。 userNameおよびpasswordプロパティをもつUserインスタンスを第一引数に設定しそのユーザでログイン可能です。 その場合、第二引数を省略可能です。 すでにセッショントークンを保持している場合、更新処理は行いません。 セッショントークンの期限切れが発生している場合、一度ログアウトしてから再度ログインしてください。

Parameters:

  • userName String | NCMB.User

    ユーザ名

  • [password] String | function optional

    パスワード

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

ログインしたUserインスタンス

NCMB.UserConstructor#loginAsAnonymous

(
  • uuid
  • [callback]
)
Promise

Defined in lib/user.js:586

匿名ユーザとしてログイン（セッショントークンの取得）を行います。 すでにセッショントークンを保持している場合、更新処理は行いません。 UUIDは省略可能です。省略した場合、UUIDを乱数で自動生成します。 UUIDにUserのインスタンスを入力し、そのインスタンスでログイン可能です。 その場合、userNameもしくはauthDataプロパティを持つインスタンスではログインできません。

Parameters:

  • uuid String

    端末固有のUUID

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

ログインしたUserインスタンス

NCMB.UserConstructor#loginWith

(
  • provider
  • [data]
  • [callback]
)
Promise

Defined in lib/user.js:690

SNS連携認証ユーザとしてログイン（セッショントークンの取得）およびカレントユーザーへの設定を行います。 authDataプロパティをもつUserインスタンスを第一引数に設定し、そのユーザでログイン可能です。 その場合、第二引数を省略可能です。 また、authDataに複数のSNS連携情報を持つインスタンスを設定する場合、第二引数で認証に使用するプロバイダを指定する必要があります。 すでにセッショントークンを保持している場合、更新処理は行いません。 セッショントークンの期限切れが発生している場合、一度ログアウトしてから再度ログインしてください。 メソッドの返却値はログインしているユーザの情報です。

Parameters:

  • provider String | NCMB.User

    連携するサービスプロバイダ名 Facebook/Twitter/Google/Apple

  • [data] Object | Function optional

    認証に必要な情報を保持したJSON形式のオブジェクト

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

ログインしたUserインスタンス

NCMB.UserConstructor#loginWithMailAddress

(
  • mailAddress
  • [password]
  • [callback]
)
Promise

Defined in lib/user.js:500

ログイン（セッショントークンの取得）およびカレントユーザーへの設定を行います。 mailAddressおよびpasswordプロパティをもつUserインスタンスを第一引数に設定し、そのユーザでログイン可能です。 その場合、第二引数を省略可能です。 すでにセッショントークンを保持している場合、更新処理は行いません。 セッショントークンの期限切れが発生している場合、一度ログアウトしてから再度ログインしてください。

Parameters:

  • mailAddress String | NCMB.User

    メールアドレス

  • [password] String | Function optional

    パスワード

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

ログインしたUserインスタンス

NCMB.UserConstructor#logout

(
  • [callback]
)
Promise

Defined in lib/user.js:822

カレントユーザー情報およびセッショントークンの破棄を行います。 カレントユーザーに設定されていたインスタンス自体のセッショントークン情報は保持され続けます。 別途プロトタイプメソッドでインスタンスのログアウトを実行してください。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

ログアウトしたユーザインスタンス

NCMB.UserConstructor#new

(
  • [attrs]
)
NCMB.User

Defined in lib/user.js:996

Parameters:

  • [attrs] Object optional

    インスタンス生成時に設定するプロパティ

Returns:

NCMB.User:

NCMB.UserConstructor#requestPasswordReset

(
  • mailAddress
  • [callback]
)
Promise

Defined in lib/user.js:276

パスワードをリセットするために指定したmailAddressメールアドレスにメールを送信します。

Parameters:

  • mailAddress String

    登録するメールアドレス

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

APIレスポンス

NCMB.UserConstructor#requestSignUpEmail

(
  • mailAddress
  • [callback]
)
Promise

Defined in lib/user.js:307

メールアドレス認証の登録メールを送信します。 メール内でパスワード入力を行い、登録が完了した時点で認証が可能となります。

Parameters:

  • mailAddress String

    登録するメールアドレス

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

APIレスポンス

unLinkWith

(
  • provider
  • callback
)

Defined in lib/user.js:921

Facebook/Twitter/Google/Apple等のSNSアカウントの連携を削除します。

Parameters:

  • provider String

    連携するサービスプロバイダ名 Facebook/Twitter/Google/Apple

  • callback Function

    コールバック関数

Returns:

this.