会員管理 (Application_Development_Framework) : 基本的な使い方

会員管理（Application Development Framework）

MobilePortal
Application Development Framework

基本的な使い方

1 概要
2 アプリでの実装
3 mBaaS管理画面での操作

概要

MobileSUITE mBaaS機能(Application Development Framework)での会員の認証方法は以下の3つがあります。

ユーザー名・パスワードでの認証
メールアドレス・パスワードでの認証
- 会員管理 (Application Development Framework) : メールアドレス認証
匿名認証
- 会員管理 (Application Development Framework) : 匿名認証

このページでは、ユーザー名・パスワードでの認証方法について説明していきます。
その他の認証方法を実装する場合は、各ドキュメントをご覧ください。

アプリでの実装

ユーザーの新規登録

User のインスタンスを作成後、userName と password を設定して signUpByAccount メソッドで登録処理を行います。

//　Userインスタンスの生成
var user = new ncmb.User();
// ユーザー名・パスワードを設定
user.set("userName", "Yamada Tarou") /* ユーザー名 */
    .set("password", "password") /* パスワード */
    .set("phone_number", "090-1234-5678"); /* 任意フィールドも追加可能 */
// ユーザーの新規登録処理
user.signUpByAccount()
    .then(function(){
      // 登録後処理
    })
    .catch(function(err){
      // エラー処理
    });

// 1. ユーザー名とパスワードでログイン
ncmb.User.login("Yamada Tarou", "password")
    .then(function(data){
      // ログイン後処理
    })
    .catch(function(err){
      // エラー処理
    });

// 2. Userインスタンスでログイン
var user = new ncmb.User({userName:"Yamada Tarou", password:"password"});
ncmb.User.login(user)
    .then(function(data){
      // ログイン後処理
    })
    .catch(function(err){
      // エラー処理
    });

また、ログインすることでログインしたユーザーはカレントユーザーとして設定されます。カレントユーザーの権限で mBaaS 上のオブジェクトにアクセスできるようになります。

参考：データストア(Application Development Framework)：アクセス権限設定

セッショントークン

ログインするとセッショントークンが発行されます。通信時に利用されるセッショントークンは、カレントユーザーに設定されているものです。ログアウトすることでセッショントークンを無効にし、ログイン状態を終了します。

セッショントークンの有効期限は通常24時間です
有効期限切れのセッショントークンでは通信できません
セッショントークンの有効期限は管理画面にて変更可能です

カレントユーザー

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

// カレントユーザー情報の取得
var currentUser = ncmb.User.getCurrentUser();
if (currentUser) {
    console.log("ログイン中のユーザー: " + currentUser.get("userName"));
} else {
    console.log("未ログインまたは取得に失敗");
}

isCurrentUser メソッドを用いることで、特定のインスタンスがカレントユーザーかどうかを確かめることができます。

// カレントユーザーかどうかの確認
var user = new ncmb.User();
console.log(user.isCurrentUser()); /* true or false */

参考：自動ログイン処理を実現するには？
アプリ再起動時に自動ログインを実施したい場合は、カレントユーザーを取得した上でセッショントークンの有効期限が切れていないかどうかを確認する処理の実装が必要です。

ログアウト

ログアウトは logout メソッドを利用します。ログアウトすることで、カレントユーザー情報がリセットされます。

// ログアウト
ncmb.User.logout();

参考：インスタンスを用いてログインしている場合の注意点
ログアウトによりシステム上の
セッショントークンは無効となりますが、インスタンスのプロパティは残ります。プロパティが残っているとセッショントークンの再取得ができないため、同一ユーザで再度ログインする場合には事前にインスタンスのログアウトを実行する必要があります。

カレントユーザーを変更しないセッショントークンの取得・破棄

下記の様にログイン/ログアウトを実施することで、カレントユーザーの情報を変更せずにセッショントークンの取得/破棄を行うことができます。

var user = new ncmb.User({userName:"Yamada Tarou", password:"password"});
// ログイン中のユーザーを カレントユーザー に設定せず、セッショントークンのみを取得
user.login()
    .then(function(user){
      // ログイン後の処理
      // カレントユーザー情報を保持したままインスタンスのセッショントークンを無効化(破棄)
      return user.logout();
    })
    .then(function(){
      // ログアウト後処理
    })
    .catch(function(err){
      // エラー処理
    });

メールアドレス確認の有無

メールアドレスが確認済みかどうかを調べるには isMailAddressConfirm メソッドを使用します。

参考：「メールアドレス確認」とは？
メールアドレス認証を利用する場合、ユーザーの新規登録時に登録メールアドレス宛にメールを配信し、配信されたメールから認証を行う手順があります。この手順が実施されている状態が「メールアドレス確認済み」となります。他の認証方法でもユーザー情報にメールアドレスを設定することが可能ですが、「メールアドレス確認」が実施されていないアカウントはメールアドレス認証を利用できません。

var currentUser = ncmb.User.getCurrentUser();
if (currentUser.isMailAddressConfirmed()) {
    // メールアドレス確認済み
} else {
    // メールアドレス未確認
}

パスワードのリセット

パスワードのリセットはメールアドレスの登録があるユーザーのみ行えます。以下のようにリセット要求を発行すると、登録メールアドレスに

仮パスワード
会員パスワード変更ページのURL

が送信されます。会員パスワード変更ページでパスワードの変更が可能です。

参考：パスワード変更 API は用意しておりません。パスワードの変更を行いたい場合はパスワードのリセットの処理が必要です。

var user = new ncmb.User();
user.set("mailAddress", "mail@example.com");
user.requestPasswordReset()
    .then(function(data){
        // 送信後処理
    })
    .catch(function(err){
      // エラー処理
    });