ユーザーの管理

ユーザーの管理に使用する Monaca バックエンド マネジメント API を、次に記します。

メソッド

解説

User.list()

ユーザーの一覧を取得します。

User.create()

新しいユーザーオブジェクトを作成します。

User.get()

ユーザーのデータを取得します。

User.update()

ユーザーのデータを更新します。

User.delete()

ユーザーを削除します。

User.getPropertyNames()

ユーザーのプロパティー名を取得します。

User.list - ユーザーの一覧の取得

ユーザーコレクション内のユーザーの一覧を取得します。

User.list

パラメーター
page

数値

ページ番号 ( 1 から開始 ) です。

itemsInPage

数値

1 ページに表示するアイテムの数です。表示可能なアイテムの上限は、 10000 です。

sortProperty

文字列

ソート時に使用するプロパティーです。

sortOrder

文字列

ソート順は、 "asc" または "desc" ( デフォルトでは "asc" ) を指定できます。

propertyNames

文字列

システムプロパティーに加え、追加で取得できるプロパティーです ( 任意 )。

nameFilter

文字列

このキーワード、ならびに、 _username または _oid を使用して、ユーザーを検索します。( 任意 )

userQuery

文字列

ユーザーのプロパティーと MonaQL クエリーを使用して、対象となるユーザを絞り込みます ( 任意 )。

‘country == “US” && age > 20’

userQueryBindParams

配列

userQuery 内にプレースホルダーがある場合には、値に置き換えます ( 任意 )。

userQuery が ‘country == ? && age > ?’ の場合、[“US”, 20] になります。

戻り値
items

アイテムです。

totalItems

アイテム数です。

エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

User.create - ユーザーオブジェクトの作成

新しいユーザーオブジェクトを作成します。

User.create

パラメーター
username

文字列

ユーザー名または電子メールアドレスです。

password

文字列

パスワードです。

properties

オブジェクト

追加で設定するプロパティーです。

戻り値
user

ユーザーのデータです ( _id が割り当てられます )。

エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

User.get - ユーザーデータの取得

ユーザーのデータを取得します。

User.get

パラメーター
_id

文字列

ユーザーの ID です。

戻り値
user

ユーザーのデータです。

エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

User.update - ユーザーデータの更新

ユーザーのデータを更新します。

User.update

パラメーター
_id

文字列

ユーザーの ID です。

user  

ユーザーのデータです ( _id 行は無視することになります )。

戻り値

なし

 
エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

User.delete - ユーザーの削除

複数のユーザーを削除します。

User.delete

パラメーター
idList

オブジェクト

ID の一覧です。

戻り値

なし

 
エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

User.getPropertyNames - ユーザーのプロパティー名の取得

最新の 100 ユーザーの中から、表示可 ( 読み込み可 ) となっているプロパティー名を取得します。

User.getPropertyNames

パラメーター

なし

 
戻り値
names

配列

プロパティー名です。

エラーコード
N/A