RKZService

Objective-C

@interface RKZService : NSObject {
  id manager;
}

Swift

class RKZService : NSObject

BaaS@rakuza を利用するためのクラス

BaaS@rakuza から情報の取得や新規登録・更新・削除を行う際に使用します。

Warning

-setTenantKey: を実行する前に各APIのメソッド呼び出しを行うと初期化エラーとなります。

manager
Undocumented
Declaration
Objective-C

id manager

Properties


                    
                    
                    initialized

RKZServiceが初期化されているか

Declaration

Objective-C

@property (nonatomic, readonly, getter=isInitialized) BOOL initialized;

Swift

var isInitialized: Bool { get }


                    
                    
                    _timeout

Undocumented

Declaration

Objective-C

@property (nonatomic, readonly) NSNumber *_timeout

Swift

var _timeout: NSNumber { get }

Class Methods

+sharedInstance
シングルトンクラスのインスタンスを返す
Declaration
Objective-C

+ (nonnull RKZService *)sharedInstance;
Swift

class func sharedInstance() -> RKZService

Instance Methods


                    
                    
                    -setTenantKey:

テナント認証を行います。

Declaration

Objective-C

- (nonnull RKZResponseStatus *)setTenantKey:(nonnull NSString *)tenantKey;

Swift

func setTenantKey(_ tenantKey: String) -> RKZResponseStatus

Parameters


                                tenantKey

契約時に配布したテナントキー(必須)

Return Value

RKZResponseStatus 初期化処理に成功するとisSuccessがYES、失敗するとNOで返却されます。
通信に成功するとテナント認証情報とシステム情報がUserdefaultsに保存され、 isInitialized がYESとなります。


                    
                    
                    -setDefaultTimeout:

Undocumented

Declaration

Objective-C

- (RKZService *) setDefaultTimeout:(int)timeout;

Swift

func setDefaultTimeout(_ timeout: Int32) -> RKZService


                    
                    
                    -setTimeout:

Undocumented

Declaration

Objective-C

- (RKZService *) setTimeout:(int)timeout;

Swift

func setTimeout(_ timeout: Int32) -> RKZService

User


                    
                    
                    -registUser:withBlock:

ユーザー登録

Declaration

Objective-C

- (void)registUser:(nonnull RKZUserData *)userData
         withBlock:(nonnull void (^)(RKZUserData *_Nullable,
                                     RKZResponseStatus *_Nonnull))block;

Swift

func registUser(_ userData: RKZUserData, with block: @escaping (RKZUserData?, RKZResponseStatus) -> Void)

Parameters

`userData`	登録するユーザー情報(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZUserData userData, RKZResponseStatus responseStatus )


                    
                    
                    -editUser:withBlock:

ユーザー編集

Declaration

Objective-C

- (void)editUser:(nonnull RKZUserData *)userData
       withBlock:(nonnull void (^)(RKZUserData *_Nullable,
                                   RKZResponseStatus *_Nonnull))block;

Swift

func editUser(_ userData: RKZUserData, with block: @escaping (RKZUserData?, RKZResponseStatus) -> Void)

Parameters

`userData`	編集するユーザー情報 user_access_token を使用する
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ (UserData* userData, RKZResponseStatus *responseStatus) 通信に成功するとユーザーモデル:userDataが返却され、通信に失敗すると楽座エラー:rakuzaErrorが返却される。


                    
                    
                    -getUser:withBlock:

ユーザー情報取得

Declaration

Objective-C

- (void)getUser:(nonnull NSString *)userAccessToken
      withBlock:(nonnull void (^)(RKZUserData *_Nullable,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func getUser(_ userAccessToken: String, with block: @escaping (RKZUserData?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZUserData userData, RKZResponseStatus responseStatus )


                    
                    
                    -getEditUserWebView:withBlock:

ユーザー編集WebView取得

[RKZUserEditWebView startWebView] を実行すると WebView が開始されます。

Declaration

Objective-C

- (void)getEditUserWebView:(nonnull RKZUserData *)userData
                 withBlock:(nonnull void (^)(RKZUserEditWebView *_Nullable,
                                             RKZResponseStatus *_Nonnull))block;

Swift

func getEditUserWebView(_ userData: RKZUserData, with block: @escaping (RKZUserEditWebView?, RKZResponseStatus) -> Void)

Parameters

`userData`	編集するユーザー情報 user_access_token を使用する(必須)
`block`	必須チェック後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZUserEditWebView userEditWebView, RKZResponseStatus responseStatus )


                    
                    
                    -editPassword:nowPassword:newPassword:withBlock:

利用者のパスワード情報を変更する。

Declaration

Objective-C

- (void)editPassword:(nonnull NSString *)userAccessToken
         nowPassword:(nonnull NSString *)nowPassword
         newPassword:(nonnull NSString *)newPassword
           withBlock:(nonnull void (^)(RKZApiStatusCode,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func editPassword(_ userAccessToken: String, nowPassword: String, newPassword: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`nowPassword`	現在のパスワード(必須)
`newPassword`	新パスワード(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -deleteUser:withBlock:

ユーザー情報を削除する

Declaration

Objective-C

- (void)deleteUser:(nonnull NSString *)userAccessToken
         withBlock:(nonnull void (^)(RKZApiStatusCode,
                                     RKZResponseStatus *_Nonnull))block;

Swift

func deleteUser(_ userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -getEditPasswordWebView:withBlock:

パスワード変更WebView取得

[RKZEditPasswordWebView startWebView] を実行すると WebView が開始されます。

Declaration

Objective-C

- (void)getEditPasswordWebView:(nonnull NSString *)userAccessToken
                     withBlock:
                         (nonnull void (^)(RKZEditPasswordWebView *_Nullable,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getEditPasswordWebView(_ userAccessToken: String, with block: @escaping (RKZEditPasswordWebView?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`block`	必須チェック後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZEditPasswordWebView editPasswordWebView, RKZResponseStatus responseStatus )


                    
                    
                    -registModelChangeCode:withBlock:

機種変更コードを発行する。(パラメータ単数)

Declaration

Objective-C

- (void)registModelChangeCode:(nonnull NSString *)userAccessToken
                    withBlock:
                        (nonnull void (^)(NSString *_Nullable,
                                          NSDate *_Nullable,
                                          RKZResponseStatus *_Nonnull))block;

Swift

func registModelChangeCode(_ userAccessToken: String, with block: @escaping (String?, Date?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSString modelChangeCode, NSDate limitDate, RKZResponseStatus *responseStatus )


                    
                    
                    -registModelChangeCode:password:limitCode:limitMinute:withBlock:

機種変更認証コードを発行する。(パラメータ複数)

Declaration

Objective-C

- (void)registModelChangeCode:(nonnull NSString *)userAccessToken
                     password:(nullable NSString *)password
                    limitCode:(nullable NSNumber *)limitCode
                  limitMinute:(nullable NSNumber *)limitMinute
                    withBlock:
                        (nonnull void (^)(NSString *_Nullable,
                                          NSDate *_Nullable,
                                          RKZResponseStatus *_Nonnull))block;

Swift

func registModelChangeCode(_ userAccessToken: String, password: String?, limitCode: NSNumber?, limitMinute: NSNumber?, with block: @escaping (String?, Date?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン
`password`	パスワード
`limitCode`	桁数
`limitMinute`	有効時間(分)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSString modelChangeCode, NSDate limitDate, RKZResponseStatus *responseStatus )


                    
                    
                    -authModelChange:withBlock:

機種変更の認証を行う。(パラメータ単数)

Declaration

Objective-C

- (void)authModelChange:(nonnull NSString *)modelChangeCode
              withBlock:(nonnull void (^)(RKZUserData *_Nullable,
                                          RKZResponseStatus *_Nonnull))block;

Swift

func authModelChange(_ modelChangeCode: String, with block: @escaping (RKZUserData?, RKZResponseStatus) -> Void)

Parameters

`modelChangeCode`	認証コード
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZUserData* userData, RKZResponseStatus *responseStatus )


                    
                    
                    -authModelChange:password:withBlock:

機種変更の認証を行う。(パラメータ複数)

Declaration

Objective-C

- (void)authModelChange:(nonnull NSString *)modelChangeCode
               password:(nullable NSString *)password
              withBlock:(nonnull void (^)(RKZUserData *_Nullable,
                                          RKZResponseStatus *_Nonnull))block;

Swift

func authModelChange(_ modelChangeCode: String, password: String?, with block: @escaping (RKZUserData?, RKZResponseStatus) -> Void)

Parameters

`modelChangeCode`	認証コード
`password`	パスワード
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZUserData* userData, RKZResponseStatus *responseStatus )


                    
                    
                    -userAuth:password:withBlock:

ログインを行う。

Declaration

Objective-C

- (void)userAuth:(nonnull NSString *)loginId
        password:(nonnull NSString *)password
       withBlock:(nonnull void (^)(RKZUserData *_Nullable,
                                   RKZResponseStatus *_Nonnull))block;

Swift

func userAuth(_ loginId: String, password: String, with block: @escaping (RKZUserData?, RKZResponseStatus) -> Void)

Parameters

`loginId`	ログインID
`password`	パスワード
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZUserData* userData, RKZResponseStatus *responseStatus )


                    
                    
                    -updateUserAccessToken:withBlock:

ユーザーアクセストークン更新

現在利用中のユーザーアクセストークンを更新する。

Declaration

Objective-C

- (void)updateUserAccessToken:(nonnull NSString *)userAccessToken
                    withBlock:
                        (nonnull void (^)(NSString *_Nullable,
                                          RKZResponseStatus *_Nonnull))block;

Swift

func updateUserAccessToken(_ userAccessToken: String, with block: @escaping (String?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	現在利用中のユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ (NSString newUserAccessToken, RKZResponseStatus responseStatus)


                    
                    
                    -beginUpdateUserAccessToken:withBlock:

ユーザーアクセストークン更新開始

現在利用中のユーザーアクセストークンを更新する。
このメソッドで発行される新ユーザーアクセストークンは commitUpdateUserAccessToken: が呼び出されるまで利用できない。

Declaration

Objective-C

- (void)beginUpdateUserAccessToken:(nonnull NSString *)userAccessToken
                         withBlock:(nonnull void (^)(
                                       NSString *_Nullable,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func beginUpdateUserAccessToken(_ userAccessToken: String, with block: @escaping (String?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	現在利用中のユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ (NSString newUserAccessToken, RKZResponseStatus responseStatus)


                    
                    
                    -commitUpdateUserAccessToken:withBlock:

ユーザーアクセストークン更新確定

現在利用中のユーザーアクセストークンを更新する。

Declaration

Objective-C

- (void)commitUpdateUserAccessToken:(nonnull NSString *)userAccessToken
                          withBlock:(nonnull void (^)(
                                        NSString *_Nullable,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func commitUpdateUserAccessToken(_ userAccessToken: String, with block: @escaping (String?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	現在利用中のユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ (NSString newUserAccessToken, RKZResponseStatus responseStatus)


                    
                    
                    -fixedUserAccessToken:

新ユーザーアクセストークン確定

発行された新しいユーザーアクセストークンを確定する。

Declaration

Objective-C

- (void)fixedUserAccessToken:(nonnull NSString *)newUserAccessToken;

Swift

func fixedUserAccessToken(_ newUserAccessToken: String)

Parameters


                                block

通信後にblockが実行される。 blockは次の引数のシグネチャを持つ
( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -setLocale:locale:withBlock:

使用言語登録

パラメータで指定されたの言語情報をサーバーに登録する。
送信された言語情報より、BaaSにて利用可能な言語か判定して、利用可能な言語の場合はその言語情報を登録する。
利用できない言語情報だった場合、BaaSにて利用可能な言語に置き換えた結果を登録する。置き換えた言語情報は復帰値として返却される。
楽座にて利用可能な言語が特定できない場合は、null でサーバーに登録される。

Declaration

Objective-C

- (void)setLocale:(nullable NSString *)userAccessToken
           locale:(nonnull NSLocale *)locale
        withBlock:(nonnull void (^)(NSLocale *_Nullable,
                                    RKZResponseStatus *_Nonnull))block;

Swift

func setLocale(_ userAccessToken: String?, locale: Locale, with block: @escaping (Locale?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	使用言語を登録するユーザーアクセストークン(必須)
`locale`	登録する言語情報(必須)
`block`	登録処理後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSLocale updateLocale, RKZResponseStatus responseStatus )


                    
                    
                    -getUserFieldDataList:

ユーザーオブジェクトのフィールド情報取得

Declaration

Objective-C

- (void)getUserFieldDataList:
    (nonnull void (^)(NSArray<RKZFieldData *> *_Nonnull,
                      RKZResponseStatus *_Nonnull))block;

Swift

func getUserFieldDataList(_ block: @escaping ([RKZFieldData], RKZResponseStatus) -> Void)

Parameters


                                block

通信後にblockが実行される。 blockは次の引数のシグネチャを持つ
( NSArray *rkzFieldArray, RKZResponseStatus *responseStatus )


                    
                    
                    -getUserFieldDataList:withBlock:

ユーザーオブジェクトのフィールド情報取得 visibleOnlyを指定することで、表示、非表示の項目の取得が切り替えできる。

Declaration

Objective-C

- (void)getUserFieldDataList:(BOOL)visibleFieldOnly
                   withBlock:
                       (nonnull void (^)(NSArray<RKZFieldData *> *_Nonnull,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getUserFieldDataList(_ visibleFieldOnly: Bool, with block: @escaping ([RKZFieldData], RKZResponseStatus) -> Void)

Parameters

`visibleFieldOnly`	表示のみ取得フラグ (true:表示設定のみ, false:非表示も含める)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray rkzFieldArray, RKZResponseStatus responseStatus )

Point


                    
                    
                    -getPoint:withBlock:

所持ポイント情報取得

Declaration

Objective-C

- (void)getPoint:(nonnull NSString *)userAccessToken
       withBlock:(nonnull void (^)(RKZPointData *_Nullable,
                                   RKZResponseStatus *_Nonnull))block;

Swift

func getPoint(_ userAccessToken: String, with block: @escaping (RKZPointData?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPointData pointData, RKZResponseStatus responseStatus )


                    
                    
                    -addPoint:point:contactDate:withBlock:

ポイント加算減算

Declaration

Objective-C

- (void)addPoint:(nonnull NSString *)userAccessToken
           point:(nonnull NSNumber *)point
     contactDate:(nullable NSDate *)contactDate
       withBlock:(nonnull void (^)(RKZPointData *_Nullable,
                                   RKZResponseStatus *_Nonnull))block;

Swift

func addPoint(_ userAccessToken: String, point: NSNumber, contactDate: Date?, with block: @escaping (RKZPointData?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`point`	加算減算を行うポイント数:point(必須)
`contactDate`	コンタクト日: contact_date を指定 (yyyy-MM-dd hh:mm:ss)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPointData pointData, RKZResponseStatus responseStatus )

Coupon


                    
                    
                    -getCoupon:withBlock:

クーポン取得（単一クーポン）

Declaration

Objective-C

- (void)getCoupon:(nonnull NSString *)code
        withBlock:(nonnull void (^)(RKZCouponData *_Nullable,
                                    RKZResponseStatus *_Nonnull))block;

Swift

func getCoupon(_ code: String, with block: @escaping (RKZCouponData?, RKZResponseStatus) -> Void)

Parameters

`code`	クーポンコード:code を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZCouponData　couponData, RKZResponseStatus responseStatus )


                    
                    
                    -getCouponList:sortConditionArray:withBlock:

クーポン取得（複数クーポン）

Declaration

Objective-C

- (void)getCouponList:
            (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
    sortConditionArray:
        (nullable NSArray<RKZSortCondition *> *)sortConditionArray
             withBlock:(nonnull void (^)(NSArray<RKZCouponData *> *_Nonnull,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getCouponList(_ searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZCouponData], RKZResponseStatus) -> Void)

Parameters

`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZCouponData)　couponDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -exchangeCoupon:couponCd:quantity:withBlock:

クーポン交換

Declaration

Objective-C

- (void)exchangeCoupon:(nonnull NSString *)userAccessToken
              couponCd:(nonnull NSString *)couponCd
              quantity:(nullable NSNumber *)quantity
             withBlock:(nonnull void (^)(RKZApiStatusCode,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func exchangeCoupon(_ userAccessToken: String, couponCd: String, quantity: NSNumber?, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`couponCd`	クーポンコード:code を指定する(必須)
`quantity`	クーポン枚数:quantity を指定する(任意) 交換クーポン数が nil もしくは「0」や負数の場合は「1」として処理されます。
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -useMyCoupon:myCouponData:withBlock:

クーポン利用

Declaration

Objective-C

- (void)useMyCoupon:(nonnull NSString *)userAccessToken
       myCouponData:(nonnull RKZMyCouponData *)myCouponData
          withBlock:(nonnull void (^)(RKZApiStatusCode,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func useMyCoupon(_ userAccessToken: String, myCouponData: RKZMyCouponData, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`myCouponData`	マイクーポンコード:code クーポンコード:coupon_cd を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -getMyCoupon:myCouponCd:withBlock:

マイクーポン取得（マイクーポン指定）

Declaration

Objective-C

- (void)getMyCoupon:(nonnull NSString *)userAccessToken
         myCouponCd:(nonnull NSString *)myCouponCd
          withBlock:(nonnull void (^)(RKZMyCouponData *_Nullable,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func getMyCoupon(_ userAccessToken: String, myCouponCd: String, with block: @escaping (RKZMyCouponData?, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`myCouponCd`	マイクーポンコード:code を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZMyCouponData myCouponData, RKZResponseStatus responseStatus )


                    
                    
                    -getMyCouponList:searchConditionArray:sortConditionArray:withBlock:

マイクーポン取得（マイクーポン指定なし）

Declaration

Objective-C

- (void)getMyCouponList:(nonnull NSString *)userAccessToken
    searchConditionArray:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
      sortConditionArray:
          (nullable NSArray<RKZSortCondition *> *)sortConditionArray
               withBlock:(nonnull void (^)(NSArray<RKZMyCouponData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getMyCouponList(_ userAccessToken: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZMyCouponData], RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZMyCouponData) myCouponDataArray, RKZResponseStatus responseStatus )

Beacon


                    
                    
                    -getBeaconList:sortConditionArray:withBlock:

ビーコン情報取得

Declaration

Objective-C

- (void)getBeaconList:
            (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
    sortConditionArray:
        (nullable NSArray<RKZSortCondition *> *)sortConditionArray
             withBlock:(nonnull void (^)(NSArray<RKZBeaconData *> *_Nonnull,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getBeaconList(_ searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZBeaconData], RKZResponseStatus) -> Void)

Parameters

`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZBeaconData) beaconDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getBeaconSpotList:sortConditionArray:withBlock:

ビーコンスポット情報取得

Warning

ビーコンスポットに紐づくビーコンIDを検索条件に指定する場合、検索条件タイプ:RKZSearchConditionLikeOr ,検索項目名:“beacon” でビーコンIDを指定してください。

Declaration

Objective-C

- (void)getBeaconSpotList:
            (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
       sortConditionArray:
           (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                withBlock:(nonnull void (^)(NSArray<RKZBeaconData *> *_Nonnull,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func getBeaconSpotList(_ searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZBeaconData], RKZResponseStatus) -> Void)

Parameters

`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZBeaconSpotData) beaconSpotDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -addDetectBeaconContact:beaconId:contactDate:beaconSpotCd:rssi:remarks:withBlock:

ビーコン検知コンタクト追加

Declaration

Objective-C

- (void)addDetectBeaconContact:(nonnull NSString *)userAccessToken
                      beaconId:(nonnull NSString *)beaconId
                   contactDate:(nonnull NSDate *)contactDate
                  beaconSpotCd:(nullable NSString *)beaconSpotCd
                          rssi:(nullable NSString *)rssi
                       remarks:(nullable NSString *)remarks
                     withBlock:
                         (nonnull void (^)(RKZApiStatusCode,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func addDetectBeaconContact(_ userAccessToken: String, beaconId: String, contactDate: Date, beaconSpotCd: String?, rssi: String?, remarks: String?, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`beaconId`	ビーコンID:beacon_id を指定する(必須)
`contactDate`	ビーコン検知コンタクト日時（日付型）:contactDate を指定する(必須)
`beaconSpotCd`	スポットコード:beacon_spot_cd を指定する(任意)
`rssi`	RSSI:rssi を指定する(任意)
`remarks`	備考:remarks を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -getDetectBeaconContact:searchConditionArray:sortConditionArray:withBlock:

ビーコン検知コンタクト取得

Declaration

Objective-C

- (void)getDetectBeaconContact:(nonnull NSString *)userAccessToken
          searchConditionArray:
              (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
            sortConditionArray:
                (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                     withBlock:
                         (nonnull void (^)(
                             NSArray<RKZBeaconDetectContactData *> *_Nonnull,
                             RKZResponseStatus *_Nonnull))block;

Swift

func getDetectBeaconContact(_ userAccessToken: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZBeaconDetectContactData], RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZBeaconDetectContactData)　detectBeaconContactArray, RKZResponseStatus responseStatus )

Spot


                    
                    
                    -getSpotList:sortConditionArray:withBlock:

スポット情報取得

Declaration

Objective-C

- (void)getSpotList:
            (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
    sortConditionArray:
        (nullable NSArray<RKZSortCondition *> *)sortConditionArray
             withBlock:(nonnull void (^)(NSArray<RKZSpotData *> *_Nonnull,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getSpotList(_ searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZSpotData], RKZResponseStatus) -> Void)

Parameters

`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZSpotData) spotDataArray, RKZResponseStatus responseStatus )

Locale


                    
                    
                    -getLocaleList:sortConditionArray:withBlock:

楽座に設定されている言語リストを取得する。

Declaration

Objective-C

- (void)getLocaleList:
            (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
    sortConditionArray:
        (nullable NSArray<RKZSortCondition *> *)sortConditionArray
             withBlock:(nonnull void (^)(NSArray<RKZLocaleData *> *_Nonnull,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getLocaleList(_ searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZLocaleData], RKZResponseStatus) -> Void)

Parameters

`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZLocaleData) localeDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -setLocale:

Deprecated

SDKに利用する言語情報(NSLocale)を設定します。
このメソッドにて設定したLocaleに該当するコンテンツがサーバより取得されるようになります。

Declaration

Objective-C

- (void)setLocale:(nonnull NSLocale *)locale;

Swift

func setLocale(_ locale: Locale)

Parameters


                                locale

設定するLocaleを指定する。

-getLocale
SDKに設定されている言語情報(NSLocale)を取得します。
Declaration
Objective-C

- (nonnull NSLocale *)getLocale;
Swift

func getLocale() -> Locale
Return Value

NSLocale 設定されているlocale情報

News


                    
                    
                    -getNews:withBlock:

お知らせ取得（ニュースID指定）

Declaration

Objective-C

- (void)getNews:(nonnull NSString *)newsId
      withBlock:(nonnull void (^)(RKZNewsData *_Nullable,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func getNews(_ newsId: String, with block: @escaping (RKZNewsData?, RKZResponseStatus) -> Void)

Parameters

`newsId`	ニュースID:news_id を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZNewsData newsData, RKZResponseStatus responseStatus )


                    
                    
                    -getNews:tenantId:withBlock:

お知らせ取得（ニュースID指定）

Declaration

Objective-C

- (void)getNews:(nonnull NSString *)newsId
       tenantId:(nonnull NSString *)tenantId
      withBlock:(nonnull void (^)(RKZNewsData *_Nullable,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func getNews(_ newsId: String, tenantId: String, with block: @escaping (RKZNewsData?, RKZResponseStatus) -> Void)

Parameters

`newsId`	ニュースID:news_id を指定する(必須)
`tenantId`	テナントID:検索対象となるnewsを登録したテナントのIDを指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZNewsData newsData, RKZResponseStatus responseStatus )


                    
                    
                    -getReleasedNewsList:searchConditionArray:sortConditionArray:withBlock:

お知らせ取得（公開中のみ）（ニュースID未指定）

Declaration

Objective-C

- (void)getReleasedNewsList:(nullable NSNumber *)limit
       searchConditionArray:
           (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
         sortConditionArray:
             (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                  withBlock:
                      (nonnull void (^)(NSArray<RKZNewsData *> *_Nonnull,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getReleasedNewsList(_ limit: NSNumber?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZNewsData], RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数を指定する(任意) nilを設定した場合は全件取得を行います
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsData) newsDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getReleasedNewsList:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

お知らせ取得（公開中のみ）（ニュースID未指定）

Declaration

Objective-C

- (void)
     getReleasedNewsList:(nullable NSNumber *)limit
    searchConditionArray:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
      sortConditionArray:
          (nullable NSArray<RKZSortCondition *> *)sortConditionArray
      extensionAttribute:(nonnull RKZNewsExtensionAttribute *)extensionAttribute
               withBlock:(nonnull void (^)(NSArray<RKZNewsData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getReleasedNewsList(_ limit: NSNumber?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZNewsExtensionAttribute, with block: @escaping ([RKZNewsData], RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数を指定する(任意) nilを設定した場合は全件取得を行います
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsData) newsDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateReleasedNewsList:offset:searchConditionArray:sortConditionArray:withBlock:

お知らせ取得（公開中のみ）（ニュースID未指定）

Declaration

Objective-C

- (void)getPaginateReleasedNewsList:(nonnull NSNumber *)limit
                             offset:(nonnull NSNumber *)offset
               searchConditionArray:(nullable NSArray<RKZSearchCondition *> *)
                                        searchConditionArray
                 sortConditionArray:
                     (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                          withBlock:(nonnull void (^)(
                                        RKZPagingData<RKZNewsData *> *_Nonnull,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateReleasedNewsList(_ limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZNewsData>, RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateReleasedNewsList:offset:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

お知らせ取得（公開中のみ）（ニュースID未指定）

Declaration

Objective-C

- (void)getPaginateReleasedNewsList:(nonnull NSNumber *)limit
                             offset:(nonnull NSNumber *)offset
               searchConditionArray:(nullable NSArray<RKZSearchCondition *> *)
                                        searchConditionArray
                 sortConditionArray:
                     (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                 extensionAttribute:
                     (nonnull RKZNewsExtensionAttribute *)extensionAttribute
                          withBlock:(nonnull void (^)(
                                        RKZPagingData<RKZNewsData *> *_Nonnull,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateReleasedNewsList(_ limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZNewsExtensionAttribute, with block: @escaping (RKZPagingData<RKZNewsData>, RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )
`extensionAttribute`	拡張オブジェクト検索条件値(必須)


                    
                    
                    -getReleasedSegmentNewsList:userAccessToken:onlyMatchSegment:searchConditionArray:sortConditionArray:withBlock:

お知らせ取得（公開中のみ）（ニュースID未指定）

Declaration

Objective-C

- (void)getReleasedSegmentNewsList:(nullable NSNumber *)limit
                   userAccessToken:(nonnull NSString *)userAccessToken
                  onlyMatchSegment:(BOOL)onlyMatchSegment
              searchConditionArray:
                  (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
                sortConditionArray:
                    (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                         withBlock:(nonnull void (^)(
                                       NSArray<RKZNewsData *> *_Nonnull,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func getReleasedSegmentNewsList(_ limit: NSNumber?, userAccessToken: String, onlyMatchSegment: Bool, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZNewsData], RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数を指定する(任意) nilを設定した場合は全件取得を行います
`userAccessToken`	ユーザーアクセストークン
`onlyMatchSegment`	配信条件一致分のみ取得するか否か (YES:配信条件一致分のみ取得、NO:以外も取得)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsData) newsDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getReleasedSegmentNewsList:userAccessToken:onlyMatchSegment:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

お知らせ取得（公開中のみ）（ニュースID未指定）

Declaration

Objective-C

- (void)getReleasedSegmentNewsList:(nullable NSNumber *)limit
                   userAccessToken:(nonnull NSString *)userAccessToken
                  onlyMatchSegment:(BOOL)onlyMatchSegment
              searchConditionArray:
                  (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
                sortConditionArray:
                    (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                extensionAttribute:
                    (nonnull RKZNewsExtensionAttribute *)extensionAttribute
                         withBlock:(nonnull void (^)(
                                       NSArray<RKZNewsData *> *_Nonnull,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func getReleasedSegmentNewsList(_ limit: NSNumber?, userAccessToken: String, onlyMatchSegment: Bool, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZNewsExtensionAttribute, with block: @escaping ([RKZNewsData], RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数を指定する(任意) nilを設定した場合は全件取得を行います
`userAccessToken`	ユーザーアクセストークン
`onlyMatchSegment`	配信条件一致分のみ取得するか否か (YES:配信条件一致分のみ取得、NO:以外も取得)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsData) newsDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateReleasedSegmentNewsList:offset:userAccessToken:onlyMatchSegment:searchConditionArray:sortConditionArray:withBlock:

お知らせ取得（公開中のみ）（ニュースID未指定）

Declaration

Objective-C

- (void)getPaginateReleasedSegmentNewsList:(nonnull NSNumber *)limit
                                    offset:(nonnull NSNumber *)offset
                           userAccessToken:(nonnull NSString *)userAccessToken
                          onlyMatchSegment:(BOOL)onlyMatchSegment
                      searchConditionArray:
                          (nullable NSArray<RKZSearchCondition *> *)
                              searchConditionArray
                        sortConditionArray:
                            (nullable NSArray<RKZSortCondition *> *)
                                sortConditionArray
                                 withBlock:
                                     (nonnull void (^)(
                                         RKZPagingData<RKZNewsData *> *_Nonnull,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateReleasedSegmentNewsList(_ limit: NSNumber, offset: NSNumber, userAccessToken: String, onlyMatchSegment: Bool, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZNewsData>, RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`userAccessToken`	ユーザーアクセストークン
`onlyMatchSegment`	配信条件一致分のみ取得するか否か (YES:配信条件一致分のみ取得、NO:以外も取得)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateReleasedSegmentNewsList:offset:userAccessToken:onlyMatchSegment:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

お知らせ取得（公開中のみ）（ニュースID未指定）

Declaration

Objective-C

- (void)getPaginateReleasedSegmentNewsList:(nonnull NSNumber *)limit
                                    offset:(nonnull NSNumber *)offset
                           userAccessToken:(nonnull NSString *)userAccessToken
                          onlyMatchSegment:(BOOL)onlyMatchSegment
                      searchConditionArray:
                          (nullable NSArray<RKZSearchCondition *> *)
                              searchConditionArray
                        sortConditionArray:
                            (nullable NSArray<RKZSortCondition *> *)
                                sortConditionArray
                        extensionAttribute:(nonnull RKZNewsExtensionAttribute *)
                                               extensionAttribute
                                 withBlock:
                                     (nonnull void (^)(
                                         RKZPagingData<RKZNewsData *> *_Nonnull,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateReleasedSegmentNewsList(_ limit: NSNumber, offset: NSNumber, userAccessToken: String, onlyMatchSegment: Bool, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZNewsExtensionAttribute, with block: @escaping (RKZPagingData<RKZNewsData>, RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`userAccessToken`	ユーザーアクセストークン
`onlyMatchSegment`	配信条件一致分のみ取得するか否か (YES:配信条件一致分のみ取得、NO:以外も取得)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )
`extensionAttribute`	拡張オブジェクト検索条件値(必須)


                    
                    
                    -getNewsList:searchConditionArray:sortConditionArray:withBlock:

お知らせ取得（非公開含む）

Declaration

Objective-C

- (void)getNewsList:(nullable NSNumber *)limit
    searchConditionArray:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
      sortConditionArray:
          (nullable NSArray<RKZSortCondition *> *)sortConditionArray
               withBlock:(nonnull void (^)(NSArray<RKZNewsData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getNewsList(_ limit: NSNumber?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZNewsData], RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数を指定する(任意) nilを設定した場合は全件取得を行います
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsData) newsDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getNewsList:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

お知らせ取得（非公開含む）

Declaration

Objective-C

- (void)getNewsList:(nullable NSNumber *)limit
    searchConditionArray:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
      sortConditionArray:
          (nullable NSArray<RKZSortCondition *> *)sortConditionArray
      extensionAttribute:(nonnull RKZNewsExtensionAttribute *)extensionAttribute
               withBlock:(nonnull void (^)(NSArray<RKZNewsData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getNewsList(_ limit: NSNumber?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZNewsExtensionAttribute, with block: @escaping ([RKZNewsData], RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数を指定する(任意) nilを設定した場合は全件取得を行います
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsData) newsDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateNewsList:offset:searchConditionArray:sortConditionArray:withBlock:

お知らせ取得（非公開含む）

Declaration

Objective-C

- (void)getPaginateNewsList:(nonnull NSNumber *)limit
                     offset:(nonnull NSNumber *)offset
       searchConditionArray:
           (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
         sortConditionArray:
             (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                  withBlock:
                      (nonnull void (^)(RKZPagingData<RKZNewsData *> *_Nonnull,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateNewsList(_ limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZNewsData>, RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateNewsList:offset:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

お知らせ取得（非公開含む）

Declaration

Objective-C

- (void)getPaginateNewsList:(nonnull NSNumber *)limit
                     offset:(nonnull NSNumber *)offset
       searchConditionArray:
           (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
         sortConditionArray:
             (nullable NSArray<RKZSortCondition *> *)sortConditionArray
         extensionAttribute:
             (nonnull RKZNewsExtensionAttribute *)extensionAttribute
                  withBlock:
                      (nonnull void (^)(RKZPagingData<RKZNewsData *> *_Nonnull,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateNewsList(_ limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZNewsExtensionAttribute, with block: @escaping (RKZPagingData<RKZNewsData>, RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )
`extensionAttribute`	拡張オブジェクト検索条件値(必須)


                    
                    
                    -getSegmentNewsList:userAccessToken:onlyMatchSegment:searchConditionArray:sortConditionArray:withBlock:

お知らせ取得（非公開含む）

Declaration

Objective-C

- (void)getSegmentNewsList:(nullable NSNumber *)limit
           userAccessToken:(nonnull NSString *)userAccessToken
          onlyMatchSegment:(BOOL)onlyMatchSegment
      searchConditionArray:
          (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
        sortConditionArray:
            (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                 withBlock:(nonnull void (^)(NSArray<RKZNewsData *> *_Nonnull,
                                             RKZResponseStatus *_Nonnull))block;

Swift

func getSegmentNewsList(_ limit: NSNumber?, userAccessToken: String, onlyMatchSegment: Bool, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZNewsData], RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数を指定する(任意) nilを設定した場合は全件取得を行います
`userAccessToken`	ユーザーアクセストークン
`onlyMatchSegment`	配信条件一致分のみ取得するか否か (YES:配信条件一致分のみ取得、NO:以外も取得)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsData) newsDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getSegmentNewsList:userAccessToken:onlyMatchSegment:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

お知らせ取得（非公開含む）

Declaration

Objective-C

- (void)getSegmentNewsList:(nullable NSNumber *)limit
           userAccessToken:(nonnull NSString *)userAccessToken
          onlyMatchSegment:(BOOL)onlyMatchSegment
      searchConditionArray:
          (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
        sortConditionArray:
            (nullable NSArray<RKZSortCondition *> *)sortConditionArray
        extensionAttribute:
            (nonnull RKZNewsExtensionAttribute *)extensionAttribute
                 withBlock:(nonnull void (^)(NSArray<RKZNewsData *> *_Nonnull,
                                             RKZResponseStatus *_Nonnull))block;

Swift

func getSegmentNewsList(_ limit: NSNumber?, userAccessToken: String, onlyMatchSegment: Bool, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZNewsExtensionAttribute, with block: @escaping ([RKZNewsData], RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数を指定する(任意) nilを設定した場合は全件取得を行います
`userAccessToken`	ユーザーアクセストークン
`onlyMatchSegment`	配信条件一致分のみ取得するか否か (YES:配信条件一致分のみ取得、NO:以外も取得)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsData) newsDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateSegmentNewsList:offset:userAccessToken:onlyMatchSegment:searchConditionArray:sortConditionArray:withBlock:

お知らせ取得（非公開含む）

Declaration

Objective-C

- (void)getPaginateSegmentNewsList:(nonnull NSNumber *)limit
                            offset:(nonnull NSNumber *)offset
                   userAccessToken:(nonnull NSString *)userAccessToken
                  onlyMatchSegment:(BOOL)onlyMatchSegment
              searchConditionArray:
                  (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
                sortConditionArray:
                    (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                         withBlock:(nonnull void (^)(
                                       RKZPagingData<RKZNewsData *> *_Nonnull,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateSegmentNewsList(_ limit: NSNumber, offset: NSNumber, userAccessToken: String, onlyMatchSegment: Bool, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZNewsData>, RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`userAccessToken`	ユーザーアクセストークン
`onlyMatchSegment`	配信条件一致分のみ取得するか否か (YES:配信条件一致分のみ取得、NO:以外も取得)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateSegmentNewsList:offset:userAccessToken:onlyMatchSegment:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

お知らせ取得（非公開含む）

Declaration

Objective-C

- (void)getPaginateSegmentNewsList:(nonnull NSNumber *)limit
                            offset:(nonnull NSNumber *)offset
                   userAccessToken:(nonnull NSString *)userAccessToken
                  onlyMatchSegment:(BOOL)onlyMatchSegment
              searchConditionArray:
                  (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
                sortConditionArray:
                    (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                extensionAttribute:
                    (nonnull RKZNewsExtensionAttribute *)extensionAttribute
                         withBlock:(nonnull void (^)(
                                       RKZPagingData<RKZNewsData *> *_Nonnull,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateSegmentNewsList(_ limit: NSNumber, offset: NSNumber, userAccessToken: String, onlyMatchSegment: Bool, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZNewsExtensionAttribute, with block: @escaping (RKZPagingData<RKZNewsData>, RKZResponseStatus) -> Void)

Parameters

`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`userAccessToken`	ユーザーアクセストークン
`onlyMatchSegment`	配信条件一致分のみ取得するか否か (YES:配信条件一致分のみ取得、NO:以外も取得)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )
`extensionAttribute`	拡張オブジェクト検索条件値(必須)


                    
                    
                    -getNewsReadHistory:userAccessToken:withBlock:

お知らせ既読情報取得（ニュースID指定）

Declaration

Objective-C

- (void)getNewsReadHistory:(nonnull NSString *)newsId
           userAccessToken:(nonnull NSString *)userAccessToken
                 withBlock:(nonnull void (^)(RKZNewsReadHistoryData *_Nullable,
                                             RKZResponseStatus *_Nonnull))block;

Swift

func getNewsReadHistory(_ newsId: String, userAccessToken: String, with block: @escaping (RKZNewsReadHistoryData?, RKZResponseStatus) -> Void)

Parameters

`newsId`	ニュースID:news_id を指定する(必須)
`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZNewsReadHistoryData newsReadHistoryData, RKZResponseStatus responseStatus )


                    
                    
                    -getNewsReadHistory:tenantId:userAccessToken:withBlock:

お知らせ既読情報取得（ニュースID指定）

Declaration

Objective-C

- (void)getNewsReadHistory:(nonnull NSString *)newsId
                  tenantId:(nonnull NSString *)tenantId
           userAccessToken:(nonnull NSString *)userAccessToken
                 withBlock:(nonnull void (^)(RKZNewsReadHistoryData *_Nullable,
                                             RKZResponseStatus *_Nonnull))block;

Swift

func getNewsReadHistory(_ newsId: String, tenantId: String, userAccessToken: String, with block: @escaping (RKZNewsReadHistoryData?, RKZResponseStatus) -> Void)

Parameters

`newsId`	ニュースID:news_id を指定する(必須)
`tenantId`	テナントID:newsを登録したテナントのIDを指定する(必須)
`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZNewsReadHistoryData newsReadHistoryData, RKZResponseStatus responseStatus )


                    
                    
                    -getNewsReadHistoryList:withBlock:

お知らせ既読情報取得（ニュースID未指定）

Declaration

Objective-C

- (void)getNewsReadHistoryList:(nonnull NSString *)userAccessToken
                     withBlock:(nonnull void (^)(
                                   NSArray<RKZNewsReadHistoryData *> *_Nonnull,
                                   RKZResponseStatus *_Nonnull))block;

Swift

func getNewsReadHistoryList(_ userAccessToken: String, with block: @escaping ([RKZNewsReadHistoryData], RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZNewsReadHistoryData) newsReadHistoryDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -registNewsReadHistory:userAccessToken:readDate:withBlock:

お知らせ既読情報登録

Declaration

Objective-C

- (void)registNewsReadHistory:(nonnull NSString *)newsId
              userAccessToken:(nonnull NSString *)userAccessToken
                     readDate:(nonnull NSDate *)readDate
                    withBlock:
                        (nonnull void (^)(RKZApiStatusCode,
                                          RKZResponseStatus *_Nonnull))block;

Swift

func registNewsReadHistory(_ newsId: String, userAccessToken: String, read readDate: Date, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`newsId`	ニュースID:news_id を指定する(必須)
`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`readDate`	日付(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -registNewsReadHistory:tenantId:userAccessToken:readDate:withBlock:

お知らせ既読情報登録

Declaration

Objective-C

- (void)registNewsReadHistory:(nonnull NSString *)newsId
                     tenantId:(nonnull NSString *)tenantId
              userAccessToken:(nonnull NSString *)userAccessToken
                     readDate:(nonnull NSDate *)readDate
                    withBlock:
                        (nonnull void (^)(RKZApiStatusCode,
                                          RKZResponseStatus *_Nonnull))block;

Swift

func registNewsReadHistory(_ newsId: String, tenantId: String, userAccessToken: String, read readDate: Date, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`newsId`	ニュースID:news_id を指定する(必須)
`tenantId`	テナントID:newsを登録したテナントのIDを指定する(必須)
`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`readDate`	日付(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -readNews:userAccessToken:withBlock:

お知らせ既読情報登録 (New)

Declaration

Objective-C

- (void)readNews:(nonnull NSString *)newsId
    userAccessToken:(nonnull NSString *)userAccessToken
          withBlock:(nonnull void (^)(RKZApiStatusCode,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func readNews(_ newsId: String, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`newsId`	ニュースID (必須)
`user_access_token`	ユーザーアクセストークン (必須)


                    
                    
                    -readNews:tenantId:userAccessToken:withBlock:

お知らせ既読情報登録 (New)

Declaration

Objective-C

- (void)readNews:(nonnull NSString *)newsId
           tenantId:(nonnull NSString *)tenantId
    userAccessToken:(nonnull NSString *)userAccessToken
          withBlock:(nonnull void (^)(RKZApiStatusCode,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func readNews(_ newsId: String, tenantId: String, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`newsId`	ニュースID (必須)
`user_access_token`	ユーザーアクセストークン (必須)

ObjectData


                    
                    
                    -getData:code:withBlock:

データオブジェクト取得（キー指定）

Declaration

Objective-C

- (void)getData:(nonnull NSString *)objectId
           code:(nonnull NSString *)code
      withBlock:(nonnull void (^)(RKZObjectData *_Nullable,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func getData(_ objectId: String, code: String, with block: @escaping (RKZObjectData?, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`code`	キーコード:code (必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZObjectData* objectData, RKZResponseStatus *responseStatus )


                    
                    
                    -getDataList:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得（キー指定なし）

Declaration

Objective-C

- (void)getDataList:(nonnull NSString *)objectId
    searchConditionArray:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
      sortConditionArray:
          (nullable NSArray<RKZSortCondition *> *)sortConditionArray
               withBlock:(nonnull void (^)(NSArray<RKZObjectData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getDataList(_ objectId: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZObjectData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZTableData) rkzTableDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getDataList:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

データオブジェクト取得（キー指定なし）

Declaration

Objective-C

- (void)getDataList:(nonnull NSString *)objectId
    searchConditionArray:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
      sortConditionArray:
          (nullable NSArray<RKZSortCondition *> *)sortConditionArray
      extensionAttribute:
          (nonnull RKZObjectDataExtensionAttribute *)extensionAttribute
               withBlock:(nonnull void (^)(NSArray<RKZObjectData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getDataList(_ objectId: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZObjectDataExtensionAttribute, with block: @escaping ([RKZObjectData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`userAccessToken`	ユーザーアクセストークン:userAccessToken (必須)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZTableData) rkzTableDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateDataList:limit:offset:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得（キー指定なし）

Declaration

Objective-C

- (void)getPaginateDataList:(nonnull NSString *)objectId
                      limit:(nonnull NSNumber *)limit
                     offset:(nonnull NSNumber *)offset
       searchConditionArray:
           (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
         sortConditionArray:
             (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                  withBlock:(nonnull void (^)(
                                RKZPagingData<RKZObjectData *> *_Nonnull,
                                RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateDataList(_ objectId: String, limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZObjectData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateDataList:limit:offset:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

データオブジェクト取得（キー指定なし）

Declaration

Objective-C

- (void)getPaginateDataList:(nonnull NSString *)objectId
                      limit:(nonnull NSNumber *)limit
                     offset:(nonnull NSNumber *)offset
       searchConditionArray:
           (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
         sortConditionArray:
             (nullable NSArray<RKZSortCondition *> *)sortConditionArray
         extensionAttribute:
             (nonnull RKZObjectDataExtensionAttribute *)extensionAttribute
                  withBlock:(nonnull void (^)(
                                RKZPagingData<RKZObjectData *> *_Nonnull,
                                RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateDataList(_ objectId: String, limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZObjectDataExtensionAttribute, with block: @escaping (RKZPagingData<RKZObjectData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`userAccessToken`	ユーザーアクセストークン:userAccessToken (必須)
`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )


                    
                    
                    -addData:withBlock:

データオブジェクト登録

Declaration

Objective-C

- (void)addData:(nonnull RKZObjectData *)objectData
      withBlock:(nonnull void (^)(RKZApiStatusCode,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func add(_ objectData: RKZObjectData, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`objectData`	オブジェクトデータ:object_id キーコード:code 名称:name が必須項目です
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -editData:withBlock:

データオブジェクト編集

Declaration

Objective-C

- (void)editData:(nonnull RKZObjectData *)objectData
       withBlock:(nonnull void (^)(RKZApiStatusCode,
                                   RKZResponseStatus *_Nonnull))block;

Swift

func edit(_ objectData: RKZObjectData, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`objectData`	オブジェクトデータ:object_id キーコード:code が必須項目です
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -deleteData:code:withBlock:

Deprecated

このメソッドは-deleteData:searchConditions:withBlock:に置き換えられました。

オブジェクトデータ使用不可設定

Declaration

Objective-C

- (void)deleteData:(nonnull NSString *)objectId
              code:(nonnull NSString *)code
         withBlock:(nonnull void (^)(RKZApiStatusCode,
                                     RKZResponseStatus *_Nonnull))block;

Swift

func deleteData(_ objectId: String, code: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`code`	キーコード:code (必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -deleteData:searchConditions:withBlock:

オブジェクトデータ削除

Declaration

Objective-C

- (void)deleteData:(nonnull NSString *)objectId
    searchConditions:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
           withBlock:(nonnull void (^)(NSNumber *_Nonnull,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func deleteData(_ objectId: String, searchConditions searchConditionArray: [RKZSearchCondition]?, with block: @escaping (NSNumber, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -deleteAllData:withBlock:

オブジェクトデータ全件削除

Declaration

Objective-C

- (void)deleteAllData:(nonnull NSString *)objectId
            withBlock:(nonnull void (^)(NSNumber *_Nonnull,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func deleteAllData(_ objectId: String, with block: @escaping (NSNumber, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -getDataWithRelationObjects:code:withBlock:

データオブジェクト取得外部結合（キー指定）

Declaration

Objective-C

- (void)getDataWithRelationObjects:(nonnull NSString *)objectId
                              code:(nonnull NSString *)code
                         withBlock:(nonnull void (^)(
                                       RKZObjectData *_Nullable,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func getDataWithRelationObjects(_ objectId: String, code: String, with block: @escaping (RKZObjectData?, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`code`	キーコード:code (必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZObjectData* objectData, RKZResponseStatus *responseStatus )


                    
                    
                    -getDataWithRelationObjects:code:treeCount:withBlock:

データオブジェクト取得外部結合（キー指定）

Declaration

Objective-C

- (void)getDataWithRelationObjects:(nonnull NSString *)objectId
                              code:(nonnull NSString *)code
                         treeCount:(nullable NSNumber *)treeCount
                         withBlock:(nonnull void (^)(
                                       RKZObjectData *_Nullable,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func getDataWithRelationObjects(_ objectId: String, code: String, treeCount: NSNumber?, with block: @escaping (RKZObjectData?, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`code`	キーコード:code (必須)
`treeCount`	取得階層数(任意) 指定した階層数を取得。
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZObjectData* objectData, RKZResponseStatus *responseStatus )


                    
                    
                    -getDataListWithRelationObjects:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得外部結合（キー指定なし）

Declaration

Objective-C

- (void)
    getDataListWithRelationObjects:(nonnull NSString *)objectId
              searchConditionArray:
                  (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
                sortConditionArray:
                    (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                         withBlock:(nonnull void (^)(
                                       NSArray<RKZObjectData *> *_Nonnull,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func getDataList(withRelationObjects objectId: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZObjectData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZTableData) rkzTableDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getDataListWithRelationObjects:treeCount:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得外部結合（キー指定なし）

Declaration

Objective-C

- (void)
    getDataListWithRelationObjects:(nonnull NSString *)objectId
                         treeCount:(nullable NSNumber *)treeCount
              searchConditionArray:
                  (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
                sortConditionArray:
                    (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                         withBlock:(nonnull void (^)(
                                       NSArray<RKZObjectData *> *_Nonnull,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func getDataList(withRelationObjects objectId: String, treeCount: NSNumber?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZObjectData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`treeCount`	取得階層数(任意) 指定した階層数を取得。
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZTableData) rkzTableDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateDataListWithRelationObjects:limit:offset:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得外部結合（キー指定なし）

Declaration

Objective-C

- (void)getPaginateDataListWithRelationObjects:(nonnull NSString *)objectId
                                         limit:(nonnull NSNumber *)limit
                                        offset:(nonnull NSNumber *)offset
                          searchConditionArray:
                              (nullable NSArray<RKZSearchCondition *> *)
                                  searchConditionArray
                            sortConditionArray:
                                (nullable NSArray<RKZSortCondition *> *)
                                    sortConditionArray
                                     withBlock:
                                         (nonnull void (^)(
                                             RKZPagingData<RKZObjectData *>
                                                 *_Nonnull,
                                             RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateDataList(withRelationObjects objectId: String, limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZObjectData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateDataListWithRelationObjects:limit:offset:treeCount:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得外部結合（キー指定なし）

Declaration

Objective-C

- (void)getPaginateDataListWithRelationObjects:(nonnull NSString *)objectId
                                         limit:(nonnull NSNumber *)limit
                                        offset:(nonnull NSNumber *)offset
                                     treeCount:(nullable NSNumber *)treeCount
                          searchConditionArray:
                              (nullable NSArray<RKZSearchCondition *> *)
                                  searchConditionArray
                            sortConditionArray:
                                (nullable NSArray<RKZSortCondition *> *)
                                    sortConditionArray
                                     withBlock:
                                         (nonnull void (^)(
                                             RKZPagingData<RKZObjectData *>
                                                 *_Nonnull,
                                             RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateDataList(withRelationObjects objectId: String, limit: NSNumber, offset: NSNumber, treeCount: NSNumber?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZObjectData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`treeCount`	取得階層数(任意) 指定した階層数を取得。
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZPagingData pagingData, RKZResponseStatus responseStatus )


                    
                    
                    -getDataWithLocation:code:location:withBlock:

データオブジェクト取得（キー指定）

Declaration

Objective-C

- (void)getDataWithLocation:(nonnull NSString *)objectId
                       code:(nonnull NSString *)code
                   location:(nullable RKZLocation *)location
                  withBlock:
                      (nonnull void (^)(RKZObjectData *_Nullable,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getDataWithLocation(_ objectId: String, code: String, location: RKZLocation?, with block: @escaping (RKZObjectData?, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`code`	キーコード:code (必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZObjectData* objectData, RKZResponseStatus *responseStatus )


                    
                    
                    -getDataWithLocation:code:location:spotFieldName:withBlock:

データオブジェクト取得（キー指定）

Declaration

Objective-C

- (void)getDataWithLocation:(nonnull NSString *)objectId
                       code:(nonnull NSString *)code
                   location:(nullable RKZLocation *)location
              spotFieldName:(nullable NSString *)spotFieldName
                  withBlock:
                      (nonnull void (^)(RKZObjectData *_Nullable,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getDataWithLocation(_ objectId: String, code: String, location: RKZLocation?, spotFieldName: String?, with block: @escaping (RKZObjectData?, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`code`	キーコード:code (必須)
`location`	ロケーション情報
`spotFieldName`	スポットフィールド名称
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZObjectData* objectData, RKZResponseStatus *responseStatus )


                    
                    
                    -getDataListWithLocation:location:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得（キー指定なし）

Declaration

Objective-C

- (void)getDataListWithLocation:(nonnull NSString *)objectId
                       location:(nullable RKZLocation *)location
           searchConditionArray:
               (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
             sortConditionArray:
                 (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                      withBlock:
                          (nonnull void (^)(NSArray<RKZObjectData *> *_Nonnull,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func getDataList(withLocation objectId: String, location: RKZLocation?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZObjectData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`location`	ロケーション情報
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZTableData) rkzTableDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getDataListWithLocation:location:spotFieldName:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得（キー指定なし）

Declaration

Objective-C

- (void)getDataListWithLocation:(nonnull NSString *)objectId
                       location:(nullable RKZLocation *)location
                  spotFieldName:(nullable NSString *)spotFieldName
           searchConditionArray:
               (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
             sortConditionArray:
                 (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                      withBlock:
                          (nonnull void (^)(NSArray<RKZObjectData *> *_Nonnull,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func getDataList(withLocation objectId: String, location: RKZLocation?, spotFieldName: String?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZObjectData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`location`	ロケーション情報
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZTableData) rkzTableDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateDataListWithLocation:limit:offset:location:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得（キー指定なし）

Declaration

Objective-C

- (void)getPaginateDataListWithLocation:(nonnull NSString *)objectId
                                  limit:(nonnull NSNumber *)limit
                                 offset:(nonnull NSNumber *)offset
                               location:(nullable RKZLocation *)location
                   searchConditionArray:
                       (nullable NSArray<RKZSearchCondition *> *)
                           searchConditionArray
                     sortConditionArray:(nullable NSArray<RKZSortCondition *> *)
                                            sortConditionArray
                              withBlock:
                                  (nonnull void (^)(
                                      RKZPagingData<RKZObjectData *> *_Nonnull,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateDataList(withLocation objectId: String, limit: NSNumber, offset: NSNumber, location: RKZLocation?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZObjectData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`location`	ロケーション情報
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZTableData) rkzTableDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getPaginateDataListWithLocation:limit:offset:location:spotFieldName:searchConditionArray:sortConditionArray:withBlock:

データオブジェクト取得（キー指定なし）

Declaration

Objective-C

- (void)getPaginateDataListWithLocation:(nonnull NSString *)objectId
                                  limit:(nonnull NSNumber *)limit
                                 offset:(nonnull NSNumber *)offset
                               location:(nullable RKZLocation *)location
                          spotFieldName:(nullable NSString *)spotFieldName
                   searchConditionArray:
                       (nullable NSArray<RKZSearchCondition *> *)
                           searchConditionArray
                     sortConditionArray:(nullable NSArray<RKZSortCondition *> *)
                                            sortConditionArray
                              withBlock:
                                  (nonnull void (^)(
                                      RKZPagingData<RKZObjectData *> *_Nonnull,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateDataList(withLocation objectId: String, limit: NSNumber, offset: NSNumber, location: RKZLocation?, spotFieldName: String?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZObjectData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID:object_id (必須)
`limit`	取得件数
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定
`location`	ロケーション情報
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZTableData) rkzTableDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getFieldDataList:withBlock:

オブジェクトのフィールド情報の表示設定されたフィールドのみ取得する

Declaration

Objective-C

- (void)getFieldDataList:(nonnull NSString *)objectId
               withBlock:(nonnull void (^)(NSArray<RKZFieldData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getFieldDataList(_ objectId: String, with block: @escaping ([RKZFieldData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID (必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray rkzFieldArray, RKZResponseStatus responseStatus )


                    
                    
                    -getFieldDataList:visibleFieldOnly:withBlock:

オブジェクトのフィールド情報取得 visibleOnlyを指定することで、表示、非表示の項目の取得が切り替えできる。

Declaration

Objective-C

- (void)getFieldDataList:(nonnull NSString *)objectId
        visibleFieldOnly:(BOOL)visibleFieldOnly
               withBlock:(nonnull void (^)(NSArray<RKZFieldData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getFieldDataList(_ objectId: String, visibleFieldOnly: Bool, with block: @escaping ([RKZFieldData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID (必須)
`visibleFieldOnly`	表示のみ取得フラグ (true:表示設定のみ, false:非表示も含める)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray rkzFieldArray, RKZResponseStatus responseStatus )


                    
                    
                    -getDataFromQRCode:withBlock:

データオブジェクト取得（QRコード指定）

Declaration

Objective-C

- (void)getDataFromQRCode:(nonnull NSString *)qrCode
                withBlock:(nonnull void (^)(RKZObjectData *_Nullable,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func getDataFromQRCode(_ qrCode: String, with block: @escaping (RKZObjectData?, RKZResponseStatus) -> Void)

Parameters

`qrCode`	QRコード:qr_code (必須)
`code`	キーコード:code (必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZObjectData* objectData, RKZResponseStatus *responseStatus )

ApplicationConfig


                    
                    
                    -getApplicationSettingDataWithBlock:

アプリケーション設定情報取得

Declaration

Objective-C

- (void)getApplicationSettingDataWithBlock:
    (nonnull void (^)(RKZApplicationConfigData *_Nullable,
                      RKZResponseStatus *_Nonnull))block;

Swift

func applicationSettingData() async -> (RKZApplicationConfigData?, RKZResponseStatus)

Parameters


                                block

通信後にblockが実行される。 blockは次の引数のシグネチャを持つ
( RKZApplicationConfigData *applicationConfigData, RKZResponseStatus *responseStatus )

GetSystemDate


                    
                    
                    -getSystemDateWithBlock:

楽座システム日付取得

Declaration

Objective-C

- (void)getSystemDateWithBlock:
    (nonnull void (^)(NSDate *_Nullable, RKZResponseStatus *_Nonnull))block;

Swift

func systemDate() async -> (Date?, RKZResponseStatus)

Parameters


                                block

通信後にblockが実行される。 blockは次の引数のシグネチャを持つ
( NSDate *rakuzaSystemDate, RKZResponseStatus *responseStatus )


                    
                    
                    -getSystemDateStrWithBlock:

楽座システム日付取得

Declaration

Objective-C

- (void)getSystemDateStrWithBlock:
    (nonnull void (^)(NSString *_Nullable, RKZResponseStatus *_Nonnull))block;

Swift

func systemDateStr() async -> (String?, RKZResponseStatus)

Parameters


                                block

通信後にblockが実行される。 blockは次の引数のシグネチャを持つ
( NSString *rakuzaSystemDateStr, RKZResponseStatus *responseStatus )

-getSystemDate
楽座システム日付取得
Declaration
Objective-C

- (nullable NSDate *)getSystemDate;
Swift

func getSystemDate() -> Date?
Return Value

楽座システム日付通信に失敗するとnilを返却する。
-getSystemDateStr
楽座システム日付取得
Declaration
Objective-C

- (nullable NSString *)getSystemDateStr;
Swift

func getSystemDateStr() -> String?
Return Value

楽座システム日付通信に失敗するとnilを返却する。

Push


                    
                    
                    -registPushDeviceToken:deviceToken:withBlock:

プッシュトークン情報登録

Declaration

Objective-C

- (void)registPushDeviceToken:(nonnull NSString *)userAccessToken
                  deviceToken:(nonnull NSString *)deviceToken
                    withBlock:
                        (nonnull void (^)(RKZApiStatusCode,
                                          RKZResponseStatus *_Nonnull))block;

Swift

func registPushDeviceToken(_ userAccessToken: String, deviceToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`deviceToken`	Push通知デバイストークンを指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ (RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus)


                    
                    
                    -clearPushDeviceToken:withBlock:

プッシュトークン情報削除

Declaration

Objective-C

- (void)clearPushDeviceToken:(nonnull NSString *)userAccessToken
                   withBlock:
                       (nonnull void (^)(RKZApiStatusCode,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func clearPushDeviceToken(_ userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン:user_access_token を指定する(必須)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ (RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus)


                    
                    
                    -openPush:pushNo:withBlock:

プッシュ通知を開封済みにします。

Declaration

Objective-C

- (void)openPush:(nonnull NSString *)userAccessToken
          pushNo:(nonnull NSNumber *)pushNo
       withBlock:(nonnull void (^)(RKZApiStatusCode,
                                   RKZResponseStatus *_Nonnull))block;

Swift

func openPush(_ userAccessToken: String, pushNo: NSNumber, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン(必須)
`pushNo`	プッシュ番号(必須)
`block`	通信後にblockが実行される

StampRally


                    
                    
                    -getStampRallyList:sortConditionArray:withBlock:

スタンプラリー一覧取得

スタンプラリー情報を取得します。このメソッドでは開催期間に当てはまるスタンプラリー情報のみを取得します。 searchConditionArrayに開催日時の条件を追加して検索できます。 (開催日時の検索条件は無効になります。)

Declaration

Objective-C

- (void)getStampRallyList:
            (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
       sortConditionArray:
           (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                withBlock:
                    (nonnull void (^)(NSArray<RKZStampRallyData *> *_Nonnull,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func getStampRallyList(_ searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZStampRallyData], RKZResponseStatus) -> Void)

Parameters

`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZStampRallyData) stampRallyDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getAllStampRallyList:sortConditionArray:withBlock:

スタンプラリー一覧取得 (全件取得)

スタンプラリー情報を取得します。このメソッドでは開催日時を無視して開催が終了している or 未来日に開催される情報もすべて取得します。 searchConditionArrayに開催日時の条件を追加して検索できます。

Declaration

Objective-C

- (void)getAllStampRallyList:
            (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
          sortConditionArray:
              (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                   withBlock:
                       (nonnull void (^)(NSArray<RKZStampRallyData *> *_Nonnull,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getAllStampRallyList(_ searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZStampRallyData], RKZResponseStatus) -> Void)

Parameters

`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZStampRallyData) stampRallyDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getStampRallySpotList:sortConditionArray:withBlock:

スタンプラリースポット一覧取得

開催期間中のスタンプラリーを判断して、開催中のスタンプラリーに該当するスポットの一覧を取得する。

searchConditionArray, sortConditionArrayで指定できる項目は「スタンプラリースポット」の項目が対象で、スタンプラリー、スポットの項目での検索・並び替えは行えない。

Declaration

Objective-C

- (void)getStampRallySpotList:
            (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
           sortConditionArray:
               (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                    withBlock:(nonnull void (^)(
                                  NSArray<RKZStampRallySpotData *> *_Nonnull,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func getStampRallySpotList(_ searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZStampRallySpotData], RKZResponseStatus) -> Void)

Parameters

`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZStampRallySpotData) stampRallySpotDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getStampRallySpotListByStampRallyId:searchConditionArray:sortConditionArray:withBlock:

スタンプラリースポット一覧取得 (スタンプラリーID指定)

開催期間中のスタンプラリーの判断は行わず、指定されたスタンプラリーIDに該当する情報を取得する。

searchConditionArray, sortConditionArrayで指定できる項目は「スタンプラリースポット」の項目が対象。スタンプラリー、スポットの項目での検索・並び替えは行えない。

Declaration

Objective-C

- (void)
    getStampRallySpotListByStampRallyId:(nonnull NSString *)stampRallyId
                   searchConditionArray:
                       (nullable NSArray<RKZSearchCondition *> *)
                           searchConditionArray
                     sortConditionArray:(nullable NSArray<RKZSortCondition *> *)
                                            sortConditionArray
                              withBlock:(nonnull void (^)(
                                            NSArray<RKZStampRallySpotData *>
                                                *_Nonnull,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func getStampRallySpotList(byStampRallyId stampRallyId: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZStampRallySpotData], RKZResponseStatus) -> Void)

Parameters

`stampRallyId`	スタンプラリーID
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZStampRallySpotData) stampRallySpotDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getStampRallySpotListBySpotId:searchConditionArray:sortConditionArray:withBlock:

スタンプラリーポット一覧取得（スポットID指定）

開催期間中のスタンプラリーを判断して、開催中のスタンプラリーに該当するスポットの一覧を取得する。

Declaration

Objective-C

- (void)getStampRallySpotListBySpotId:(nonnull NSString *)spotId
                 searchConditionArray:(nullable NSArray<RKZSearchCondition *> *)
                                          searchConditionArray
                   sortConditionArray:(nullable NSArray<RKZSortCondition *> *)
                                          sortConditionArray
                            withBlock:
                                (nonnull void (^)(
                                    NSArray<RKZStampRallySpotData *> *_Nonnull,
                                    RKZResponseStatus *_Nonnull))block;

Swift

func getStampRallySpotList(bySpotId spotId: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZStampRallySpotData], RKZResponseStatus) -> Void)

Parameters

`spotId`	スポットID
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZStampRallySpotData) stampRallySpotDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -getStampRallySpotListByBeaconId:searchConditionArray:sortConditionArray:withBlock:

スタンプラリーポット一覧取得（ビーコンID指定）

開催期間中のスタンプラリーを判断して、開催中のスタンプラリーに該当するスポットの一覧を取得する。

Declaration

Objective-C

- (void)
    getStampRallySpotListByBeaconId:(nonnull NSString *)beaconId
               searchConditionArray:(nullable NSArray<RKZSearchCondition *> *)
                                        searchConditionArray
                 sortConditionArray:
                     (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                          withBlock:
                              (nonnull void (^)(
                                  NSArray<RKZStampRallySpotData *> *_Nonnull,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func getStampRallySpotList(byBeaconId beaconId: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZStampRallySpotData], RKZResponseStatus) -> Void)

Parameters

`beaconId`	検知したBeaconId
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZStampRallySpotData) stampRallySpotDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -stampComplete:stampRallyId:withBlock:

スタンプコンプリート設定

開催されているスタンプラリーで、コンプリートした状態に登録する。コンプリートしたかどうかを自動で判定するのではなく、コンプリートした状態として登録する場合、当APIを呼び出す。 (コンプリートしたかどうかの判定は各自実装して判定する)

Declaration

Objective-C

- (void)stampComplete:(nonnull NSString *)userAccessToken
         stampRallyId:(nonnull NSString *)stampRallyId
            withBlock:(nonnull void (^)(RKZApiStatusCode,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func stampComplete(_ userAccessToken: String, stampRallyId: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	ユーザーアクセストークン
`stampRallyId`	スタンプラリーID
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZResponseStatus) statusCode, RKZResponseStatus responseStatus )


                    
                    
                    -addMyStamp:stampRallyId:spotId:withBlock:

取得スタンプ登録

スタンプ取得履歴を登録します。

Declaration

Objective-C

- (void)addMyStamp:(nonnull NSString *)userAccessToken
      stampRallyId:(nonnull NSString *)stampRallyId
            spotId:(nonnull NSString *)spotId
         withBlock:(nonnull void (^)(RKZApiStatusCode,
                                     RKZResponseStatus *_Nonnull))block;

Swift

func addMyStamp(_ userAccessToken: String, stampRallyId: String, spotId: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	登録するユーザーのアクセストークン
`stampRallyId`	スタンプを取得したスタンプラリーのID
`spotId`	スタンプを取得したスポットID
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZResponseStatus) statusCode, RKZResponseStatus responseStatus )


                    
                    
                    -getMyStampHistoryList:searchConditionArray:sortConditionArray:withBlock:

スタンプ取得情報取得

スタンプの取得状況を取得します。

Declaration

Objective-C

- (void)getMyStampHistoryList:(nonnull NSString *)userAccessToken
         searchConditionArray:
             (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
           sortConditionArray:
               (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                    withBlock:(nonnull void (^)(
                                  NSArray<RKZMyStampHistoryData *> *_Nonnull,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func getMyStampHistoryList(_ userAccessToken: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZMyStampHistoryData], RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	登録するユーザーのアクセストークン
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZMyStampHistory) myStampHistoryArray, RKZResponseStatus responseStatus )

Contact


                    
                    
                    -getContactList:searchConditionArray:sortConditionArray:withBlock:

コンタクト履歴一覧取得

Declaration

Objective-C

- (void)getContactList:(nonnull NSString *)userAccessToken
    searchConditionArray:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
      sortConditionArray:
          (nullable NSArray<RKZSortCondition *> *)sortConditionArray
               withBlock:(nonnull void (^)(NSArray<RKZContactData *> *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func getContactList(_ userAccessToken: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZContactData], RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	取得するユーザーのアクセストークン
`searchConditionArray`	NSArray(RKZSearchCondition) 取得する情報の検索条件を指定する(任意)
`sortConditionArray`	NSArray(RKZSortCondition) 取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( NSArray(RKZContactData) contactDataArray, RKZResponseStatus responseStatus )


                    
                    
                    -addContact:contactData:withBlock:

コンタクトの登録

Declaration

Objective-C

- (void)addContact:(nonnull NSString *)userAccessToken
       contactData:(nonnull RKZContactData *)contactData
         withBlock:(nonnull void (^)(RKZApiStatusCode,
                                     RKZResponseStatus *_Nonnull))block;

Swift

func addContact(_ userAccessToken: String, contactData: RKZContactData, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userAccessToken`	登録するユーザーのアクセストークン
`contactData`	登録するコンタクトデータ
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )

Favorite


                    
                    
                    -addFavoriteToObjectData:userAccessToken:withBlock:

Deprecated

このメソッドは-addObjectDataToFavorite:userAccessToken:withBlock:に置き換えられました。

オブジェクトデータをお気に入りに登録

Declaration

Objective-C

- (void)addFavoriteToObjectData:(nonnull RKZObjectData *)objectData
                userAccessToken:(nonnull NSString *)userAccessToken
                      withBlock:
                          (nonnull void (^)(RKZApiStatusCode,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func addFavorite(to objectData: RKZObjectData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`objectData`	オブジェクトデータ
`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -addObjectDataToFavorite:userAccessToken:withBlock:

オブジェクトデータをお気に入りに登録

Declaration

Objective-C

- (void)addObjectDataToFavorite:(nonnull RKZObjectData *)objectData
                userAccessToken:(nonnull NSString *)userAccessToken
                      withBlock:
                          (nonnull void (^)(RKZApiStatusCode,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func addObjectDataToFavorite(_ objectData: RKZObjectData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`objectData`	オブジェクトデータ
`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -deleteFavoriteToObjectData:userAccessToken:withBlock:

Deprecated

このメソッドは-deleteObjectDataFromFavorite:userAccessToken:withBlock:に置き換えられました。

オブジェクトデータをお気に入りから削除

Declaration

Objective-C

- (void)deleteFavoriteToObjectData:(nonnull RKZObjectData *)objectData
                   userAccessToken:(nonnull NSString *)userAccessToken
                         withBlock:(nonnull void (^)(
                                       RKZApiStatusCode,
                                       RKZResponseStatus *_Nonnull))block;

Swift

func deleteFavorite(to objectData: RKZObjectData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`objectData`	オブジェクトデータ
`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -deleteObjectDataFromFavorite:userAccessToken:withBlock:

オブジェクトデータをお気に入りから削除

Declaration

Objective-C

- (void)deleteObjectDataFromFavorite:(nonnull RKZObjectData *)objectData
                     userAccessToken:(nonnull NSString *)userAccessToken
                           withBlock:(nonnull void (^)(
                                         RKZApiStatusCode,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func deleteObjectDataFromFavorite(_ objectData: RKZObjectData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`objectData`	オブジェクトデータ
`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -addFavoriteToNews:userAccessToken:withBlock:

Deprecated

このメソッドは-addNewsToFavorite:userAccessToken:withBlock:に置き換えられました。

お知らせをお気に入りに登録

Declaration

Objective-C

- (void)addFavoriteToNews:(nonnull RKZNewsData *)newsData
          userAccessToken:(nonnull NSString *)userAccessToken
                withBlock:(nonnull void (^)(RKZApiStatusCode,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func addFavorite(toNews newsData: RKZNewsData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`newsData`	お知らせデータ
`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -addNewsToFavorite:userAccessToken:withBlock:

お知らせをお気に入りに登録

Declaration

Objective-C

- (void)addNewsToFavorite:(nonnull RKZNewsData *)newsData
          userAccessToken:(nonnull NSString *)userAccessToken
                withBlock:(nonnull void (^)(RKZApiStatusCode,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func addNewsToFavorite(_ newsData: RKZNewsData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`newsData`	お知らせデータ
`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -deleteFavoriteToNews:userAccessToken:withBlock:

Deprecated

このメソッドは-deleteNewsFromFavorite:userAccessToken:withBlock:に置き換えられました。

お知らせをお気に入りから削除

Declaration

Objective-C

- (void)deleteFavoriteToNews:(nonnull RKZNewsData *)newsData
             userAccessToken:(nonnull NSString *)userAccessToken
                   withBlock:
                       (nonnull void (^)(RKZApiStatusCode,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func deleteFavorite(toNews newsData: RKZNewsData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`newsData`	お知らせデータ
`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -deleteNewsFromFavorite:userAccessToken:withBlock:

お知らせをお気に入りから削除

Declaration

Objective-C

- (void)deleteNewsFromFavorite:(nonnull RKZNewsData *)newsData
               userAccessToken:(nonnull NSString *)userAccessToken
                     withBlock:
                         (nonnull void (^)(RKZApiStatusCode,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func deleteNewsFromFavorite(_ newsData: RKZNewsData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`newsData`	お知らせデータ
`userAccessToken`	ユーザーアクセストークン
`block`	通信後にblockが実行される。 blockは次の引数のシグネチャを持つ ( RKZApiStatusCode statusCode, RKZResponseStatus *responseStatus )


                    
                    
                    -addUserDetailToFavorite:userAccessToken:withBlock:

ユーザー詳細をお気に入りに追加

Declaration

Objective-C

- (void)addUserDetailToFavorite:(nonnull RKZUserDetailData *)userDetail
                userAccessToken:(nonnull NSString *)userAccessToken
                      withBlock:
                          (nonnull void (^)(RKZApiStatusCode,
                                            RKZResponseStatus *_Nonnull))block;

Swift

func addUserDetailToFavorite(_ userDetail: RKZUserDetailData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userDetail`	追加するユーザー詳細(モデル内のobjectIdとidは必須項目)
`userAccessToken`	ユーザーアクセストークン(必須)
`block`	通信後にblockが実行される


                    
                    
                    -deleteUserDetailFromFavorite:userAccessToken:withBlock:

ユーザー詳細をお気に入りから削除

Declaration

Objective-C

- (void)deleteUserDetailFromFavorite:(nonnull RKZUserDetailData *)userDetail
                     userAccessToken:(nonnull NSString *)userAccessToken
                           withBlock:(nonnull void (^)(
                                         RKZApiStatusCode,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func deleteUserDetailFromFavorite(_ userDetail: RKZUserDetailData, userAccessToken: String, with block: @escaping (RKZApiStatusCode, RKZResponseStatus) -> Void)

Parameters

`userDetail`	削除するユーザー詳細(モデル内のobjectIdとidは必須項目)
`userAccessToken`	ユーザーアクセストークン(必須)
`block`	通信後にblockが実行される

UserDetail


                    
                    
                    -getUserDetail:userAccessToken:userDetailId:withBlock:

ユーザー詳細を1件取得

Declaration

Objective-C

- (void)getUserDetail:(nonnull NSString *)objectId
      userAccessToken:(nonnull NSString *)userAccessToken
         userDetailId:(nonnull NSString *)userDetailId
            withBlock:(nonnull void (^)(RKZUserDetailData *_Nullable,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getUserDetail(_ objectId: String, userAccessToken: String, userDetailId: String, with block: @escaping (RKZUserDetailData?, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(必須)
`userDetailId`	ユーザー詳細ID(必須)
`block`	通信後にblockが実行される


                    
                    
                    -getUserDetail:userAccessToken:userDetailId:extensionAttribute:withBlock:

ユーザー詳細を1件取得

Declaration

Objective-C

- (void)getUserDetail:(nonnull NSString *)objectId
       userAccessToken:(nonnull NSString *)userAccessToken
          userDetailId:(nonnull NSString *)userDetailId
    extensionAttribute:
        (nonnull RKZUserDetailExtensionAttribute *)extensionAttribute
             withBlock:(nonnull void (^)(RKZUserDetailData *_Nullable,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func getUserDetail(_ objectId: String, userAccessToken: String, userDetailId: String, extensionAttribute: RKZUserDetailExtensionAttribute, with block: @escaping (RKZUserDetailData?, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(必須)
`userDetailId`	ユーザー詳細ID(必須)
`extensionAttribute`	拡張オブジェクト検索条件値(必須)
`block`	通信後にblockが実行される


                    
                    
                    -getUserDetailList:userAccessToken:searchConditionArray:sortConditionArray:withBlock:

ユーザー詳細を複数件取得

Declaration

Objective-C

- (void)getUserDetailList:(nonnull NSString *)objectId
          userAccessToken:(nonnull NSString *)userAccessToken
     searchConditionArray:
         (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
       sortConditionArray:
           (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                withBlock:
                    (nonnull void (^)(NSArray<RKZUserDetailData *> *_Nonnull,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func getUserDetailList(_ objectId: String, userAccessToken: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZUserDetailData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(必須)
`searchConditionArray`	取得する情報の検索条件を指定する(任意)
`sortConditionArray`	取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される


                    
                    
                    -getUserDetailList:userAccessToken:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

ユーザー詳細を複数件取得

Declaration

Objective-C

- (void)getUserDetailList:(nonnull NSString *)objectId
          userAccessToken:(nonnull NSString *)userAccessToken
     searchConditionArray:
         (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
       sortConditionArray:
           (nullable NSArray<RKZSortCondition *> *)sortConditionArray
       extensionAttribute:
           (nonnull RKZUserDetailExtensionAttribute *)extensionAttribute
                withBlock:
                    (nonnull void (^)(NSArray<RKZUserDetailData *> *_Nonnull,
                                      RKZResponseStatus *_Nonnull))block;

Swift

func getUserDetailList(_ objectId: String, userAccessToken: String, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZUserDetailExtensionAttribute, with block: @escaping ([RKZUserDetailData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(必須)
`searchConditionArray`	取得する情報の検索条件を指定する(任意)
`sortConditionArray`	取得する情報のソート条件を指定する(任意)
`extensionAttribute`	拡張オブジェクト検索条件値(必須)
`block`	通信後にblockが実行される


                    
                    
                    -getPaginateUserDetailList:userAccessToken:limit:offset:searchConditionArray:sortConditionArray:withBlock:

ユーザー詳細を複数件取得

Declaration

Objective-C

- (void)getPaginateUserDetailList:(nonnull NSString *)objectId
                  userAccessToken:(nonnull NSString *)userAccessToken
                            limit:(nonnull NSNumber *)limit
                           offset:(nonnull NSNumber *)offset
             searchConditionArray:
                 (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
               sortConditionArray:
                   (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                        withBlock:
                            (nonnull void (^)(
                                RKZPagingData<RKZUserDetailData *> *_Nonnull,
                                RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateUserDetailList(_ objectId: String, userAccessToken: String, limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZUserDetailData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(必須)
`limit`	取得件数(必須)
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定(必須)
`searchConditionArray`	取得する情報の検索条件を指定する(任意)
`sortConditionArray`	取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される


                    
                    
                    -getPaginateUserDetailList:userAccessToken:limit:offset:searchConditionArray:sortConditionArray:extensionAttribute:withBlock:

ユーザー詳細を複数件取得

Declaration

Objective-C

- (void)getPaginateUserDetailList:(nonnull NSString *)objectId
                  userAccessToken:(nonnull NSString *)userAccessToken
                            limit:(nonnull NSNumber *)limit
                           offset:(nonnull NSNumber *)offset
             searchConditionArray:
                 (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
               sortConditionArray:
                   (nullable NSArray<RKZSortCondition *> *)sortConditionArray
               extensionAttribute:
                   (nonnull RKZUserDetailExtensionAttribute *)extensionAttribute
                        withBlock:
                            (nonnull void (^)(
                                RKZPagingData<RKZUserDetailData *> *_Nonnull,
                                RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateUserDetailList(_ objectId: String, userAccessToken: String, limit: NSNumber, offset: NSNumber, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, extensionAttribute: RKZUserDetailExtensionAttribute, with block: @escaping (RKZPagingData<RKZUserDetailData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(必須)
`limit`	取得件数(必須)
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定(必須)
`searchConditionArray`	取得する情報の検索条件を指定する(任意)
`sortConditionArray`	取得する情報のソート条件を指定する(任意)
`extensionAttribute`	拡張オブジェクト検索条件値(必須)
`block`	通信後にblockが実行される


                    
                    
                    -getSharedUserDetail:userAccessToken:userDetailId:visibility:withBlock:

公開されているユーザー詳細を1件取得

Declaration

Objective-C

- (void)getSharedUserDetail:(nonnull NSString *)objectId
            userAccessToken:(nullable NSString *)userAccessToken
               userDetailId:(nonnull NSString *)userDetailId
                 visibility:(nullable NSArray<NSString *> *)visibility
                  withBlock:
                      (nonnull void (^)(RKZUserDetailData *_Nullable,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func getSharedUserDetail(_ objectId: String, userAccessToken: String?, userDetailId: String, visibility: [String]?, with block: @escaping (RKZUserDetailData?, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(任意)
`userDetailId`	ユーザー詳細ID(必須)
`visibility`	取得対象の公開範囲
`block`	通信後にblockが実行される


                    
                    
                    -getSharedUserDetailList:userAccessToken:visibility:searchConditionArray:sortConditionArray:withBlock:

公開されているユーザー詳細を複数件取得

Declaration

Objective-C

- (void)getSharedUserDetailList:(nonnull NSString *)objectId
                userAccessToken:(nullable NSString *)userAccessToken
                     visibility:(nullable NSArray<NSString *> *)visibility
           searchConditionArray:
               (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
             sortConditionArray:
                 (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                      withBlock:(nonnull void (^)(
                                    NSArray<RKZUserDetailData *> *_Nonnull,
                                    RKZResponseStatus *_Nonnull))block;

Swift

func getSharedUserDetailList(_ objectId: String, userAccessToken: String?, visibility: [String]?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping ([RKZUserDetailData], RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(任意)
`visibility`	取得対象の公開範囲
`searchConditionArray`	取得する情報の検索条件を指定する(任意)
`sortConditionArray`	取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される


                    
                    
                    -getPaginateSharedUserDetailList:userAccessToken:limit:offset:visibility:searchConditionArray:sortConditionArray:withBlock:

公開されているユーザー詳細を複数件取得

Declaration

Objective-C

- (void)
    getPaginateSharedUserDetailList:(nonnull NSString *)objectId
                    userAccessToken:(nullable NSString *)userAccessToken
                              limit:(nonnull NSNumber *)limit
                             offset:(nonnull NSNumber *)offset
                         visibility:(nullable NSArray<NSString *> *)visibility
               searchConditionArray:(nullable NSArray<RKZSearchCondition *> *)
                                        searchConditionArray
                 sortConditionArray:
                     (nullable NSArray<RKZSortCondition *> *)sortConditionArray
                          withBlock:
                              (nonnull void (^)(
                                  RKZPagingData<RKZUserDetailData *> *_Nonnull,
                                  RKZResponseStatus *_Nonnull))block;

Swift

func getPaginateSharedUserDetailList(_ objectId: String, userAccessToken: String?, limit: NSNumber, offset: NSNumber, visibility: [String]?, searchConditionArray: [RKZSearchCondition]?, sortConditionArray: [RKZSortCondition]?, with block: @escaping (RKZPagingData<RKZUserDetailData>, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(任意)
`limit`	取得件数(必須)
`offset`	取得開始位置 0〜の開始位置(レコード位置)を指定(必須)
`visibility`	取得対象の公開範囲
`searchConditionArray`	取得する情報の検索条件を指定する(任意)
`sortConditionArray`	取得する情報のソート条件を指定する(任意)
`block`	通信後にblockが実行される


                    
                    
                    -addUserDetail:userAccessToken:withBlock:

ユーザー詳細を1件追加

Declaration

Objective-C

- (void)addUserDetail:(nonnull RKZUserDetailData *)userDetail
      userAccessToken:(nonnull NSString *)userAccessToken
            withBlock:(nonnull void (^)(RKZUserDetailData *_Nullable,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func addUserDetail(_ userDetail: RKZUserDetailData, userAccessToken: String, with block: @escaping (RKZUserDetailData?, RKZResponseStatus) -> Void)

Parameters

`userDetail`	追加するユーザー詳細(モデル内のobjectIdは必須項目)
`userAccessToken`	ユーザーアクセストークン(必須)
`block`	通信後にblockが実行される


                    
                    
                    -editUserDetail:userAccessToken:withBlock:

ユーザー詳細を1件編集

Declaration

Objective-C

- (void)editUserDetail:(nonnull RKZUserDetailData *)userDetail
       userAccessToken:(nonnull NSString *)userAccessToken
             withBlock:(nonnull void (^)(RKZUserDetailData *_Nullable,
                                         RKZResponseStatus *_Nonnull))block;

Swift

func editUserDetail(_ userDetail: RKZUserDetailData, userAccessToken: String, with block: @escaping (RKZUserDetailData?, RKZResponseStatus) -> Void)

Parameters

`userDetail`	編集するユーザー詳細(モデル内のobjectIdとcodeは必須項目)
`userAccessToken`	ユーザーアクセストークン(必須)
`block`	通信後にblockが実行される


                    
                    
                    -deleteUserDetail:userAccessToken:searchConditionArray:withBlock:

指定した条件のユーザー詳細を削除

Declaration

Objective-C

- (void)deleteUserDetail:(nonnull NSString *)objectId
         userAccessToken:(nonnull NSString *)userAccessToken
    searchConditionArray:
        (nullable NSArray<RKZSearchCondition *> *)searchConditionArray
               withBlock:(nonnull void (^)(NSNumber *_Nonnull,
                                           RKZResponseStatus *_Nonnull))block;

Swift

func deleteUserDetail(_ objectId: String, userAccessToken: String, searchConditionArray: [RKZSearchCondition]?, with block: @escaping (NSNumber, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(必須)
`searchConditionArray`	削除する情報の検索条件を指定する(任意)
`block`	通信後にblockが実行される


                    
                    
                    -deleteAllUserDetail:userAccessToken:withBlock:

すべてのユーザー詳細を削除

Declaration

Objective-C

- (void)deleteAllUserDetail:(nonnull NSString *)objectId
            userAccessToken:(nonnull NSString *)userAccessToken
                  withBlock:
                      (nonnull void (^)(NSNumber *_Nonnull,
                                        RKZResponseStatus *_Nonnull))block;

Swift

func deleteAllUserDetail(_ objectId: String, userAccessToken: String, with block: @escaping (NSNumber, RKZResponseStatus) -> Void)

Parameters

`objectId`	オブジェクトID(必須)
`userAccessToken`	ユーザーアクセストークン(必須)
`block`	通信後にblockが実行される