BaseResponse

public class BaseResponse : NSObject, Mappable

A base response for

  • whether the request processed successfully

    Declaration

    Swift

    public var success: Bool

  • the result

    • SUCCESS -the call succeeded and was successfully queued or processed
    • FAIL -the call failed because of some value passed in, or it failed for an unknown reason
    • UNSUPPORTED -the capability will never work without a config changed
    • CANCEL -this means the call was canceled for some reason, but could work if re-submitted
    • ERROR -an unknown error occurred

    Declaration

    Swift

    public var result: ResultCode

  • an optional reason for a non-success state

    Declaration

    Swift

    public var reason: String?

  • an optional detail message for a non-success state

    Declaration

    Swift

    public var message: String?

  • Declaration

    Swift

    public override init()

  • Declaration

    Swift

    public init(success: Bool, result: ResultCode)

  • Declaration

    Swift

    public init(success: Bool, result: ResultCode, reason: String?, message: String?)