SYSearchResult Class Reference

Base class for all search results. More...

#import <SYSearchResult.h>

Inheritance diagram for SYSearchResult:
Collaboration diagram for SYSearchResult:

Instance Methods

(instancetype) - initWithSdkResult: [implementation]
 

Class Methods

(SYSearchResultType) + sdkSearchResultTypeToSYSearchResultType: [implementation]
 

Properties

SYSearchResultType type
 Object type of the result. Check the all available SYSearchResultType for more info. More...
 
SYDistance distance
 Distance from requested search location in meters. More...
 
SYSearchResultLabeltitle
 Text with highlights. More...
 
NSString * subtitle
 Additional text description. More...
 
NSArray< NSString * > * mismatchedWords
 All strings from search query which were not matched in the result. More...
 

Detailed Description

Base class for all search results.

Method Documentation

◆ initWithSdkResult:()

- (instancetype) initWithSdkResult: (const sysearch_result_t)  result
implementation

◆ sdkSearchResultTypeToSYSearchResultType:()

+ (SYSearchResultType) sdkSearchResultTypeToSYSearchResultType: (sysearch_result_type_e)  sdkType
implementation

Property Documentation

◆ distance

- (SYDistance) distance
readnonatomicassign

Distance from requested search location in meters.

◆ mismatchedWords

- (NSArray<NSString*>*) mismatchedWords
readwritenonatomicstrong

All strings from search query which were not matched in the result.

◆ subtitle

- (NSString*) subtitle
readwritenonatomicstrong

Additional text description.

◆ title

- (SYSearchResultLabel*) title
readwritenonatomicstrong

Text with highlights.

◆ type

- (SYSearchResultType) type
readnonatomicassign

Object type of the result. Check the all available SYSearchResultType for more info.


The documentation for this class was generated from the following file: