RMLocation

public struct RMLocation

Location struct contains all functions to request location(s) information(s).

  • Undocumented

    Declaration

    Swift

    public init(client: RMClient)

  • Request loaction by id.

    • id: ID of the location.

    Declaration

    Swift

    public func getLocationByID(id: Int) -> Future<RMLocationModel, Error>

    Return Value

    Location model struct.

  • Request loaction by URL.

    • url: URL of the location.

    Declaration

    Swift

    public func getLocationByURL(url: String) -> Future<RMLocationModel, Error>

    Return Value

    Location model struct.

  • Request multiple locations by IDs.

    • ids: Location ids.

    Declaration

    Swift

    public func getLocationsByID(ids: [Int]) -> Future<[RMLocationModel], Error>

    Return Value

    Array of location model struct.

  • Request loactions by page number.

    • page: Number of result page.

    Declaration

    Swift

    public func getLocationsByPageNumber(pageNumber: Int) -> Future<[RMLocationModel], Error>

    Return Value

    Array of Location model struct.

  • Request all locations.

    Declaration

    Swift

    public func getAllLocations() -> Future<[RMLocationModel], Error>

    Return Value

    Array of Location model struct.

  • Request locations with given filter.

    • filter: LocationFilter struct (provides requestURL with query options).

    Declaration

    Swift

    public func getLocationsByFilter(filter: RMLocationFilter) -> Future<[RMLocationModel], Error>

    Return Value

    Array of Location model struct.