Class YMKSuggestItem

A single suggested item.

Class Methods

Properties

action

Action to perform on click/tap/enter.

displayText

Text to display if searchText is too technical to display.

distance

Optional distance localized value.

isOffline

Item is from offline search.

isPersonal

If the suggested item respects personalization.

isWordItem

Item is a word suggest item.

logId

Id for request logging.

searchText

Text to search for.

subtitle

If type is TOPONYM returns reversed toponym hierarchy, if type is BUSINESS returns business address.

tags

Additional free-form data for suggest item.

title

Short object name.

type

Suggested object type.

uri

Element uri, if applicable.

Method Detail

+suggestItemWithType:title:subtitle:tags:searchText:displayText:uri:distance:isPersonal:action:logId:isOffline:isWordItem:

+ (nonnull YMKSuggestItem *)suggestItemWithType:(YMKSuggestItemType)type
                                          title:(nonnull YMKSpannableString *)title
                                       subtitle:(nullable YMKSpannableString *)subtitle
                                           tags:(nonnull NSArray< NSString * > *)tags
                                     searchText:(nonnull NSString *)searchText
                                    displayText:(nullable NSString *)displayText
                                            uri:(nullable NSString *)uri
                                       distance:(nullable YMKLocalizedValue *)distance
                                     isPersonal:(BOOL)isPersonal
                                         action:(YMKSuggestItemAction)action
                                          logId:(nullable NSString *)logId
                                      isOffline:(BOOL)isOffline
                                     isWordItem:(BOOL)isWordItem 

Property Detail

action

(assign, readonly) YMKSuggestItemAction action

Action to perform on click/tap/enter.

displayText

(assign, readonly) NSString * displayText

Text to display if searchText is too technical to display.

Optional property, can be null.

distance

(assign, readonly) YMKLocalizedValue * distance

Optional distance localized value.

Optional property, can be null.

isOffline

(assign, readonly) BOOL isOffline

Item is from offline search.

isPersonal

(assign, readonly) BOOL isPersonal

If the suggested item respects personalization.

isWordItem

(assign, readonly) BOOL isWordItem

Item is a word suggest item.

logId

(assign, readonly) NSString * logId

Id for request logging.

Optional property, can be null.

searchText

(assign, readonly) NSString * searchText

Text to search for.

subtitle

(assign, readonly) YMKSpannableString * subtitle

If type is TOPONYM returns reversed toponym hierarchy, if type is BUSINESS returns business address.

Optional property, can be null.

tags

(assign, readonly) NSArray< NSString * > * tags

Additional free-form data for suggest item.

If type is TOPONYM, returns toponym kind (house/street/locality/...). If type is BUSINESS, returns category class (drugstores/restaurants/...).

title

(assign, readonly) YMKSpannableString * title

Short object name.

type

(assign, readonly) YMKSuggestItemType type

Suggested object type.

uri

(assign, readonly) NSString * uri

Element uri, if applicable.

Optional property, can be null.