ParkingAPIClient Class Reference

Initialization


                    
                    
                    init(configuration:pageSize:)

Default initializer

Declaration

Swift

public init(configuration: URLSessionConfiguration = .default, pageSize: UInt = 10)

Parameters

`configuration`	The `URLSessionConfiguration` to use. Default to `URLSession.default`
`pageSize`	The pagination value to use. Default to `10`.

Callback closures APIs


                    
                    
                    getLegacyLocation(completion:)

Retrieve the parkings’ locations with the legacy API

Declaration

Swift

@discardableResult
public func getLegacyLocation(completion: @escaping (Result<LocationResponse, ParkingAPIClientError>) -> Void) -> CancelableRequest

Parameters


                                completion

The result when the request completed

Return Value

A CancelableRequest compatible element


                    
                    
                    getLegacyStatus(completion:)

Retrieve the parkings’ statuses with the legacy API

Declaration

Swift

@discardableResult
public func getLegacyStatus(completion: @escaping (Result<StatusResponse, ParkingAPIClientError>) -> Void) -> CancelableRequest

Parameters


                                completion

The result when the request completed

Return Value

A CancelableRequest compatible element


                    
                    
                    getLocations(completion:)

Retrieve the parkings’ locations with the open data API

Declaration

Swift

@discardableResult
public func getLocations(completion: @escaping (Result<[LocationOpenData], ParkingAPIClientError>) -> Void) -> CancelableRequest

Parameters


                                completion

The result when the request completed

Return Value

A CancelableRequest compatible element


                    
                    
                    getStatus(completion:)

Retrieve the parkings’ status with the open data API

Declaration

Swift

@discardableResult
public func getStatus(completion: @escaping (Result<[StatusOpenData], ParkingAPIClientError>) -> Void) -> CancelableRequest

Parameters


                                completion

The result when the request completed

Return Value

A CancelableRequest compatible element

Combine APIs

getLegacyLocationPublisher()
Retrieve the parkings’ locations with the legacy API
Declaration
Swift

public func getLegacyLocationPublisher() -> AnyPublisher<LocationResponse, ParkingAPIClientError>
Return Value

A AnyPublisher answering one LocationResponse element.
getLegacyStatusPublisher()
Retrieve the parkings’ statuses with the legacy API
Declaration
Swift

public func getLegacyStatusPublisher() -> AnyPublisher<StatusResponse, ParkingAPIClientError>
Return Value

A AnyPublisher answering one StatusResponse element.
getLocationsPublisher()
Retrieve the parkings’ locations using the open data API
Declaration
Swift

public func getLocationsPublisher() -> AnyPublisher<[LocationOpenData], ParkingAPIClientError>
Return Value

A AnyPublisher answering one [LocationOpenData] .
getStatusPublisher()
Retrieve the parkings’ statuses with the opendata API
Declaration
Swift

public func getStatusPublisher() -> AnyPublisher<[StatusOpenData], ParkingAPIClientError>
Return Value

A AnyPublisher answering one [StatusOpenData] element.

Async APIs

fetchLegacyLocation() Asynchronous
Retrieve the parkings’ location with the legacy API
Declaration
Swift

public func fetchLegacyLocation() async throws -> LocationResponse
Return Value

An array of LocationResponse
fetchLegacyStatus() Asynchronous
Retrieve the parkings’ statuses with the legacy API
Declaration
Swift

public func fetchLegacyStatus() async throws -> StatusResponse
Return Value

An array of StatusResponse
fetchLocations() Asynchronous
Retrieve the parkings’ location with the open data API
Declaration
Swift

public func fetchLocations() async throws -> [LocationOpenData]
Return Value

An array of LocationOpenData
fetchStatus() Asynchronous
Retrieve the parkings’ statuses with the open data API
Declaration
Swift

public func fetchStatus() async throws -> [StatusOpenData]
Return Value

An array of StatusResponse