Configuration

public final class Configuration

extension Configuration: NSCopying

A configuration class that can be used with Environment, Repository, Endpoint and Request. A configuration object follows the following rules:

When a Configuration object is passed to an Environment, each Repository with its Endpoints and requests will inherit this configuration.
When a Configuration object is passed to Repository, all its Endpoints and Requests will inherit this configuration.

Public properties

cachePolicy
The cache policy of the request.
Declaration
Swift

public var cachePolicy: URLRequest.CachePolicy?
timeoutInterval
The timeout interval of the request.
Declaration
Swift

public var timeoutInterval: TimeInterval?
requestBodyType
The request body type of the request. Can be either .xWWWFormURLEncoded or .JSON.
Declaration
Swift

public var requestBodyType: RequestBodyType?
certificatePaths
The certificate file paths used for certificate pining.
Declaration
Swift

public var certificatePaths: [String]? { get set }
verbose
Enables or disables debug mode.
Declaration
Swift

public var verbose: Bool?
headers
Additional headers of the request. They will be merged with the headers specified in EndpointConfiguration.
Declaration
Swift

public var headers: [String : String]?
mockDataBundle
The Bundle object of mock data used when useMockData is true.
Declaration
Swift

public var mockDataBundle: Bundle?
mockDataEnabled
Enables or disables request mocking.
Declaration
Swift

public var mockDataEnabled: Bool?
mockDelay
Specifies a delay when mock data is used.
Declaration
Swift

public var mockDelay: MockDelayRange?
keyDecodingStrategy
Specifies a key decoding strategy. Take a look at: https://developer.apple.com/documentation/foundation/jsondecoder/keydecodingstrategy
Declaration
Swift

public var keyDecodingStrategy: JSONDecoder.KeyDecodingStrategy?
interceptors
Error handlers that will be used as a fallback after request failure.
Declaration
Swift

public var interceptors: [InterceptorProtocol.Type]?


                    
                    
                    requestMiddleware

Request middleware

Declaration

Swift

public var requestMiddleware: [RequestMiddlewareProtocol.Type]?

Initializers


                    
                    
                    init(cachePolicy:timeoutInterval:requestBodyType:certificatePaths:verbose:headers:mockDataBundle:mockDataEnabled:mockDelay:keyDecodingStrategy:interceptors:requestMiddleware:)

Default initializer of Configuration

Declaration

Swift

public init(cachePolicy: URLRequest.CachePolicy? = nil,
            timeoutInterval: TimeInterval? = nil,
            requestBodyType: RequestBodyType? = nil,
            certificatePaths: [String]? = nil,
            verbose: Bool? = nil,
            headers: [String: String]? = nil,
            mockDataBundle: Bundle? = nil,
            mockDataEnabled: Bool? = nil,
            mockDelay: MockDelayRange? = nil,
            keyDecodingStrategy: JSONDecoder.KeyDecodingStrategy? = nil,
            interceptors: [InterceptorProtocol.Type]? = nil,
            requestMiddleware: [RequestMiddlewareProtocol.Type]? = nil)

Parameters

`cachePolicy`	The cache policy of the request.
`timeoutInterval`	The timeout interval of the request.
`requestBodyType`	The request body type of the request. Can be either .xWWWFormURLEncoded or .JSON.
`certificatePaths`	The certificate file paths used for certificate pining.
`verbose`	Enables or disables debug mode.
`headers`	Additional headers of the request. Will be merged with the headers specified in EndpointConfiguration.
`mockDataBundle`	The Bundle object of mock data used when useMockData is true.
`mockDataEnabled`	Enables or disables request mocking.
`mockDelay`	Specifies a delay when mock data is used.
`keyDecodingStrategy`	// Specifies a key decoding strategy. Take a look, at: https://developer.apple.com/documentation/foundation/jsondecoder/keydecodingstrategy
`errorHandlers`	Error handlers that will be used as a fallback after request failure.
`requestMiddleware`	Request middleware. For example see Examples/Communication/Middleware/CryptoMiddleware.swift

copy(with:)
NSCopying implementation, used for cloning Configuration objects.
Declaration
Swift

public func copy(with zone: NSZone? = nil) -> Any