APIリファレンス(JavaScript)
Rakuza class
BaaS@rakuzaとの接続および操作を行うAPIを提供します。
Signature:
export declare class Rakuza
Remarks
BaaS@rakuzaにアクセスする際は、このクラスを参照してください。
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| Beacon | BeaconClient | ビーコン管理APIのClient | |
| ClientBase | typeof ClientBase | Clientのベースクラス | |
| Condition | typeof Condition | 検索条件オブジェクトのコンストラクタ | |
| config | Config | SDKの設定情報 | |
| Contact | ContactClient | コンタクト管理APIのClient | |
| context | Context | BaaS@rakuza APIの接続先などのコンテキスト情報 | |
| Coupon | CouponClient | クーポン管理APIのClient | |
| Data | DataClient | データ管理APIのClient | |
| DeviceType | typeof DeviceType | デバイス区分(iOSまたはAndroid)のenum | |
| Direction | typeof Direction | ソート順方向のenum | |
| Error | typeof RKZError | エラーオブジェクトのコンストラクタ | |
| File | typeof RKZFile | BaaS@rakuzaにアップロードするファイルオブジェクトのコンストラクタ | |
| Flag | typeof RKZFlag | フラグのenum | |
| isInitialized | boolean | SDKが初期化済みの場合、trueを返します。 | |
| MyCoupon | MyCouponClient | マイクーポン管理APIのClient | |
| News | NewsClient | お知らせ管理APIのClient | |
| Operator | typeof Operator | 検索条件演算子のenum | |
| Point | PointClient | ポイント管理APIのClient | |
| QueryBase | typeof QueryBase | Queryのベースクラス | |
| Stamp | StampClient | スタンプラリー管理APIのClient | |
| Status | typeof RKZStatus | BaaS@rakuzaの各APIが返却するステータス | |
| User | UserClient | ユーザー管理APIのClient | |
| UserDetail | UserDetailClient | ユーザー詳細管理APIのClient | |
| version | string | SDKのバージョン | |
| VisibilityType | typeof VisibilityType | ユーザー詳細の公開範囲 |
Methods
| Method | Modifiers | Description |
|---|---|---|
| appSettings() | BaaS@rakuzaに設定したアプリケーション設定情報を取得します。 | |
| init(tenantKey) | テナント認証キーを用いて、SDKの初期化を行います。 | |
| initWithCredential(credential) | 認証情報を用いて、SDKの初期化を行います。 | |
| localeQuery() | LocaleQueryを新しく生成して返します。 | |
| now() | BaaS@rakuzaのシステム日時を取得します。 | |
| setMyLocale(userAccessToken, locale) | BaaS@rakuzaにロケールを設定します。 |