PlacebyIDQueryBuilder

public class PlacebyIDQueryBuilder

Place by ID search query builder.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • PlacebyIDQueryBuilder init method.

    Declaration

    Swift

    public init(entityId: String)

    Parameters

    entityId

    A unique POI identifier.

Public

  • Builder method for adding a language to the PlacebyIDQueryBuilder.

    Declaration

    Swift

    public func with(language: String) -> PlacebyIDQueryBuilder

    Return Value

    PlacebyIDQueryBuilder object.

  • Builder method for adding openingHours to the PlacebyIDQueryBuilder.

    Declaration

    Swift

    public func with(openingHours: OpeningHours) -> PlacebyIDQueryBuilder

    Parameters

    openingHours

    List of opening hours for a POI (Point of Interest).

    Return Value

    PlacebyIDQueryBuilder object.

  • Builder method for adding a timeZone to the PlacebyIDQueryBuilder.

    Declaration

    Swift

    public func with(timeZone: String) -> PlacebyIDQueryBuilder

    Parameters

    timeZone

    The mode to return the timeZone object in.

    Return Value

    PlacebyIDQueryBuilder object.

  • Builder method to add mapcodes to the PlacebyIDQueryBuilder. Mapcodes are returned in a comma-separated list. The response can also be filtered to only show selected mapcode types. See Mapcodes in the response. Values: One or more of: Local, International, Alternative

    Declaration

    Swift

    public func with(mapcodes: [String]) -> PlacebyIDQueryBuilder

    Parameters

    mapcodes

    A mapcode represents a specific location to within a few meters.

    Return Value

    PlacebyIDQueryBuilder object.

  • An optional parameter to return related Points Of Interest.

    Declaration

    Swift

    public func with(relatedPois: RelatedPois) -> PlacebyIDQueryBuilder

    Parameters

    relatedPois

    Enum RelatedPois.

    Return Value

    PlacebyIDQueryBuilder object.