app_tracker

Top-level module for the Conviva App Tracker. More...

Data Structures
struct	cat_network_request_info
	Use to set the network request details. More...

Macros
#define	CAT_MAX_APP_NAME_LENGTH   64
#define	CAT_MAX_USER_ID_LENGTH   64
#define	CAT_MAX_IID_LENGTH   64
#define	CCL_APP_MAX_SCREEN_NAME_LEN   1024
#define	CCL_APP_MAX_SCREEN_ID_LEN   38
#define	CAT_MAX_URL_LENGTH   1024
#define	CAT_MAX_METHOD_LENGTH   15
#define	CAT_MAX_BODY_LENGTH   10000
#define	CAT_MEMORY_ERROR   -1
#define	CAT_MUTEX_ERROR   -2
#define	CAT_INPUT_ERROR   -3
#define	CAT_TIMER_ERROR   -4
#define	CAT_ERROR   0
#define	CAT_SUCCESS   1

Typedefs
typedef struct cat_network_request_info	cat_network_request_info_t
	Use to set the network request details. More...

Functions
int	cat_set_user_id (const char *uid)
	Sets the user ID for ECO. More...
int	cat_send_custom_event (const char *name, ccl_dictionary_t *attributes)
	send custom event to eco More...
int	cat_track_screen_view (const char *name, const char *screen_type)
	send the screen info More...
int	cat_track_network_request (cat_network_request_info_t *nw_info)
	send the network request info to eco More...
int	cat_pause_tracker (void)
	pause the app tracker to stop monitoring More...
int	cat_resume_tracker (void)
	resume the app tracker to start monitoring again More...

Detailed Description

Top-level module for the Conviva App Tracker.

The application should call

Macro Definition Documentation

CAT_ERROR

#define CAT_ERROR   0

CAT_INPUT_ERROR

#define CAT_INPUT_ERROR   -3

CAT_MAX_APP_NAME_LENGTH

#define CAT_MAX_APP_NAME_LENGTH   64

CAT_MAX_BODY_LENGTH

#define CAT_MAX_BODY_LENGTH   10000

CAT_MAX_IID_LENGTH

#define CAT_MAX_IID_LENGTH   64

CAT_MAX_METHOD_LENGTH

#define CAT_MAX_METHOD_LENGTH   15

CAT_MAX_URL_LENGTH

#define CAT_MAX_URL_LENGTH   1024

CAT_MAX_USER_ID_LENGTH

#define CAT_MAX_USER_ID_LENGTH   64

CAT_MEMORY_ERROR

#define CAT_MEMORY_ERROR   -1

CAT_MUTEX_ERROR

#define CAT_MUTEX_ERROR   -2

CAT_SUCCESS

#define CAT_SUCCESS   1

CAT_TIMER_ERROR

#define CAT_TIMER_ERROR   -4

CCL_APP_MAX_SCREEN_ID_LEN

#define CCL_APP_MAX_SCREEN_ID_LEN   38

CCL_APP_MAX_SCREEN_NAME_LEN

#define CCL_APP_MAX_SCREEN_NAME_LEN   1024

Typedef Documentation

cat_network_request_info_t

typedef struct cat_network_request_info cat_network_request_info_t

Use to set the network request details.

Function Documentation

cat_pause_tracker()

int cat_pause_tracker

(

void

)

pause the app tracker to stop monitoring

Returns

• CCL_SUCCESS
• CCL_ERROR

cat_resume_tracker()

int cat_resume_tracker

(

void

)

resume the app tracker to start monitoring again

Returns

• CCL_SUCCESS
• CCL_ERROR

cat_send_custom_event()

int cat_send_custom_event	(	const char *	name,
		ccl_dictionary_t *	attributes
	)

send custom event to eco

Parameters

name	name of the event
attributes	attributes for the event, can be empty dictionary

Returns

CAT_SUCCESS / CAT_ERROR

cat_set_user_id()

int cat_set_user_id

(

const char *

uid

)

Sets the user ID for ECO.

Parameters

uid	user_id value

Returns

CAT_SUCCESS / CAT_ERROR

cat_track_network_request()

int cat_track_network_request

(

cat_network_request_info_t *

nw_info

)

send the network request info to eco

Parameters

nw_info

network info parameters, memory has to be allocated and freed for nw_info.

Returns

CAT_SUCCESS / CAT_ERROR

cat_track_screen_view()

int cat_track_screen_view	(	const char *	name,
		const char *	screen_type
	)

send the screen info

Parameters

name	name/title of the screen, mandatory field
screen_type	type of the screen if available, optional field

Returns

CAT_SUCCESS / CAT_ERROR