NetworkHelperProtocol

public protocol NetworkHelperProtocol

Protocol defining methods for common, uncompressed network operations.

Implementations are a short-circuit for standard requests only; bodies are never compressed. For gzip or otherwise customized requests, use NetworkClient with a RequestBuilder.


                    
                    
                    get(url:etag:additionalHeaders:completion:)

Just sends a GET request to the NetworkClient

Declaration

Swift

func get(url: URLConvertible,
         etag: String?,
         additionalHeaders: [String: String]?,
         completion: @escaping (NetworkResult) -> Void) -> any Disposable

Parameters

`url`	the `URLConvertible` instance to build the `URL` to send
`etag`	the etag to be added in order to avoid fetching a cached resource
`additionalHeaders`	optional dictionary of additional headers to add to the request
`completion`	the block that is executed when the request is completed with the `NetworkResult`

Return Value

the Disposable to cancel the in flight operation.


                    
                    
                    getJsonAsObject(url:etag:additionalHeaders:completion:)

Default implementation

Sends a GET request to the NetworkClient and tries to convert the result into a Codable model.

Default Implementation

Sends a GET request to the NetworkClient and tries to convert the result into a Codable model. Same as using the get method with nil as the etag parameter.

Declaration

Swift

func getJsonAsObject<T: Codable>(url: URLConvertible,
                                 etag: String?,
                                 additionalHeaders: [String: String]?,
                                 completion: @escaping (ObjectResult<T>) -> Void) -> any Disposable

Parameters

`url`	the `URLConvertible` instance to build the `URL` to send
`etag`	the etag to be added in order to avoid fetching a cached resource
`additionalHeaders`	optional dictionary of additional headers to add to the request
`completion`	the block that is executed when the request is completed with the `CodableResult`

Return Value

the Disposable to cancel the in flight operation.


                    
                    
                    post(url:body:additionalHeaders:completion:)

Sends a POST request to the NetworkClient with an uncompressed JSON body.

The body is never gzipped. For gzip compression, build a RequestBuilder with gzip() and send it through NetworkClient.

Declaration

Swift

func post(url: URLConvertible,
          body: DataObject,
          additionalHeaders: [String: String]?,
          completion: @escaping (NetworkResult) -> Void) -> any Disposable

Parameters

`url`	the `URLConvertible` instance to build the `URL` to send
`body`	the `DataObject` to be sent as uncompressed JSON data
`additionalHeaders`	optional dictionary of additional headers to add to the request
`completion`	the block that is executed when the request is completed with the `NetworkResult`

Return Value

the Disposable to cancel the in flight operation.


                    
                    
                    get(url:additionalHeaders:completion:)

Extension method

Just sends a GET request to the NetworkClient

Declaration

Swift

func get(url: URLConvertible,
         additionalHeaders: [String: String]? = nil,
         completion: @escaping (NetworkResult) -> Void) -> any Disposable

Parameters

`url`	the `URLConvertible` instance to build the `URL` to send
`additionalHeaders`	optional dictionary of additional headers to add to the request
`completion`	the block that is executed when the request is completed with the `NetworkResult`

Return Value

the Disposable to cancel the in flight operation.


                    
                    
                    getJsonAsDataObject(url:etag:additionalHeaders:completion:)

Extension method

Sends a GET request to the NetworkClient and tries to convert the result the returned JSON into a DataObject.

Declaration

Swift

func getJsonAsDataObject(url: URLConvertible,
                         etag: String? = nil,
                         additionalHeaders: [String: String]? = nil,
                         completion: @escaping (ObjectResult<DataObject>) -> Void) -> any Disposable

Parameters

`url`	the `URLConvertible` instance to build the `URL` to send
`etag`	the etag to be added in order to avoid fetching a cached resource
`additionalHeaders`	optional dictionary of additional headers to add to the request
`completion`	the block that is executed when the request is completed with the `ObjectResult`

Return Value

the Disposable to cancel the in flight operation.


                    
                    
                    post(url:body:completion:)

Extension method

Sends a POST request to the NetworkClient with an uncompressed JSON body.

The body is never gzipped. For gzip compression, build a RequestBuilder with gzip() and send it through NetworkClient.

Declaration

Swift

func post(url: URLConvertible,
          body: DataObject,
          completion: @escaping (NetworkResult) -> Void) -> any Disposable

Parameters

`url`	the `URLConvertible` instance to build the `URL` to send
`body`	the `DataObject` to be sent as uncompressed JSON data
`completion`	the block that is executed when the request is completed with the `NetworkResult`

Return Value

the Disposable to cancel the in flight operation.