APIリファレンス(JavaScript)

baasatrakuza > DataClient

DataClient class

データ管理APIのClientです。

Signature:

export declare class DataClient extends ClientBase 

Extends: ClientBase

Remarks

BaaS@rakuzaに登録したデータオブジェクトのデータを操作するためのメソッドを提供します。

Methods

MethodModifiersDescription
add(data)オブジェクトデータを1件追加します。
addAndGet(data)オブジェクトデータを1件追加し、追加したデータを取得します。
addToFavorite(userAccessToken, objectId, code)指定したコードのデータオブジェクトをお気に入りに登録します。
createAddOp(data)オブジェクトデータを1件追加する操作を生成します。
createDeleteAllOp(objectId)オブジェクトデータをすべて削除する操作を生成します。
createEditOp(data, options)オブジェクトデータ1件を編集する操作を生成します。
createGetByLocationOp(objectId, code, location, spotFieldName)コードを指定して、位置情報でデータオブジェクト1件を取得する操作を生成します。
createGetOp(objectId, code)コードを指定して、データオブジェクト1件を取得する操作を生成します。
createGetWithRelationOp(objectId, code, treeCount)コードを指定して、関連オブジェクト付きのデータオブジェクト1件を取得する操作を生成します。
deleteAll(objectId)オブジェクトデータをすべて削除します。
deleteFromFavorite(userAccessToken, objectId, code)指定したコードのデータオブジェクトをお気に入りから削除します。
edit(data, options)オブジェクトデータ1件を編集します。
editAndGet(data, options)オブジェクトデータ1件を編集し、編集したデータを取得します。
favoriteQuery(userAccessToken)DataFavoriteQueryを新しく生成して返します。
fields(objectId, visibleOnly)BaaS@rakuzaに設定されているオブジェクトの項目定義情報を取得します。
fromJSON(json)JSONから、Dataを生成して返します。
get(objectId, code)コードを指定して、データオブジェクト1件を取得します
getByLocation(objectId, code, location, spotFieldName)コードを指定して、位置情報でデータオブジェクト1件を取得します
getByQRCode(qrCode)QRコードで、データオブジェクト1件を取得します
getQRCode(qrCode)QRコードのオブジェクトデータを取得します
getWithRelation(objectId, code, treeCount)コードを指定して、関連オブジェクト付きのデータオブジェクト1件を取得します
query(objectId, userAccessToken)DataQueryを新しく生成して返します。