APIリファレンス(JavaScript)
DataClient class
データ管理APIのClientです。
Signature:
export declare class DataClient extends ClientBase
Extends: ClientBase
Remarks
BaaS@rakuzaに登録したデータオブジェクトのデータを操作するためのメソッドを提供します。
Methods
| Method | Modifiers | Description |
|---|---|---|
| add(data) | オブジェクトデータを1件追加します。 | |
| addToFavorite(userAccessToken, objectId, code) | 指定したコードのデータオブジェクトをお気に入りに登録します。 | |
| deleteAll(objectId) | オブジェクトデータをすべて削除します。 | |
| deleteFromFavorite(userAccessToken, objectId, code) | 指定したコードのデータオブジェクトをお気に入りから削除します。 | |
| edit(data) | オブジェクトデータ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を新しく生成して返します。 |