KNSDK

INFO

This English reference is based on Directions SDK 1.12.12. For the latest version, see the Korean reference.

Inherits from: NSObject
Declared in: KNSDK.h

KNSDK provides three main features for using Kakao Navi: map, route, and guidance. These three features are separated into individual modules so that you can select and use only the features your service needs. For example, you can use the route module to check the estimated time of arrival (ETA), integrate the map module to display a route on the map, and integrate the guidance module to implement navigation.

Properties

Name	Description	Type
`initSt`	Authentication and initialization state	`var initSt: KNSDKInitState`
`delegate`	Delegate that reports the SDK status	`var delegate: KNSDKDelegate?`

Constructor

+ sdkVersion

Returns the version of the KNSDK in use.

objc

+ (NSString *) sdkVersion

+ sharedInstance

Returns the singleton KNSDK instance.

objc

+ (nullable KNSDK *) sharedInstance

+ releaseInstance

Releases the singleton KNSDK instance.

objc

+ (void) releaseInstance

+ handleWillResignActive

Notifies KNSDK when the application enters the paused state.

Example code — + handleWillResignActive

objc

 - (void)applicationWillResignActive:(UIApplication *)application {
 [KNSDK handleWillResignActive];
 }

objc

+ (void) handleWillResignActive

+ handleDidEnterBackground

Notifies KNSDK when the application enters the background state.

Example code — + handleDidEnterBackground

objc

 - (void)applicationDidEnterBackground:(UIApplication *)application {
 [KNSDK handleDidEnterBackground];
 }

objc

+ (void) handleDidEnterBackground

+ handleWillEnterForeground

Notifies KNSDK when the application enters the foreground state.

Example code — + handleWillEnterForeground

objc

 - (void)applicationWillEnterForeground:(UIApplication *)application {
 [KNSDK handleWillEnterForeground];
 }

objc

+ (void) handleWillEnterForeground

+ handleDidBecomeActive

Notifies KNSDK when the application enters the resumed state. When the state is resumed, the paused state of voice guidance is released.

Example code — + handleDidBecomeActive

objc

 - (void)applicationDidBecomeActive:(UIApplication *)application {
 [KNSDK handleDidBecomeActive];
 }

objc

+ (void) handleDidBecomeActive

+ handleWillTerminate

When the app terminates, saves the current guidance state and route in KNSDK if guidance is active.

Example code — + handleWillTerminate

objc

 - (void)applicationWillTerminate:(UIApplication *)application {
 [KNSDK handleWillTerminate];
 }

objc

+ (void) handleWillTerminate

+ handleCarInterfaceConnected

Notifies KNSDK that the application has connected to an in-vehicle infotainment system.

objc

+ (void) handleCarInterfaceConnected

+ handleCarInterfaceDisconnected

Notifies KNSDK that the application has disconnected from the in-vehicle infotainment system.

objc

+ (void) handleCarInterfaceDisconnected

Methods

initializeWithAppKey:clientVersion:userKey:langType:mapType:completion

Initializes KNSDK.

TIP

You must initialize KNSDK before using it.

Example code — KNSDK

objc

 [[KNSDK sharedInstance] initializeWithApiKey:@"API Key" userKey:@"User Key" langType:KNLanguageType_KOREAN completion:^(KNError *error) {
 if (error)
 {
 // SDK initialization failed
 }
 else
 {
 // SDK initialization succeeded
 }
}];

objc

- (void) initializeWithAppKey: (NSString *) aAppKey
clientVersion: (NSString *) aClientVersion
userKey: (NSString *_Nullable) aUserKey
langType: (KNLanguageType) aLangType
mapType: (KNMapType) aMapType
completion: (void ( ^ ) ( KNError *aError )) aCompletion

Parameters

Name	Description
`aAppKey`	AppKey issued for using KNSDK
`aLangType`	Language settings
`aUserKey`	The UserKey used to identify a user. The key value is issued by the service, and KNSDK uses it to identify individual users and provide personalized services.
`aMapType`	Map type (MapType) setting
`aCompletion`	Delivers the result state after initialization completes

mapVersion

Returns the current map version.

objc

- (SInt32) mapVersion

makeMapViewWithFrame

Requests a map view object. Internally binds and initializes the loader, styler, and renderer, then returns it.

TIP

The map view object must be created through KNSDK.

objc

- (KNMapView *_Nullable) makeMapViewWithFrame: (CGRect) aFrame

sharedMapDownLoader

Returns the map downloader used to download the full map.

objc

- (KNMapDownLoader *) sharedMapDownLoader

getMapType

Returns the current map type.

objc

- (KNMapType) getMapType

setMapType:complition

Selects either the cloud-based map or the locally downloaded full-map type.

objc

- (void) setMapType: (KNMapType) aMapType
complition: (void ( ^ ) ( KNError *)) aCompletion

mapCacheDeleteCompletion

Deletes cached map data.

objc

- (void) mapCacheDeleteCompletion: (void ( ^ ) ( KNError *aError )) aCompletion

makeTripWithStart:goal:vias:completion

Creates a KNTrip.

objc

- (void) makeTripWithStart: (KNPOI *) aStart
goal: (KNPOI *) aGoal
vias: (NSArray<KNPOI*> *_Nullable) aVias
completion: (void ( ^ ) ( KNError *aError KNTrip *aTrip )) aCompletion

Parameters

Name	Description
`aStart`	Origin
`aGoal`	Destination
`aVias`	Waypoint list
`aCompletion`	Route completion block

sharedGuidance

Gets KNGuidance. Only one KNGuidance instance exists.

objc

- (KNGuidance *) sharedGuidance

reqPoiText:page:completion

Searches for a Point of Interest (POI).

objc

- (void) reqPoiText: (NSString *) aText
page: (int) aPage
completion: (void ( ^ ) ( KNError * NSDictionary *)) aCompletion

Parameters

Name	Description
`aText`	Name
`aPage`	Search result page

setUserKey

Passes the key used to identify a user (UserKey) to KNSDK.

objc

- (void) setUserKey: (NSString *_Nullable) aUserKey

Parameters

Name	Description
`aUserKey`	The UserKey used to identify a user. The key value is issued by the service, and KNSDK uses it to identify individual users and provide personalized services.

sharedGpsManager

Returns the singleton KNGPSManager instance.

objc

- (KNGPSManager *) sharedGpsManager

reverseGeocodeWithPos:completion

Returns the administrative-district Address for the specified KATEC coordinates. The values are returned in this order: error code, administrative code, province, city/county/district, and neighborhood.

objc

- (void) reverseGeocodeWithPos: (IntPoint) aKatecPos
completion: (void ( ^ ) ( KNError *_Nullable aError NSString *_Nullable aAddrCode NSString *_Nullable aDoName NSString *_Nullable aSiGunGuName NSString *_Nullable aDongName )) aCompletion

Parameters

Name	Description
`aKatecPos`	KATEC coordinates to convert to an Address
`aCompletion`	Administrative-district Address for the KATEC coordinates

convertWGS84ToKATEC

Converts WGS84 coordinates to KATEC coordinates.

objc

- (IntPoint) convertWGS84ToKATECWithLongitude: (double) aWgs84Lon
latitude: (double) aWgs84Lat

Parameters

Name	Description
`aWgs84Lon`	Longitude in WGS84 coordinates
`aWgs84Lat`	Latitude in WGS84 coordinates

convertKATECToWGS84WithX:y

Converts KATEC coordinates to WGS84 coordinates and returns them.

objc

- (DoublePoint) convertKATECToWGS84WithX: (SInt32) aKatecX
y: (SInt32) aKatecY

Parameters

Name	Description
`aKatecX`	X value in KATEC coordinates
`aKatecY`	Y value in KATEC coordinates

requestLocationUpdate

Registers a receiver for location updates from KNGPSManager. The registered receiver receives each location update.

objc

- (void) requestLocationUpdate: (id	<KNGPSReceiver>) aGPSReceiver

Parameters

Name	Description
`aGPSReceiver`	Receiver to register

sharedConnection

Returns the singleton KNConnection instance.

objc

- (KNConnection *) sharedConnection

sharedParkingLotManager

Returns KNParkingLotManager, which requests and receives parking-lot information. Only one instance exists.

objc

- (KNParkingLotManager *) sharedParkingLotManager;

setPOIRatio

Sets a scale to adjust the size of points of interest (POI). (min: 0.5, max: 2.0)

objc

- (void) setPOIRatio: (float) aPOIRatio

setBuildingFlat

Sets whether buildings appear flat on the map. (default: NO)

objc

- (void) setBuildingFlat: (bool) isBuildingFlat

setAppUserId

Sets appUserId to identify the user.

objc

- (void) setAppUserId:  (NSString *_Nullable) aAppUserId

Parameters

Name	Description
`aAppUserId`	User identifier

KNSDK ​

Properties ​

Constructor ​

+ sdkVersion ​

+ sharedInstance ​

+ releaseInstance ​

+ handleWillResignActive ​

+ handleDidEnterBackground ​

+ handleWillEnterForeground ​

+ handleDidBecomeActive ​

+ handleWillTerminate ​

+ handleCarInterfaceConnected ​

+ handleCarInterfaceDisconnected ​

Methods ​

initializeWithAppKey:clientVersion:userKey:langType:mapType:completion ​

mapVersion ​

makeMapViewWithFrame ​

sharedMapDownLoader ​

getMapType ​

setMapType:complition ​

mapCacheDeleteCompletion ​

makeTripWithStart:goal:vias:completion ​

sharedGuidance ​

reqPoiText:page:completion ​

setUserKey ​

sharedGpsManager ​

reverseGeocodeWithPos:completion ​

convertWGS84ToKATEC ​

convertKATECToWGS84WithX:y ​

requestLocationUpdate ​

sharedConnection ​

sharedParkingLotManager ​

setPOIRatio ​

setBuildingFlat ​

setAppUserId ​

KNSDK

Properties

Constructor

+ sdkVersion

+ sharedInstance

+ releaseInstance

+ handleWillResignActive

+ handleDidEnterBackground

+ handleWillEnterForeground

+ handleDidBecomeActive

+ handleWillTerminate

+ handleCarInterfaceConnected

+ handleCarInterfaceDisconnected

Methods

initializeWithAppKey:clientVersion:userKey:langType:mapType:completion

mapVersion

makeMapViewWithFrame

sharedMapDownLoader

getMapType

setMapType:complition

mapCacheDeleteCompletion

makeTripWithStart:goal:vias:completion

sharedGuidance

reqPoiText:page:completion

setUserKey

sharedGpsManager

reverseGeocodeWithPos:completion

convertWGS84ToKATEC

convertKATECToWGS84WithX:y

requestLocationUpdate

sharedConnection

sharedParkingLotManager

setPOIRatio

setBuildingFlat

setAppUserId