APIリファレンス(JavaScript)

baasatrakuza > UserDetailClient

UserDetailClient class

ユーザー詳細管理APIのClientです。

Signature:

export declare class UserDetailClient extends ClientBase 

Extends: ClientBase

Remarks

BaaS@rakuzaに登録したユーザー詳細のデータを操作するためのメソッドを提供します。

Methods

MethodModifiersDescription
add(userAccessToken, userDetail)ユーザー詳細を1件追加します。
addToFavorite(userAccessToken, objectId, id)指定したIDのユーザー詳細をお気に入りに登録します。
createAddOp(userDetail)ユーザー詳細を1件追加する操作を生成します。
createDeleteAllOp(objectId)ユーザー詳細をすべて削除する操作を生成します。
createEditOp(userDetail, options)ユーザー詳細1件を編集する操作を生成します。
deleteAll(userAccessToken, objectId)ユーザー詳細をすべて削除します。
deleteFromFavorite(userAccessToken, objectId, id)指定したIDのユーザー詳細をお気に入りから削除します。
edit(userAccessToken, userDetail, options)ユーザー詳細1件を編集します。
favoriteQuery(userAccessToken)UserDetailFavoriteQueryを新しく生成して返します。
fromJSON(json)JSONから、UserDetailを生成して返します。
query(objectId, userAccessToken)UserDetailQueryを新しく生成して返します。