WRLDTextSearchOptions Class Reference

A set of parameters for an free-text search.

– getQuery

- (NSString *)getQuery
Returns:

The text to search for.

– setQuery:

- (void)setQuery:(NSString *)query

Set the query text.

Argument Description
query

The text to search for.

– getCenter

- (CLLocationCoordinate2D)getCenter
Returns:

The latitude and longitude to search around.

– setCenter:

- (void)setCenter:(CLLocationCoordinate2D)center

Set the center coordinate.

Argument Description
center

The latitude and longitude to search around.

– usesRadius

- (BOOL)usesRadius
Returns:

True if setRadius has been called.

– getRadius

- (double)getRadius
Returns:

The search result boost radius in meters.

– setRadius:

- (void)setRadius:(double)radius
Argument Description
radius

Set the search result boost radius in meters.

– usesNumber

- (BOOL)usesNumber
Returns:

True if setNumber has been called.

– getNumber

- (NSInteger)getNumber
Returns:

The search result limit.

– setNumber:

- (void)setNumber:(NSInteger)number

Sets the maximum number of search results to return.

Argument Description
number

The search result limit.

– usesMinScore

- (BOOL)usesMinScore
Returns:

True if setMinScore has been called.

– getMinScore

- (double)getMinScore
Returns:

The minimum acceptable score for results.

– setMinScore:

- (void)setMinScore:(double)minScore

Sets the minimum score of results. The higher this is set, the fewer results will match.

Argument Description
minScore

The minimum acceptable score for results.

– usesIndoorMapId

- (BOOL)usesIndoorMapId
Returns:

True if setIndoorMapId has been called.

– getIndoorMapId

- (NSString *)getIndoorMapId
Returns:

The indoor map ID to search in.

– setIndoorMapId:

- (void)setIndoorMapId:(NSString *)indoorMapId

Sets the ID of the indoor map to search in. If not specified, search outdoors.

Argument Description
indoorMapId

The indoor map ID to search in.

– usesIndoorMapFloorId

- (BOOL)usesIndoorMapFloorId
Returns:

True if setIndoorMapFloorId has been called.

– getIndoorMapFloorId

- (NSInteger)getIndoorMapFloorId
Returns:

The floor number to search on.

– setIndoorMapFloorId:

- (void)setIndoorMapFloorId:(NSInteger)indoorMapFloorId

Sets the floor number to search on. If searching indoors and not specified, defaults to floor 0.

Argument Description
indoorMapFloorId

The floor number to search on.

– usesFloorDropoff

- (BOOL)usesFloorDropoff
Returns:

True if setFloorDropoff has been called.

– getFloorDropoff

- (NSInteger)getFloorDropoff
Returns:

The number of floors above and below to search on.

– setFloorDropoff:

- (void)setFloorDropoff:(NSInteger)floorDropoff

Sets the floor dropoff. Defaults to 15.

Argument Description
floorDropoff

The number of floors above and below to search on.

v0.0.1271