Class:AppPot.User

ユーザーを管理するためのクラスです。

Properties

Name	Type	Description
account	String	ログインするためのID
firstName	String	名前
lastName	String	名字
userId	Number	AppPotサーバーが自動的に割り当てる一意な数値です。
password	String	ユーザーを登録する際にパスワードを設定します。それ以外の場合は、空文字が設定されています。
groupsRoles	GroupsRoles[]	所属するグループと、そのグループでのロールを表すクラスのインスタンスの配列です。

ClassMethods

findById(userId, options) -> Promise

指定したuserIdのユーザーを検索します。

引数:

Name	Type	Description
userId	Number	検索したいユーザーのIDを指定します。
options	(optional) AjaxOption	検索クエリの非同期通信のオプションを指定します。

Return:

Type: Promise< User >

Example:

AppPot.User.findById(userId)
  .then((user) => {
    console.log(user);
  });

list(params, options) -> Promise

指定した条件のユーザーを検索します。

引数:

Name	Type	Description
params	Object	検索条件を指定します。
options	(optional) AjaxOption	検索クエリの非同期通信のオプションを指定します。

paramsは以下の様なkeyを持つObjectを指定します。

Key	Type	Description
groupId	(optional) String	指定したグループIDのグループに所属するユーザーを検索
account	(optional) String	指定したアカウント名のユーザーを検索
firstName	(optional) String	指定した氏名（名）のユーザーを検索
lastName	(optional) String	指定した氏名（姓）のユーザーを検索

Return:

Type: Promise< User[] >

Example:

AppPot.User.list({ account: account })
  .then((users) => {
    console.log(users);
  });

remove(userId, options) -> Promise

指定したuserIdのユーザーを削除します。

引数:

Name	Type	Description
userId	Number	削除したいユーザーのIDを指定します。
options	(optional) AjaxOption	削除クエリの非同期通信のオプションを指定します。

Return:

Type: Promise

Example:

AppPot.User.remove(userId)
  .then(() => {
    console.log("removed");
  });

InstanceMethods

create(options) -> Promise

インスタンスに設定されたデータでユーザーを作成します。

引数:

Name	Type	Description
options	(optional) AjaxOption	生成クエリの非同期通信のオプションを指定します。

Return:

Type: Promise< User >

update(columns, options) -> Promise

インスタンスに設定されたデータでユーザー情報を更新します。

引数:

Name	Type	Description
columns	(optional) Object	上書きするデータを指定します。
options	(optional) AjaxOption	更新クエリの非同期通信のオプションを指定します。

columnsが指定された場合は、インスタンスに設定されているデータを更に上書きして、サーバーに更新クエリを発行します。
optionsを指定する場合は、空Objectをcolumnsに指定する必要があります。

Return:

Type: Promise< User >

remove(options) -> Promise

ユーザーを削除します。

引数:

Name	Type	Description
options	(optional) AjaxOption	削除クエリの非同期通信のオプションを指定します。

Return:

Type: Promise