APIリファレンス(JavaScript)

baasatrakuza > Rakuza

Rakuza class

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

Signature:

export declare class Rakuza 

Remarks

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

Properties

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

Methods

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