AWSLocationSearchForSuggestionsResult

Objective-C

@interface AWSLocationSearchForSuggestionsResult

Swift

class AWSLocationSearchForSuggestionsResult

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

Required parameters: [Text]

  • The Amazon Location categories that describe the Place.

    For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

    Declaration

    Objective-C

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

    Swift

    var categories: [String]? { get set }

  • The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.

    The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.

    For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.

    Declaration

    Objective-C

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

    Swift

    var placeId: String? { get set }

  • Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

    Declaration

    Objective-C

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

    Swift

    var supplementalCategories: [String]? { get set }

  • The text of the place suggestion, typically formatted as an address string.

    Declaration

    Objective-C

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

    Swift

    var text: String? { get set }