KNYClient Class Reference
Inherits from | NSObject |
Declared in | KNYClient.h |
Tasks
-
+ sharedClient
-
– init
-
– initializeInBackgroundWithAppKey:appSecret:serviceURLString:completion:
-
– initWithServiceDoc:
-
– initWithAppkey:appSecret:serviceDoc:
-
appKey
property -
appSecret
property -
serviceURLString
property -
– setPersistentStore:
-
– setStorageMgr:
-
+ setLogLevel:
-
+ clearCache
-
+ setNetworkOptions:
-
+ networkOptions
-
– setNWOptions:
-
– getNWOptions
-
+ acceptSelfSignedCertificates
-
– ignoreSSLCertErrors
-
– getIdentityService:
-
– getIntegrationService:
-
– getMessagingService
-
– getSyncService
-
– getMetricsService
-
– getServiceDoc
-
– getAppKey
-
– getAppSecret
-
– setClientParams:
-
+ sdkType
-
+ sdkVersion
Class Methods
acceptSelfSignedCertificates
invoking this method enables to accept self signed certificates
+ (void)acceptSelfSignedCertificates
Discussion
invoking this method enables to accept self signed certificates
Declared In
KNYClient.h
clearCache
Clears the cached config and tokens.
+ (void)clearCache
Discussion
Clears the cached config and tokens.
Note: You will need to authenticate again.
Declared In
KNYClient.h
networkOptions
Returns network options
+ (KNYNetworkOptions *)networkOptions
Discussion
Returns network options
Declared In
KNYClient.h
sdkType
get the sdktype
+ (NSString *)sdkType
Return Value
the sdk type.
Discussion
get the sdktype
Declared In
KNYClient.h
sdkVersion
get the sdkVersion
+ (NSString *)sdkVersion
Return Value
the sdk version
Discussion
get the sdkVersion
Declared In
KNYClient.h
setLogLevel:
Set Logging Level.
+ (void)setLogLevel:(KNYLogLevel)logLevel
Parameters
- logLevel
The logging level.
Discussion
Set Logging Level.
By Default the Logging Level is set to KNYLogLevelNone.
Declared In
KNYClient.h
Instance Methods
getAppKey
returns the Appkey.
- (NSString *)getAppKey
Discussion
returns the Appkey.
Declared In
KNYClient.h
getAppSecret
returns AppSecret.
- (NSString *)getAppSecret
Discussion
returns AppSecret.
Declared In
KNYClient.h
getIdentityService:
returns identityService instance for a given provider;
- (KNYIdentityService *)getIdentityService:(NSString *)provider
Discussion
returns identityService instance for a given provider;
Declared In
KNYClient.h
getIntegrationService:
returns integrationService instance for a given serviceName.
- (KNYIntegrationService *)getIntegrationService:(NSString *)serviceName
Discussion
returns integrationService instance for a given serviceName.
Declared In
KNYClient.h
getMessagingService
returns the messagingService instance.
- (KNYMessagingService *)getMessagingService
Discussion
returns the messagingService instance.
Declared In
KNYClient.h
getMetricsService
returns the metricsService instance.
- (KNYMetricsService *)getMetricsService
Discussion
returns the metricsService instance.
Declared In
KNYClient.h
getNWOptions
Returns network options
- (KNYNetworkOptions *)getNWOptions
Discussion
Returns network options
Declared In
KNYClient.h
getServiceDoc
returns the serviceDoc instance.
- (KNYServiceDoc *)getServiceDoc
Discussion
returns the serviceDoc instance.
Declared In
KNYClient.h
getSyncService
returns the syncService instance.
- (KNYSync *)getSyncService
Discussion
returns the syncService instance.
Declared In
KNYClient.h
ignoreSSLCertErrors
invoking this method enables to accept self signed certificates (New API)
- (void)ignoreSSLCertErrors
Discussion
invoking this method enables to accept self signed certificates (New API)
Declared In
KNYClient.h
initWithAppkey:appSecret:serviceDoc:
Authenticates you with the Kony Mobile Fabric Service. The appKey, appSecret and serviceURLString are available in the Kony Mobile Fabric Console.
- (void)initWithAppkey:(NSString *)appKey appSecret:(NSString *)appSecret serviceDoc:(NSDictionary *)serviceDoc
Parameters
- appKey
The appkey for your application.
- appSecret
The appsecret for your application.
- serviceConfig
service configuration for your application.
Discussion
Authenticates you with the Kony Mobile Fabric Service. The appKey, appSecret and serviceURLString are available in the Kony Mobile Fabric Console.
@throws KNYException if appConfig is invalid.
example of service doc:
NSDictionary *dict = @{ @“name”:@“test”, @“baseId”:@“testbaseId”, @“reportingsvc”: @{ @“custom”: @“https://nut007.konycloud.com/services/CMS”, @“session”: @“https://nut007.konycloud.com/services/IST” } }; name, baseId and reportingsvc are mandatory parameters as part of service config.
Declared In
KNYClient.h
initWithServiceDoc:
init using service configuration @throws KNYException if appConfig is invalid. example of service doc:
- (void)initWithServiceDoc:(NSDictionary *)serviceDoc
Parameters
- serviceConfig
service configuration of your application.
Discussion
init using service configuration @throws KNYException if appConfig is invalid. example of service doc:
NSDictionary *dict = @{ @“name”:@“test”, @“baseId”:@“testbaseId”, @“reportingsvc”: @{ @“custom”: @“https://nut007.konycloud.com/services/CMS”, @“session”: @“https://nut007.konycloud.com/services/IST” } };
name, baseId and reportingsvc are mandatory parameters as part of service config.
Declared In
KNYClient.h
initializeInBackgroundWithAppKey:appSecret:serviceURLString:completion:
Authenticates you with the Kony Mobile Fabric Service. The appKey, appSecret and serviceURLString are available in the Kony Mobile Fabric Console.
- (void)initializeInBackgroundWithAppKey:(NSString *)appKey appSecret:(NSString *)appSecret serviceURLString:(NSString *)URLString completion:(void ( ^ ) ( BOOL succeeded , NSError *error ))completion
Parameters
- appKey
The appkey for your application.
- appSecret
The appsecret for your application.
- URLString
The service url for your application.
- completion
Completion block called on completion of initialization. The block should have the following argument signature: (BOOL succeeded, NSError *error)
Discussion
Authenticates you with the Kony Mobile Fabric Service. The appKey, appSecret and serviceURLString are available in the Kony Mobile Fabric Console.
Declared In
KNYClient.h
setClientParams:
set client params (used for konystudio apps using MF backend)
- (void)setClientParams:(NSDictionary *)clientParams
Parameters
- clientParams
client params
Discussion
set client params (used for konystudio apps using MF backend)
Declared In
KNYClient.h