Warning

This feature is available in the Full MapKit SDK version

MMKSuggestOptions

@interface MMKSuggestOptions : NSObject

Struct to fine-tune suggest request.

Summary

Class methods

+ (nonnull MMKSuggestOptions *)suggestOptionsWithSuggestTypes:( MMKSuggestType)suggestTypes
                                                 userPosition:(nullable MMKPoint *)userPosition
                                                 suggestWords:( BOOL)suggestWords
                                                 strictBounds:( BOOL)strictBounds;

Instance methods

- (nonnull MMKSuggestOptions *)init;

Properties

@property (nonatomic, assign, unsafe_unretained, readwrite)
    MMKSuggestType suggestTypes;

The suggest type can be one of MMKSuggestType values or their bitwise 'OR' combination

@property (nonatomic, strong, readwrite, nullable) MMKPoint *userPosition;
The server uses the user position to calculate the distance from the user to suggest results

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL suggestWords;
Enable word-by-word suggestion items

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL strictBounds;
Strictly limit the output and keep only objects that fall within the window

Class methods

suggestOptionsWithSuggestTypes:userPosition:suggestWords:strictBounds:

+ (nonnull MMKSuggestOptions *)suggestOptionsWithSuggestTypes:( MMKSuggestType)suggestTypes
                                                 userPosition:(nullable MMKPoint *)userPosition
                                                 suggestWords:( BOOL)suggestWords
                                                 strictBounds:( BOOL)strictBounds;


Instance methods

init

- (nonnull MMKSuggestOptions *)init;


Properties

suggestTypes

@property (nonatomic, assign, unsafe_unretained, readwrite)
    MMKSuggestType suggestTypes;

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


userPosition

@property (nonatomic, strong, readwrite, nullable) MMKPoint *userPosition;

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

Optional field, can be nil.


suggestWords

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL suggestWords;

Enable word-by-word suggestion items.


strictBounds

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL strictBounds;

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.