API Docs for:
Show:

NCMB.User Class

Defined in: lib/user.js:19

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

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

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

Constructor

NCMB.User

(
  • attrs
)

Defined in lib/user.js:19

Parameters:

  • attrs Object

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

Methods

delete

(
  • callback
)

Defined in lib/user.js:328

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

Parameters:

  • callback Function

    コールバック関数

Returns:

true

isCurrentUser

() Boolean

Defined in lib/user.js:119

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

Returns:

Boolean:

true/false

isMailAddressConfirmed

() Boolean

Defined in lib/user.js:825

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

Returns:

Boolean:

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

login

(
  • callback
)

Defined in lib/user.js:396

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

Parameters:

  • callback Function

    コールバック関数

Returns:

true

loginAsAnonymous

(
  • uuid
  • callback
)

Defined in lib/user.js:571

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

Parameters:

  • uuid String

    端末固有のUUID

  • callback Function

    コールバック関数

Returns:

this

loginWith

(
  • provider
  • data
  • callback
)

Defined in lib/user.js:687

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

Parameters:

  • provider String

    連携するサービスプロバイダ名 facebook/twitter/google

  • data Object

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

  • callback Function

    コールバック関数

Returns:

this

loginWithMailAddress

(
  • callback
)

Defined in lib/user.js:485

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

Parameters:

  • callback Function

    コールバック関数

Returns:

this

logout

(
  • callback
)

Defined in lib/user.js:780

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

Parameters:

  • callback Function

    コールバック関数

Returns:

this

requestPasswordReset

(
  • callback
)

Defined in lib/user.js:228

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

Parameters:

  • callback Function

    コールバック関数

Returns:

APIレスポンス

requestSignUpEmail

(
  • mailAddress
  • callback
)

Defined in lib/user.js:258

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

Parameters:

  • mailAddress String

    登録するメールアドレス

  • callback Function

    コールバック関数

Returns:

APIレスポンス

signUpByAccount

(
  • callback
)

Defined in lib/user.js:130

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

Parameters:

  • callback Function

    コールバック関数

Returns:

this

signUpWith

(
  • provider
  • data
  • callback
)

Defined in lib/user.js:169

SNS連携認証でユーザを登録します。 インスタンスのauthDataプロパティに適切なJSONオブジェクトが設定されている場合、providerおよびdataは省略可能です。 複数のプロバイダ情報を一度に登録することは出来ません。

Parameters:

  • provider String

    連携するサービスプロバイダ名 facebook/twitter/google

  • data Object

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

  • callback Function

    コールバック関数

Returns:

this

update

(
  • callback
)

Defined in lib/user.js:284

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

Parameters:

  • callback Function

    コールバック関数

Returns:

this

User.getCurrentUser

() User

Defined in lib/user.js:93

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

Returns:

User:

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

User.login

(
  • userName
  • password
  • callback
)

Defined in lib/user.js:351

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

Parameters:

  • userName String

    ユーザ名

  • password String

    パスワード

  • callback Function

    コールバック関数

Returns:

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

User.loginAsAnonymous

(
  • uuid
  • callback
)

Defined in lib/user.js:532

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

Parameters:

  • uuid String

    端末固有のUUID

  • callback Function

    コールバック関数

Returns:

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

User.loginWith

(
  • provider
  • data
  • callback
)

Defined in lib/user.js:636

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

Parameters:

  • provider String

    連携するサービスプロバイダ名 facebook/twitter/google

  • data Object

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

  • callback Function

    コールバック関数

Returns:

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

User.loginWithMailAddress

(
  • mailAddress
  • password
  • callback
)

Defined in lib/user.js:443

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

Parameters:

  • mailAddress String

    メールアドレス

  • password String

    パスワード

  • callback Function

    コールバック関数

Returns:

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

User.logout

(
  • callback
)

Defined in lib/user.js:766

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

Parameters:

  • callback Function

    コールバック関数

Returns:

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