Tracking an Event

The trackEventCategory: feature enables you keep track of how your clients are interacting with the various features within your application, potentially identifying how often every single feature is being used by various user groups. Apart from monitoring feature usage, you can also keep track of how often an event happens - such as how often an auto save has been made on average for every hour your application was running.

The trackEventCategory: feature logs a normal event with the supplied data.

trackEventCategory: can be called between startSDK and stopSDK:, and can be called zero or more times.

trackEventCategory: can be called while a New Registration is being performed (createConfig, startSDK). However, the event data is not written to the log file until the New Registration completes, and if the New Registration fails, the data will be lost.

trackEventCategory: is an asynchronous function, returning immediately with further functionality executed on separate thread(s).

trackEventCategory:

(RUIRESULTOBJC) trackEventCategory: (NSString*)eventCategory eventName: (NSString*)eventName sessionID: (NSString*)sessionID

Parameters

The trackEventCategory: function has the following parameters.

trackEventCategory: Parameters

Parameter	Description
eventCategory (NSString*)	The name of the category of this event. This parameter is optional (send NULL if not required). Unlike V4 of the Usage Intelligence SDK, there is no concept of extended names (for eventCategory and eventName). The content of eventCategory and eventName is conditioned and validated (after conditioning) with the following rules: • Conditioning—All leading white space is removed. • Conditioning—All trailing white space is removed. • Conditioning—All internal white spaces other than space characters (' ') are removed. • Conditioning—Trimmed to a maximum of 128 UTF-8 characters. • Validation—eventCategory can be empty; eventName cannot be empty.
eventName (NSString*)	The name of the event to be tracked. Unlike V4 of the Usage Intelligence SDK, there is no concept of extended names (for eventCategory and eventName). The content of eventCategory and eventName is conditioned and validated (after conditioning) with the following rules: • Conditioning—All leading white space is removed. • Conditioning—All trailing white space is removed. • Conditioning—All internal white spaces other than space characters (' ') are removed. • Conditioning—Trimmed to a maximum of 128 UTF-8 characters. • Validation—eventCategory can be empty; eventName cannot be empty.
sessionID (NSString*)	If multiple user sessions are supported within the application (multiSessionEnabled = true), this should contain the unique ID that refers to the user session in which the event occurred. If the application supports only a single session, then this value should be null.

Returns

The trackEventCategory: function returns one of the return status constants below.

trackEventCategory: Returns

Return	Description
RUI_OK	Synchronous functionality successful.
RUI_SDK_INTERNAL_ERROR_FATAL	Irrecoverable internal fatal error. No further API calls should be made.
RUI_SDK_ABORTED	A required New Registration has failed, and hence the SDK is aborted. stopSDK: and Objective-C instance release are possible.
RUI_SDK_SUSPENDED	The Server has instructed a temporary back-off.
RUI_SDK_PERMANENTLY_DISABLED	The Server has instructed a permanent disable.
RUI_SDK_OPTED_OUT	Instance has been instructed by the application to opt-out.
RUI_CONFIG_NOT_CREATED	Configuration has not been successfully created.
RUI_SDK_NOT_STARTED	SDK has not been successfully started.
RUI_SDK_ALREADY_STOPPED	SDK has already been successfully stopped.
RUI_INVALID_SESSION_ID_EXPECTED_EMPTY	The sessionID is expected to be empty, and it was not.
RUI_INVALID_SESSION_ID_EXPECTED_NON_EMPTY	The sessionID is expected to be non-empty, and it was not.
RUI_INVALID_SESSION_ID_TOO_SHORT	The sessionID violates its allowable minimum length.
RUI_INVALID_SESSION_ID_TOO_LONG	The sessionID violates its allowable maximum length.
RUI_INVALID_SESSION_ID_NOT_ACTIVE	Parameter validation: The sessionID is not currently in use.
RUI_INVALID_PARAMETER_EXPECTED_NON_EMPTY	Parameter validation: Some API parameter is expected to be non-empty, and is not.