AWSLocationSearchPlaceIndexForPositionRequest

Objective-C

@interface AWSLocationSearchPlaceIndexForPositionRequest

Swift

class AWSLocationSearchPlaceIndexForPositionRequest

  • The name of the place index resource you want to use for the search.

    Declaration

    Objective-C

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

    Swift

    var indexName: String? { get set }
  • key

    The optional API key to authorize the request.

    Declaration

    Objective-C

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

    Swift

    var key: String? { get set }

  • The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

    For an example, we’ll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

    If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

    Declaration

    Objective-C

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

    Swift

    var language: String? { get set }

  • An optional parameter. The maximum number of results returned per request.

    Default value: 50

    Declaration

    Objective-C

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

    Swift

    var maxResults: NSNumber? { get set }

  • Specifies the longitude and latitude of the position to query.

    This parameter must contain 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 a position with longitude -123.1174 and latitude 49.2847.

    Declaration

    Objective-C

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

    Swift

    var position: [NSNumber]? { get set }