クラス necbaas::NbUser

ユーザクラス. [詳細]

#include "necbaas/nb_user.h"

Public メソッド
	NbUser ()
	[内部処理用] [詳細]
	NbUser (const std::shared_ptr< NbService > &service)
	コンストラクタ. [詳細]
	~NbUser ()
	デストラクタ. [詳細]
void	SetUserEntity (const NbUserEntity &entity)
	[内部処理用] [詳細]
const std::string &	GetUserName () const
	ユーザ名取得. [詳細]
const std::string &	GetEmail () const
	E-mail取得. [詳細]
const NbJsonObject &	GetOptions () const
	オプション取得. [詳細]
std::vector< std::string >	GetGroups () const
	所属グループ取得. [詳細]
const std::string &	GetUserId () const
	ユーザID取得. [詳細]
std::tm	GetCreatedTime () const
	ユーザ作成日時取得. [詳細]
std::tm	GetUpdatedTime () const
	ユーザ更新日時取得. [詳細]

Static Public メソッド
static NbResult< NbUser >	LoginWithUsername (const std::shared_ptr< NbService > &service, const std::string &username, const std::string &password, int timeout=kRestTimeoutDefault)
	ログイン(ユーザ名). [詳細]
static NbResult< NbUser >	LoginWithEmail (const std::shared_ptr< NbService > &service, const std::string &email, const std::string &password, int timeout=kRestTimeoutDefault)
	ログイン(E-mail). [詳細]
static NbResult< NbUser >	Logout (const std::shared_ptr< NbService > &service, int timeout=kRestTimeoutDefault)
	ログアウト. [詳細]
static bool	IsLoggedIn (const std::shared_ptr< NbService > &service)
	ログイン状態確認. [詳細]
static std::time_t	GetSessionTokenExpiration (const std::shared_ptr< NbService > &service)
	ログイン有効期限取得. [詳細]
static const std::string	GetSessionToken (const std::shared_ptr< NbService > &service)
	セッショントークン取得. [詳細]
static NbUser	GetCurrentUser (const std::shared_ptr< NbService > &service)
	ログインユーザ情報取得. [詳細]
static std::string	ExportCurrentLogin (const std::shared_ptr< NbService > &service)
	ログインユーザのExport. [詳細]
static NbResultCode	ImportCurrentLogin (const std::shared_ptr< NbService > &service, const std::string &import)
	ログインユーザのImport. [詳細]

説明

ユーザクラス.

ユーザ情報の管理、認証を行うクラス.

本クラスのインスタンスはスレッドセーフではない

コンストラクタとデストラクタ

necbaas::NbUser::NbUser

(

)

[内部処理用]

necbaas::NbUser::NbUser ( const std::shared_ptr< NbService > &  service )

explicit

コンストラクタ.

引数

[in]

service

サービスインスタンス

necbaas::NbUser::~NbUser

(

)

デストラクタ.

関数

static std::string necbaas::NbUser::ExportCurrentLogin ( const std::shared_ptr< NbService > &  service )

static

ログインユーザのExport.

現在ログインしているユーザの情報をExportする。
ログインしていない場合は、空の文字列が返る。

戻り値

Exportデータ

std::tm necbaas::NbUser::GetCreatedTime

(

)

const

ユーザ作成日時取得.

std::tm の tm_year が 0 の場合は無効データ。

戻り値

ユーザ作成日時(UTC)

static NbUser necbaas::NbUser::GetCurrentUser ( const std::shared_ptr< NbService > &  service )

static

ログインユーザ情報取得.

現在ログインしているユーザの情報を取得する(キャッシュから読み出す)
未ログイン状態の場合は、ユーザ名等が全て空のNbUserオブジェクト

引数

[in]

service

サービスインスタンス

戻り値

ユーザ情報

const std::string& necbaas::NbUser::GetEmail

(

)

const

E-mail取得.

戻り値

E-mail

std::vector<std::string> necbaas::NbUser::GetGroups

(

)

const

所属グループ取得.

戻り値

グループコンテナ

const NbJsonObject& necbaas::NbUser::GetOptions

(

)

const

オプション取得.

戻り値

オプション

static const std::string necbaas::NbUser::GetSessionToken ( const std::shared_ptr< NbService > &  service )

static

セッショントークン取得.

ログイン中のセッショントークンを取得する。
未ログイン状態の場合は、空文字が返る。

引数

[in]

service

サービスインスタンス

戻り値

セッショントークン

static std::time_t necbaas::NbUser::GetSessionTokenExpiration ( const std::shared_ptr< NbService > &  service )

static

ログイン有効期限取得.

ログインの有効期限を取得する。
未ログイン状態の場合は、0 が返る。

引数

[in]

service

サービスインスタンス

戻り値

ログイン有効期限（UNIX Time）

std::tm necbaas::NbUser::GetUpdatedTime

(

)

const

ユーザ更新日時取得.

std::tm の tm_year が 0 の場合は無効データ。

戻り値

ユーザ更新日時(UTC)

const std::string& necbaas::NbUser::GetUserId

(

)

const

ユーザID取得.

戻り値

ユーザID

const std::string& necbaas::NbUser::GetUserName

(

)

const

ユーザ名取得.

戻り値

ユーザ名

static NbResultCode necbaas::NbUser::ImportCurrentLogin ( const std::shared_ptr< NbService > &  service, const std::string &  import  )

static

ログインユーザのImport.

現在ログインしているユーザの情報をimportする。
Exportしたデータを入力することで強制的にログイン状態を書き換える。
セッショントークンが空文字列の場合は、パラメータエラーを返す。
セッショントークンの有効期限が切れている場合は、有効期限切れのエラーを返す。

引数

[in]

import

Importデータ

戻り値

処理結果

戻り値

NbResultCode::NB_OK	Import成功
NbResultCode::NB_ERROR_INVALID_ARGUMENT	パラメータエラー
NbResultCode::NB_ERROR_SESSION_EXPIRED	セッショントークン有効期限切れ

static bool necbaas::NbUser::IsLoggedIn ( const std::shared_ptr< NbService > &  service )

static

ログイン状態確認.

ログイン状態の確認を行う。
セッショントークンの有効期限が切れている場合も未ログインとなる。

引数

[in]

service

サービスインスタンス

戻り値

確認結果

戻り値

true	ログイン中
false	未ログイン

static NbResult<NbUser> necbaas::NbUser::LoginWithEmail ( const std::shared_ptr< NbService > &  service, const std::string &  email, const std::string &  password, int  timeout = kRestTimeoutDefault  )

static

ログイン(E-mail).

Nebulaサービスへログインを行う。
NbServiceインスタンスに対して1ログインのみ有効である。
ログインに成功した場合は、ログアウトするか 次のログイン処理が成功するまでログイン状態が維持される。
E-mailアドレスまたはパスワードが空文字の場合はパラメータエラーを返す。

引数

[in]	service	サービスインスタンス
[in]	email	E-mailアドレス
[in]	password	パスワード
[in]	timeout	RESTタイムアウト(秒)

戻り値

処理結果

static NbResult<NbUser> necbaas::NbUser::LoginWithUsername ( const std::shared_ptr< NbService > &  service, const std::string &  username, const std::string &  password, int  timeout = kRestTimeoutDefault  )

static

ログイン(ユーザ名).

Nebulaサービスへログインを行う。
NbServiceインスタンスに対して1ログインのみ有効である。
ログインに成功した場合は、ログアウトするか 次のログイン処理が成功するまでログイン状態が維持される
ユーザネームまたはパスワードが空文字の場合はパラメータエラーを返す。

引数

[in]	service	サービスインスタンス
[in]	username	ユーザ名
[in]	password	パスワード
[in]	timeout	RESTタイムアウト(秒)

戻り値

処理結果

static NbResult<NbUser> necbaas::NbUser::Logout ( const std::shared_ptr< NbService > &  service, int  timeout = kRestTimeoutDefault  )

static

ログアウト.

セッショントークンを破棄し、ログイン状態を解除する。
未ログインの場合は、未ログインエラーを返す。

引数

[in]	service	サービスインスタンス
[in]	timeout	RESTタイムアウト(秒)

戻り値

処理結果。成功時はNbUserのユーザIDのみ有効。

void necbaas::NbUser::SetUserEntity

(

const NbUserEntity &

entity

)

[内部処理用]

---

このクラスの説明は次のファイルから生成されました:

• nb_user.h