AWSLocationSearchForTextResult

Objective-C

@interface AWSLocationSearchForTextResult

Swift

class AWSLocationSearchForTextResult

Contains a search result from a text search query that is run on a place index resource.

Required parameters: [Place]

  • The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

    A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable distance;

    Swift

    var distance: NSNumber? { get set }
  • Details about the search result, such as its address and position.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLocationPlace *_Nullable place;

    Swift

    var place: AWSLocationPlace? { get set }
  • The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

    For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE as a data provider.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable placeId;

    Swift

    var placeId: String? { get set }
  • The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

    Returned only when the partner selected is Esri.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable relevance;

    Swift

    var relevance: NSNumber? { get set }