APIリファレンス(JavaScript)
baasatrakuza package
baasatrakuzaはJavaScriptからBaaS@rakuzaにアクセスするためのSDKです。
SDKのエントリポイントはRKZです(RKZはRakuzaクラスのインスタンスです)。 RKZのメソッドやプロパティの各Clientクラスを経由して、BaaS@rakuzaを操作してください。
また、各Clientクラスを操作するのに必要なenumやユーティリティーもRKZを経由して参照することができます。
BaaS@rakuzaのご利用についてはBaaS@rakuza製品サイトをご確認ください。
Classes
| Class | Description |
|---|---|
| BeaconClient | ビーコン管理APIのClientです。 |
| BeaconDetectContactQuery | ビーコン検知コンタクト履歴のQueryです。 |
| BeaconQuery | ビーコン端末情報のQueryです。 |
| ClientBase | Clientのベースクラスです。 |
| Condition | 検索条件のクラスです。 |
| Config | SDKの設定情報です。 |
| ContactClient | コンタクト管理APIのClientです。 |
| ContactQuery | コンタクト履歴のQueryです。 |
| Context | BaaS@rakuza APIの接続先などのコンテキスト情報です。 |
| CouponClient | クーポン管理APIのClientです。 |
| CouponQuery | クーポンのQueryです。 |
| DataClient | データ管理APIのClientです。 |
| DataFavoriteQuery | オブジェクトデータお気に入り情報のQueryです。 |
| DataQuery | オブジェクトデータのQueryです。 |
| LocaleQuery | ロケールのQueryです。 |
| MyCouponClient | マイクーポン管理APIのClientです。 |
| MyCouponQuery | マイクーポンのQueryです。 |
| NewsClient | お知らせ管理APIのClientです。 |
| NewsQuery | お知らせのQueryです。 |
| Order | ソート条件のクラスです。 |
| PointClient | ポイント管理APIのClientです。 |
| QueryBase | Queryのベースクラスです。 |
| Rakuza | BaaS@rakuzaとの接続および操作を行うAPIを提供します。 |
| RKZError | BaaS@rakuzaのエラークラスです。 |
| RKZFile | BaaS@rakuzaにアップロードするファイルクラスです。 |
| SpotQuery | スポットのQueryです。 |
| StampClient | スタンプラリー管理APIのClientです。 |
| StampHistoryQuery | スタンプ取得履歴のQueryです。 |
| StampRallyQuery | スタンプラリー情報のQueryです。 |
| StampRallySpotQuery | スタンプラリースポット情報のQueryです。 |
| UserClient | ユーザー管理APIのClientです。 |
| UserDetailClient | ユーザー詳細管理APIのClientです。 |
| UserDetailFavoriteQuery | ユーザー詳細お気に入り情報のQueryです。 |
| UserDetailQuery | ユーザー詳細のQueryです。 |
Enumerations
| Enumeration | Description |
|---|---|
| DeviceType | デバイス区分(iOSまたはAndroid)のenumです。 |
| Direction | ソート順の方向です。 |
| Operator | 検索条件の演算子です。 |
| RKZFlag | BaaS@rakuzaのAPIにおけるフラグを表現するenumです。 |
| RKZStatus | BaaS@rakuzaのAPIが返すステータスです。 |
| VisibilityType | ユーザー詳細の公開範囲です。 |
Interfaces
| Interface | Description |
|---|---|
| API | BaaS@rakuzaのAPIです。 |
| AppCredentialParam | BaaS@rakuzaの認証情報 |
| AppSettings | アプリケーション設定情報。 |
| Attributable | 汎用データプロパティを持つオブジェクトです。 |
| Beacon | ビーコン情報オブジェクト。 |
| BeaconDetectContact | ビーコン検知コンタクト情報 |
| BeaconDetectContactParam | 追加するビーコン検知コンタクト情報 |
| CommitMailAddressVerificationResult | (BETA) メールアドレス検証確定結果 |
| Contact | コンタクト情報。 |
| Coupon | クーポン情報。 |
| Data | オブジェクトデータです。 |
| DataFavorite | オブジェクトデータのお気に入り情報 |
| DataResult | データオブジェクトの検索結果です。 |
| Favorite | お気に入り情報 |
| FavoriteSummary | お気に入り集計情報 |
| Field | フィールド情報。 |
| Locale | ロケール情報。 |
| ModelChangeParam | 機種変更登録情報 |
| ModelChangeResult | 機種変更認証情報 |
| MyCoupon | マイクーポン情報 |
| News | お知らせ情報。 |
| NewsResult | お知らせ情報の検索結果です。 |
| Point | ポイント情報 |
| QRCode | QRコード情報。 |
| RKZLocation | 検索条件の位置情報オブジェクト |
| Spot | スポット情報。 |
| StampHistory | スタンプ履歴情報。 |
| StampRally | スタンプラリー情報。 |
| StampRallySpot | スタンプラリースポット情報。 |
| User | ユーザー情報。 |
| UserDetail | ユーザー詳細。 |
| UserDetailFavorite | ユーザー詳細のお気に入り情報 |
| UserDetailResult | ユーザー詳細の検索結果です。 |
Variables
| Variable | Description |
|---|---|
| RKZ | SDKのエントリポイント。see: Rakuza |
Type Aliases
| Type Alias | Description |
|---|---|
| APIJSONObject | APIのコンテンツ部に設定できる型です。 |
| DateString | 日時を表す文字列 |
| Operand | 検索条件値の型です。 |