JcRequestResponse

public class JcRequestResponse<ResponseContent> where ResponseContent : Decodable, ResponseContent : Encodable

Defines a response received back from our API call via JcConnectionRequest and communicated asynchronously via callbacks

  • http status code returned from server

    Declaration

    Swift

    public private(set) var httpStatus: Int { get }

  • Response headers returned from server

    Declaration

    Swift

    public private(set) var httpHeaders: [AnyHashable : Any]? { get }

  • Optional http response message returned from server, generally only provided in case of error

    Declaration

    Swift

    public private(set) var httpMessage: String? { get }

  • Flags .SUCCESS or failure of request.

    Two types of failure are possible;

    SERVER_SIDE_FAILURE

    Error was server side, refer to httpStatus & httpMessage.

    CLIENT_SIDE_FAILURE

    The failure was triggered on our side when trying to translate the response into something useful, refer instead to error

    Notes:

    Connection failures will not be reported here, as they are triggered immediately when making calls

    Declaration

    Swift

    public var status: JCResponseStatus { get }

  • Error triggered when making request, generally triggered in case where call could not processed after succesffully received, i.e. problem translating the response into something useful.

    Declaration

    Swift

    public private(set) var error: Error? { get }

  • Undocumented

    Declaration

    Swift

    public let content: ResponseContent?