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

baasatrakuza-admin > Rakuza

Rakuza class

BaaS@rakuzaとの接続および操作を行うAPIを提供します。

Signature:

export declare class Rakuza 

Remarks

BaaS@rakuzaにアクセスする際は、このクラスを参照してください。

Properties

PropertyModifiersTypeDescription
BatchErrortypeof BatchErrorバッチ処理エラーのコンストラクタ
ClientBasetypeof ClientBaseClientのベースクラス
Conditiontypeof Condition検索条件オブジェクトのコンストラクタ
configConfigSDKの設定情報
contextContextBaaS@rakuza APIの接続先などのコンテキスト情報
DataDataClientデータ管理APIのClient
DeviceTypetypeof DeviceTypeデバイス区分(iOSまたはAndroid)のenum
Directiontypeof Directionソート順方向のenum
Errortypeof RKZErrorエラーオブジェクトのコンストラクタ
Filetypeof RKZFileBaaS@rakuzaにアップロードするファイルオブジェクトのコンストラクタ
Flagtypeof RKZFlagフラグのenum
isInitializedbooleanSDKが初期化済みの場合、trueを返します。
Operatortypeof Operator検索条件演算子のenum
PushPushClientプッシュ通知/メッセージ配信管理APIのClient
QueryBasetypeof QueryBaseQueryのベースクラス
Statustypeof RKZStatusBaaS@rakuzaの各APIが返却するステータス
UserUserClientユーザー管理APIのClient
UserDetailUserDetailClientユーザー詳細管理APIのClient
versionstringSDKのバージョン
VisibilityTypetypeof VisibilityTypeユーザー詳細の公開範囲

Methods

MethodModifiersDescription
appSettings()BaaS@rakuzaに設定したアプリケーション設定情報を取得します。
batch()バッチ処理のClientを新しく生成して返します。
init(credential)認証情報を用いて、SDKの初期化を行います。
now()BaaS@rakuzaのシステム日時を取得します。