RKZResponseStatus

Objective-C

@interface RKZResponseStatus : NSError

Swift

class RKZResponseStatus : NSError

RKZResponseStatusクラスは、楽座からのレスポンスステータスを格納するクラス

Properties

  • ステータスコード RKZApiStatusCode Enumが格納されます

    Declaration

    Objective-C

    @property (nonatomic) RKZApiStatusCode statusCode;

    Swift

    var statusCode: RKZApiStatusCode { get set }

  • メッセージ

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSString *message;

    Swift

    var message: String? { get set }

  • 詳細メッセージ

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSString *detailMessage;

    Swift

    var detailMessage: String? { get set }

  • httpエラー

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSError *httpError;

    Swift

    var httpError: Error? { get set }

  • 成功しているか

    YES:成功/ NO:失敗

    @since BaaSAtRakuzaSDK v1.0

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isSuccess) BOOL success;

    Swift

    var isSuccess: Bool { get }

Initialization

  • 正常終了

    Declaration

    Objective-C

    - (nonnull instancetype)initSuccess;

    Swift

    init(success: ())

  • 楽座エラー

    Declaration

    Objective-C

    - (nonnull instancetype)initWithError:(nonnull RKZApiData *)rakuzaData
                                error:(nonnull NSError *)error;

    Swift

    init(error rakuzaData: RKZApiData, error: Error)

    Parameters

    rakuzaData

    楽座から取得するエラーコード及びエラーメッセージ
    error

    楽座以外から取得するエラー　httpエラー等 楽座から取得されるエラーを返却するために用いられる。

  • コネクションエラー

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConnectionError:(nonnull NSError *)error;

    Swift

    init(connectionError error: Error)

    Parameters

    error

    楽座以外から取得するエラー 楽座から取得されるエラーを返却するために用いられる。

  • コネクションタイムアウト

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConnectionTimeout:(nonnull NSError *)error;

    Swift

    init(connectionTimeout error: Error)

    Parameters

    error

    楽座以外から取得するエラー 楽座から取得されるエラーを返却するために用いられる。

  • 楽座エラー (httpエラーなし)

    Declaration

    Objective-C

    - (nonnull instancetype)initWithError:(nonnull RKZApiData *)rakuzaData;

    Swift

    init(error rakuzaData: RKZApiData)

    Parameters

    rakuzaData

    楽座から取得するエラーコード及びエラーメッセージ 楽座から取得されるエラーを返却するために用いられる。

  • 必須チェックエラー

    必須項目が未入力の時に返却するために用いられる。

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRequiredError:
    (nonnull NSString *)detailErrorMessage;

    Swift

    init(requiredError detailErrorMessage: String)

    Parameters

    detailErrorMessage

    詳細エラーメッセージ

  • 入力チェックエラー 入力チェックエラー時に返却するために用いられる。

    [columnName]は[message]を入力してください。

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInputError:(nonnull NSString *)columnName
                                   message:(nonnull NSString *)message;

    Swift

    init(inputError columnName: String, message: String)

    Parameters

    columnName

    項目名
    message

    メッセージ

  • サービス初期化エラー

    サービスクラスを初期化していない状態で各種APIアクセスメソッドを呼び出したときに返却するために用いられる。

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInitializeError;

    Swift

    init(initializeError: ())

  • サービス初期化エラー

    サービスクラスを初期化していない状態で各種APIアクセスメソッドを呼び出したときに返却するために用いられる。

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInitializeError:
    (nullable NSString *)detailErrorMessage;

    Swift

    init(initializeError detailErrorMessage: String?)

    Parameters

    detailErrorMessage

    詳細エラーメッセージ

  • 楽座システム障害エラー

    Declaration

    Objective-C

    - (nonnull id)initWithSystemFailureError:(nonnull NSError *)error;

    Swift

    init(systemFailureError error: Error)

    Parameters

    error

    楽座以外から取得するエラー 楽座から取得されるエラーを返却するために用いられる。

  • API整合性エラー

    ステータスコードは1001（正常）なのに、理屈的にはエラーの場合に返却するために用いられる。
    例）認証局に存在しないテナント認証コードを渡して認証局APIを呼び出した場合。

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAPIConsistencyError:
    (nonnull NSString *)detailErrorMessage;

    Swift

    init(apiConsistencyError detailErrorMessage: String)

    Parameters

    detailErrorMessage

    詳細エラーメッセージ

  • APIクラスエラー

    型変換に失敗した時に返却するために用いられる。
    例）検索条件クラス:RKZSearchCondition を用いず、他のクラスを設定してAPIを呼び出した場合。

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAPIClassError:
    (nonnull NSString *)detailErrorMessage;

    Swift

    init(apiClassError detailErrorMessage: String)

    Parameters

    detailErrorMessage

    詳細エラーメッセージ

Class Methods

  • RKZApiStatusCode Enumのコード値をNSStringで返却する

    Declaration

    Objective-C

    + (nonnull NSString *)RKZApiStatusCodeToString:(RKZApiStatusCode)statusCode;

    Swift

    class func rkzApiStatusCode(toString statusCode: RKZApiStatusCode) -> String

    Parameters

    statusCode

    RKZApiStatusCode enum

    Return Value

    NSStringに変換したstatusCode