Inherits from NSObject
Declared in KNYReportingService.h

Overview

KNYReportingService

Tasks

Properties

flowTag

Flow Tag for the reported events. Set to nil to clear previously set flowTag. length cannot be more than 256.

@property (nonatomic, readwrite) NSString *flowTag

Discussion

Flow Tag for the reported events. Set to nil to clear previously set flowTag. length cannot be more than 256.

Declared In

KNYReportingService.h

userId

userid related to reporting. userid length cannot be more than 100.

@property (nonatomic, readwrite) NSString *userId

Discussion

userid related to reporting. userid length cannot be more than 100.

Declared In

KNYReportingService.h

Class Methods

sharedReportingService

Throws exception, when invoked before initialializing the KNYClient.

+ (instancetype)sharedReportingService

Return Value

Returns the shared instance of KNYReportingService

Discussion

Throws exception, when invoked before initialializing the KNYClient.

Declared In

KNYReportingService.h

Instance Methods

eventsInBuffer

This method will return the a List of the buffered events.

- (NSDictionary *)eventsInBuffer

Return Value

returns dictionary of events stored in buffer.

Discussion

This method will return the a List of the buffered events.

Declared In

KNYReportingService.h

flushEvents

This method will send the buffered events to the server at once.

- (void)flushEvents

Discussion

This method will send the buffered events to the server at once.

Declared In

KNYReportingService.h

init

- (id)init

reportEventsWithEventType:eventSubType:formID:widgetID:flowTag:

This method takes the event details from the developer and schedule it for sending to server as per Configuration values set by the developer.

- (void)reportEventsWithEventType:(KNYEventType)eventType eventSubType:(NSString *)eventSubType formID:(NSString *)formID widgetID:(NSString *)widgetID flowTag:(NSString *)flowTag

Parameters

eventType
  • string literal for formID can be null.
eventSubType
  • string literal for eventSubType(max 256 Chars)
formID
  • string literal for formID(max 256 Chars)
widgetID
  • string literal for widgetID(max 256 Chars)
flowTag
  • string literal to override flow tag (max 256 Chars)

Discussion

This method takes the event details from the developer and schedule it for sending to server as per Configuration values set by the developer.

Declared In

KNYReportingService.h

reportWithGroupId:andData:

Reporting API

- (void)reportWithGroupId:(NSString *)groupId andData:(NSDictionary *)data

Parameters

groupId

group id - groupId length cannot be more than 250.

data

data to be send

Discussion

Reporting API

Declared In

KNYReportingService.h

setEventConfigType:eventBufferAutoFlushCount:eventBufferMaxCount:

This method will take the required values to set the event Configuration values. When eventConfigType is - KNYEventConfigTypeBuffer eventBufferAutoFlushCount and eventBufferMaxCount are considered. - KNYEventConfigTypeIntant eventBufferAutoFlushCount and eventBufferMaxCount are ignored.

- (void)setEventConfigType:(KNYEventConfigType)eventConfigType eventBufferAutoFlushCount:(NSUInteger)eventBufferAutoFlushCount eventBufferMaxCount:(NSUInteger)eventBufferMaxCount

Parameters

eventConfigType
  • sets the Current Configuration Type
eventBufferAutoFlushCount
  • event buffer count to auto flush the events possible values any positive integer Default value 15
eventBufferMaxCount
  • Maximum event buffer count to store the events possible values any positive integer Default value 1000

Discussion

This method will take the required values to set the event Configuration values. When eventConfigType is - KNYEventConfigTypeBuffer eventBufferAutoFlushCount and eventBufferMaxCount are considered. - KNYEventConfigTypeIntant eventBufferAutoFlushCount and eventBufferMaxCount are ignored.

Declared In

KNYReportingService.h

setReportingServiceEndPoint:serviceName:

sets the reporting Service end-point URL

- (void)setReportingServiceEndPoint:(NSString *)URLString serviceName:(NSString *)serviceName

Parameters

URLString

reportingService end-point URL

serviceName

reportingServiceName (values = “session”, “custom”)

Discussion

sets the reporting Service end-point URL

Declared In

KNYReportingService.h