APIリファレンス(Node.js)

baasatrakuza-admin package

baasatrakuza-adminはJavaScriptからBaaS@rakuzaにアクセスするための管理者向けSDKです。

SDKのエントリポイントはRKZです(RKZはRakuzaクラスのインスタンスです)。 RKZのメソッドやプロパティの各Clientクラスを経由して、BaaS@rakuzaを操作してください。

また、各Clientクラスを操作するのに必要なenumやユーティリティーもRKZを経由して参照することができます。

BaaS@rakuzaのご利用についてはBaaS@rakuza製品サイトをご確認ください。

Classes

Class	Description
BatchClient	バッチ処理のClientです。
BatchError	バッチ処理のエラーです。
ClientBase	Clientのベースクラスです。
Condition	検索条件のクラスです。
Config	SDKの設定情報です。
Context	BaaS@rakuza APIの接続先などのコンテキスト情報です。
DataClient	データ管理APIのClientです。
DataFavoriteQuery	オブジェクトデータお気に入り情報のQueryです。
DataQuery	オブジェクトデータのQueryです。
LineMessageQuery	LINEメッセージ配信のQueryです。
Order	ソート条件のクラスです。
PushClient	プッシュ通知/メッセージ配信管理APIのClientです。
PushQuery	プッシュ通知配信のQueryです。
QueryBase	Queryのベースクラスです。
Rakuza	BaaS@rakuzaとの接続および操作を行うAPIを提供します。
RKZError	BaaS@rakuzaのエラークラスです。
RKZFile	BaaS@rakuzaにアップロードするファイルクラスです。
UserClient	ユーザー管理APIのClientです。
UserDetailClient	ユーザー詳細管理APIのClientです。
UserDetailQuery	ユーザー詳細のQueryです。
UserQuery	ユーザーのQueryです。

Enumerations

Enumeration	Description
Direction	ソート順の方向です。
Operator	検索条件の演算子です。
RKZFlag	BaaS@rakuzaのAPIにおけるフラグを表現するenumです。
RKZStatus	BaaS@rakuzaのAPIが返すステータスです。
VisibilityType	ユーザー詳細の公開範囲です。

Interfaces

Interface	Description
API	BaaS@rakuzaのAPIです。
AppCredentialParam	BaaS@rakuzaの認証情報
AppSettings	アプリケーション設定情報。
Attributable	汎用データプロパティを持つオブジェクトです。
BatchOp	バッチ処理で実行する操作です。
Data	オブジェクトデータです。
DataFavorite	オブジェクトデータのお気に入り情報
DataResult	データオブジェクトの検索結果です。
EditDataOptions	オブジェクトデータ編集のオプションです。
EditUserDetailOptions	ユーザー詳細編集のオプションです。
Favorite	お気に入り情報
FavoriteSummary	お気に入り集計情報
Field	フィールド情報。
LineMessage	LINEメッセージ
PushMessage	プッシュ通知メッセージです。
RKZLocation	検索条件の位置情報オブジェクト
SendPushParam	プッシュ通知配信予約のパラメーターです。
Spot	スポット情報。
User	ユーザー情報。
UserDetail	ユーザー詳細。
UserDetailResult	ユーザー詳細の検索結果です。
UserIdentifier	ユーザー識別子。

Variables

Variable	Description
RKZ	SDKのエントリポイント。see: Rakuza

Type Aliases

Type Alias	Description
APIJSONObject	APIのコンテンツ部に設定できる型です。
DateString	日時を表す文字列
Operand	検索条件値の型です。