Warning

This feature is available in the Full MapKit SDK version

YMKSuggestOptions

@interface YMKSuggestOptions : NSObject

Struct to fine-tune suggest request.

Summary

Class methods

+ (nonnull YMKSuggestOptions *)suggestOptionsWithSuggestTypes:( YMKSuggestType)suggestTypes
                                                 userPosition:(nullable YMKPoint *)userPosition
                                                 suggestWords:( BOOL)suggestWords;

Instance methods

- (nonnull YMKSuggestOptions *)init;

Properties

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

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

@property (nonatomic, strong, readwrite, nullable) YMKPoint *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

Class methods

suggestOptionsWithSuggestTypes:userPosition:suggestWords:

+ (nonnull YMKSuggestOptions *)suggestOptionsWithSuggestTypes:( YMKSuggestType)suggestTypes
                                                 userPosition:(nullable YMKPoint *)userPosition
                                                 suggestWords:( BOOL)suggestWords;


Instance methods

init

- (nonnull YMKSuggestOptions *)init;


Properties

suggestTypes

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

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

@property (nonatomic, strong, readwrite, nullable) YMKPoint *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.