RKZClient class
BaaS@rakuzaとの接続および操作を行うAPIを提供します。
BaaS@rakuzaにアクセスする際は、このクラスのインスタンス(instance)を参照してください。
await RKZClient.instance.init('tenantKey'); // まず、初期化を行う
final appSettings = await RKZClient.instance.appSettings(); // 初期化後、各種APIにアクセス
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addBeaconContact(
String userAccessToken, {required DateTime contactDate, required String beaconId, String? beaconSpotCd, int? rssi, String? remarks}) → Future< void> - ビーコン検知コンタクト履歴を追加します。
-
addContact(
String userAccessToken, Contact contact) → Future< void> - コンタクト履歴を1件追加します。
-
addData(
Data data) → Future< void> - オブジェクトデータを1件追加します。
-
addDataToFavorite(
String userAccessToken, String objectId, String code) → Future< void> -
codeを指定して、objectIdのデータオブジェクトをお気に入りに登録します。 -
addNewsToFavorite(
String userAccessToken, String newsId, {String? newsTenantId}) → Future< void> -
指定した
newsIdのお知らせをお気に入りに登録します。 -
addPoint(
String userAccessToken, int point, {DateTime? addedDate}) → Future< Point> - ユーザーにポイントの付与を行います。
-
addStampHistory(
String userAccessToken, String stampRallyId, String stampRallySpotCd) → Future< void> - スタンプ取得時の履歴を登録します。
-
addUserDetail(
String userAccessToken, UserDetail userDetail) → Future< UserDetail> - ユーザー詳細を1件追加します。
-
addUserDetailToFavorite(
String userAccessToken, String objectId, String id) → Future< void> -
idを指定して、objectIdのユーザー詳細をお気に入りに登録します。 -
appSettings(
) → Future< AppSettings> - BaaS@rakuzaに設定したアプリケーション設定情報を取得します。
-
auth(
String loginId, String password) → Future< User> -
ログイン情報(
loginId、password)でのユーザー認証を行います。 -
authWithModelChangeCode(
String modelChangeCode, {String? password}) → Future< User> - 機種変更認証コードの認証を行います。
-
beaconContactQuery(
String userAccessToken) → BeaconContactQuery - BeaconContactQueryを新しく生成して返します。
-
beaconQuery(
) → BeaconQuery - BeaconQueryを新しく生成して返します。
-
beginTokenUpdate(
String userAccessToken) → Future< String> - 新しいユーザーアクセストークンを仮発行します。
-
clearPushDeviceToken(
String userAccessToken) → Future< void> - Pushデバイストークンをクリアします。
-
commitTokenUpdate(
String userAccessToken) → Future< String> - 新しいユーザーアクセストークンを確定します。
-
completeStampRally(
String userAccessToken, String stampRallyId) → Future< void> - スタンプコンプリート時の履歴を登録します。
-
contactQuery(
String userAccessToken) → ContactQuery - ContactQueryを新しく生成して返します。
-
couponQuery(
) → CouponQuery - CouponQueryを新しく生成して返します。
-
dataQuery(
String objectId, {String? userAccessToken}) → DataQuery - DataQueryを新しく生成して返します。
-
deleteAllData(
String objectId) → Future< int> - オブジェクトデータをすべて削除します。
-
deleteAllUserDetail(
String userAccessToken, String objectId) → Future< int> - ユーザー詳細をすべて削除します。
-
deleteDataFromFavorite(
String userAccessToken, String objectId, String code) → Future< void> -
codeを指定して、objectIdのデータオブジェクトをお気に入りから削除します。 -
deleteNewsFromFavorite(
String userAccessToken, String newsId, {String? newsTenantId}) → Future< void> -
指定した
newsIdのお知らせをお気に入りから削除します。 -
deleteUserDetailFromFavorite(
String userAccessToken, String objectId, String id) → Future< void> -
idを指定して、objectIdのユーザー詳細をお気に入りから削除します。 -
editData(
Data data) → Future< void> - オブジェクトデータ1件を編集します。
-
editPassword(
String userAccessToken, String nowPassword, String newPassword) → Future< void> - パスワードを編集します。
-
editUser(
User user) → Future< User> - ユーザー情報を編集します。
-
editUserDetail(
String userAccessToken, UserDetail userDetail) → Future< UserDetail> - ユーザー詳細1件を編集します。
-
exchangeCoupon(
String userAccessToken, String code, int quantity) → Future< void> -
codeを指定して、マイクーポンを発行します。 -
getCoupon(
String code) → Future< Coupon> -
codeを指定して、クーポンのマスタ情報1件を取得します -
getData(
String objectId, String code) → Future< Data> -
codeを指定して、objectIdのデータオブジェクト1件を取得します -
getDataByLocation(
String objectId, String code, {RKZLocation? location, String? spotFieldName}) → Future< Data> -
codeを指定して、位置情報でデータオブジェクト1件を取得します -
getDataByQRCode(
String qrCode) → Future< Data> - QRコードで、データオブジェクト1件を取得します
-
getDataFields(
String objectId, {bool? visibleOnly = true}) → Future< List< Field> > -
BaaS@rakuzaに設定されている
objectIdのオブジェクトの項目定義情報を取得します。 -
getDataWithRelation(
String objectId, String code, {int? treeCount}) → Future< Data> -
codeを指定して、objectIdの関連オブジェクト付きのデータオブジェクト1件を取得します -
getLocale(
) → Future< String> - BaaS@rakuzaのロケール
-
getMyCoupon(
String userAccessToken, String myCouponCd) → Future< MyCoupon> -
myCouponCdを指定して、マイクーポンを1件取得します。 -
getNews(
String newsId, {String? newsTenantId}) → Future< News> -
newsIdを指定して、お知らせ1件を取得します -
getPoint(
String userAccessToken) → Future< Point> - ユーザーが保持しているポイント情報を取得します。
-
getUser(
String userAccessToken) → Future< User> - ユーザー情報を取得します。
-
getUserFields(
{bool? visibleOnly = true}) → Future< List< Field> > - BaaS@rakuzaに設定されているユーザーの項目定義情報を取得します。
-
init(
String tenantKey) → Future< void> -
テナント認証キー(
tenantKey)を用いて、SDKの初期化を行います。 -
isInitialized(
) → Future< bool> -
SDKが初期化済みの場合、
trueを返します。 -
issueModelChangeCode(
String userAccessToken, {String? password, int? limitCode, int? limitMinute}) → Future< ModelChangeResult> - 機種変更登録情報を指定して、機種変更認証コードの発行を行います。
-
localeQuery(
) → LocaleQuery - LocaleQueryを新しく生成して返します。
-
myCouponQuery(
String userAccessToken) → MyCouponQuery - MyCouponQueryを新しく生成して返します。
-
newsQuery(
{String? userAccessToken}) → NewsQuery - NewsQueryを新しく生成して返します。
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
now(
) → Future< DateTime> - BaaS@rakuzaのシステム日時を取得します。
-
readNews(
String userAccessToken, String newsId, {String? newsTenantId}) → Future< void> -
newsIdのお知らせを既読にします。 -
registerPushDeviceToken(
String userAccessToken, String deviceToken, {DeviceType? deviceType}) → Future< void> - Pushデバイストークンを登録します。
-
registerUser(
User user) → Future< User> - ユーザー情報を登録します。
-
setDefaultTimeout(
int timeout) → Future< void> - APIリクエストのタイムアウト時間(秒)を設定します。
-
setMyLocale(
String userAccessToken, String locale) → Future< String> - BaaS@rakuzaにロケールを設定します。
-
spotQuery(
) → SpotQuery - SpotQueryを新しく生成して返します。
-
stampHistoryQuery(
String userAccessToken) → StampHistoryQuery - StampHistoryQueryを新しく生成して返します。
-
stampRallyQuery(
) → StampRallyQuery - StampRallyQueryを新しく生成して返します。
-
stampRallySpotQuery(
) → StampRallySpotQuery - StampRallySpotQueryを新しく生成して返します。
-
toString(
) → String -
A string representation of this object.
inherited
-
updateToken(
String userAccessToken) → Future< String> - ユーザーアクセストークンを更新します。
-
useMyCoupon(
String userAccessToken, String myCouponCd, String couponCd) → Future< void> -
myCouponCdとcouponCdを指定して、クーポンを使用します。 -
userDetailQuery(
String objectId, {String? userAccessToken}) → UserDetailQuery - UserDetailQueryを新しく生成して返します。
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited