AWSLocationSearchPlaceIndexForTextSummary

Objective-C

@interface AWSLocationSearchPlaceIndexForTextSummary

Swift

class AWSLocationSearchPlaceIndexForTextSummary

A summary of the request sent by using SearchPlaceIndexForText.

Required parameters: [Text, DataSource]

  • Contains the coordinates for the optional bias position specified in the request.

    This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSNumber *> *_Nullable biasPosition;

    Swift

    var biasPosition: [NSNumber]? { get set }

  • The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

    • Esri

    • Grab

    • Here

    For more information about data providers, see Amazon Location Service data providers.

    Declaration

    Objective-C

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

    Swift

    var dataSource: String? { get set }

  • Contains the coordinates for the optional bounding box specified in the request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSNumber *> *_Nullable filterBBox;

    Swift

    var filterBBox: [NSNumber]? { get set }

  • The optional category filter specified in the request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable filterCategories;

    Swift

    var filterCategories: [String]? { get set }

  • Contains the optional country filter specified in the request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable filterCountries;

    Swift

    var filterCountries: [String]? { get set }

  • The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

    Declaration

    Objective-C

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

    Swift

    var language: String? { get set }

  • Contains the optional result count limit specified in the request.

    Declaration

    Objective-C

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

    Swift

    var maxResults: NSNumber? { get set }

  • The bounding box that fully contains all search results.

    If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSNumber *> *_Nullable resultBBox;

    Swift

    var resultBBox: [NSNumber]? { get set }

  • The search text specified in the request.

    Declaration

    Objective-C

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

    Swift

    var text: String? { get set }