Warning

This feature is available in the Full MapKit SDK version

YMKSuggestOptions

class YMKSuggestOptions : NSObject

Struct to fine-tune suggest request.

Summary

Class methods

 init(suggestTypes: YMKSuggestType,
      userPosition: YMKPoint?,
      suggestWords: Bool,
      strictBounds: Bool)

Instance methods

init()

Properties

var suggestTypesYMKSuggestType { get set }
The suggest type can be one of YMKSuggestType values or their bitwise 'OR' combination

var userPositionYMKPoint? { get set }
The server uses the user position to calculate the distance from the user to suggest results

var suggestWords: Bool { get set }
Enable word-by-word suggestion items

var strictBounds: Bool { get set }
Strictly limit the output and keep only objects that fall within the window

Class methods

init(suggestTypes:userPosition:suggestWords:strictBounds:)

 init(suggestTypes: YMKSuggestType,
      userPosition: YMKPoint?,
      suggestWords: Bool,
      strictBounds: Bool)


Instance methods

init()

init()


Properties

suggestTypes

var suggestTypes: YMKSuggestType { get set }

The suggest type can be one of YMKSuggestType values or their bitwise 'OR' combination. If suggestType is not initialized, it means to use server-defined types.


userPosition

var userPosition: YMKPoint? { get set }

The server uses the user position to calculate the distance from the user to suggest results.

Optional field, can be nil.


suggestWords

var suggestWords: Bool { get set }

Enable word-by-word suggestion items.


strictBounds

var strictBounds: Bool { get set }

Strictly limit the output and keep only objects that fall within the window. The window is advisory in nature and doesn't impose strict restrictions on search results, helping to select the most relevant hints.