TNEntityClient

@objcMembers
public final class TNEntityClient : NSObject

Main class for SDK. Can be used as static. Before use initialize it with initialize(_ sdkOptions: TNEntitySDKOptions) -> Bool


                    
                    
                    initialize(_:)

Initialize SDK with provided set of Options

This method is required for SDK functioning properly.

Declaration

Swift

@discardableResult
public class func initialize(_ sdkOptions: TNEntitySDKOptions) -> Bool

Parameters


                                sdkOptions

Object that contains set of properties for initializing SDK

Return Value

Returns true if the option provided allows the SDK to be initiated correctly.

reset()
Resets Api Key and Api Secret. Sets state of SDK to unusable
Declaration
Swift

public class func reset()

Requests


                    
                    
                    search(params:completion:)

Performs search request

Declaration

Swift

public class func search(params: TNEntitySearchParams, completion: @escaping (_ result: TNEntitySearchResult?, _ error: Error?) -> Void)

Parameters

`params`	`TNEntitySearchParams` object that contains all parameters for search request
`completion`	Result is `TNEntitySearchResult`. Error is nil if request succeded.


                    
                    
                    getWordPredictions(params:completion:)

Performs prediction word query

Declaration

Swift

public class func getWordPredictions(params: TNEntityWordPredictionParams, completion: @escaping (TNEntityWordPredictionResult?, Error?) -> Void)

Parameters

`params`	contains parameters for request: location `TelenavGeoPoint` object, with latitude and longitude and searchQuery: Text to search
`completion`	Result is `TNEntityPredictionWordResult`. Error is nil if request succeded.


                    
                    
                    getSuggestions(params:completion:)

Performs prediction suggestions query

Declaration

Swift

public class func getSuggestions(params: TNEntitySuggestionParams, completion: @escaping (TNEntitySuggestionResult?, Error?) -> Void)

Parameters

`params`	contains parameters for request: location, `TelenavGeoPoint` object, with latitude and longitude, searchQuery: Text to search, includeEntity: Should include Entities
`completion`	Result is `TelenavSuggestion`. Error is nil if request succeded.


                    
                    
                    getCategories(completion:)

Performs query for fetching catefories

Declaration

Swift

public class func getCategories(completion: @escaping (TNEntityCategoryResult?, Error?) -> Void)

Parameters


                                completion

Result is is TNEntityCategoryResult. Error is nil if request succeded.


                    
                    
                    getDiscoverCategories(params:completion:)

Performs query for fetching discover catefories

Declaration

Swift

public class func getDiscoverCategories(params: TNEntityDiscoverCategoryParams, completion: @escaping (TNEntityCategoryResult?, Error?) -> Void)

Parameters

`params`	contains categoryId: Discovery category id, location: location where to find discover categories, limit: maximum count of desired entities in response
`completion`	Result is is `TNEntityCategoryResult`. Error is nil if request succeded.


                    
                    
                    getDiscoverBrands(params:completion:)

Performs query for fetching discover brands

Declaration

Swift

public class func getDiscoverBrands(params: TNEntityDiscoverBrandParams, completion: @escaping (TNEntityBrandResult?, Error?) -> Void)

Parameters

`params`	request parameters that contains: categoryId: discovery category id, location: location where to find discover categories, limit: maximum count of desired entities in response
`completion`	Result is is `TNEntityBrandResult`. Error is nil if request succeded.


                    
                    
                    getEntityDetail(params:completion:)

Performs query for fetching details for given entities ids

Declaration

Swift

public class func getEntityDetail(params: TNEntityDetailParams, completion: @escaping (TNEntityDetailResult?, Error?) -> Void)

Parameters

`params`	`TNEntityDetailParams`
`completion`	List of results for given entity ids. Error is nil if request succeded.


                    
                    
                    discoverPlace(params:completion:)

Performs discover place request

Declaration

Swift

public class func discoverPlace(params: TNEntityDiscoverPlaceParams, completion: @escaping (TNEntityDiscoverPlaceResult?, Error?) -> Void)

Parameters

`params`	`TNEntityDiscoverPlaceParams`
`completion`	Result is `TNEntityDiscoverPlaceResult`. Error is nil if request succeded.


                    
                    
                    evNearbySearch(params:completion:)

Performs EV nearby search request

Declaration

Swift

public class func evNearbySearch(params: TNEntityEvNearbySearchParams, completion: @escaping (TNEntityEvNearbySearchResult?, Error?) -> Void)

Parameters

`params`	`TNEntityEvNearbySearchParams`
`completion`	Result is `TNEntityEvNearbySearchResult`. Error is nil if request succeded.


                    
                    
                    evChargingOnRoute(params:completion:)

Performs EV charging on route request

Declaration

Swift

public class func evChargingOnRoute(params: TNEntityEvChargingOnRouteParams, completion: @escaping (TNEntityEvChargingOnRouteResult?, Error?) -> Void)

Parameters

`params`	`TNEntityEvChargingOnRouteParams`
`completion`	Result is `TNEntityEvChargingOnRouteResult`. Error is nil if request succeded.