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

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

struct	cat_anr_info
	Application Not Responding details. More...

struct	cat_app_info
	Use to set the application details. More...

struct	cat_app_error_info
	Application Error Information. More...

struct	cat_screen_info
	Screen 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

#define	CAT_MAX_APP_BUILD_LENGTH 64

#define	CAT_MAX_APP_VERSION_LENGTH 64

#define	STR_MAX_LEN_1024 1024

#define	STR_MAX_LEN_2048 2048

#define	STR_MAX_LEN_8192 8192

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

typedef struct cat_anr_info	cat_anr_info_t
	Application Not Responding details.

typedef struct cat_app_info	cat_app_info_t
	Use to set the application details.

typedef enum cat_error_lang	cat_error_lang_t
	Language of the error message.

typedef struct cat_app_error_info	cat_app_error_info_t
	Application Error Information.

typedef struct cat_screen_info	cat_screen_info_t
	Screen details.

Enumerations
enum	cat_error_lang { CAT_ERROR_LANG_UNKNOWN = 0 , CAT_ERROR_LANG_JAVA , CAT_ERROR_LANG_SCALA , CAT_ERROR_LANG_KOTLIN , CAT_ERROR_LANG_GROOVY , CAT_ERROR_LANG_RUBY , CAT_ERROR_LANG_GOLANG , CAT_ERROR_LANG_JAVASCRIPT , CAT_ERROR_LANG_PHP , CAT_ERROR_LANG_PYTHON , CAT_ERROR_LANG_OBJECTIVEC , CAT_ERROR_LANG_SWIFT , CAT_ERROR_LANG_C , CAT_ERROR_LANG_CPLUSPLUS , CAT_ERROR_LANG_CSHARP , CAT_ERROR_LANG_ACTIONSCRIPT , CAT_ERROR_LANG_LUA , CAT_ERROR_LANG_RUST , CAT_ERROR_LANG_HASKELL , CAT_ERROR_LANG_CLOJURE , CAT_ERROR_LANG_ERLANG , CAT_ERROR_LANG_ELIXIR , CAT_ERROR_LANG_CRYSTAL , CAT_ERROR_LANG_PONY , CAT_ERROR_LANG_NIM }
	Language of the error message. More...

Functions
int	cat_set_user_id (const char *uid)
	Sets the user ID for ECO.

int	cat_send_custom_event (const char name, ccl_dictionary_t attributes)
	send custom event to eco

int	cat_track_screen_view (cat_screen_info_t *screen_info)
	send the screen info

int	cat_track_network_request (cat_network_request_info_t *nw_info)
	send the network request info to eco

int	cat_pause_tracker (void)
	pause the app tracker to stop monitoring

int	cat_resume_tracker (void)
	resume the app tracker to start monitoring again

int	cat_track_app_install (void)
	notifies the app install event, normally calls on fresh launch after install or upgrade

int	cat_set_application_info (cat_app_info_t *app_info)
	set application info, can set right after the tracker creation.

int	cat_track_anr (cat_anr_info_t *anr_info)
	send the ANR(application not responding) event, shall send on unrecovered ANRs on next launch.

int	cat_track_application_error (cat_app_error_info_t *error_info)
	send the application error to eco, use this API for realtime error tracking.

int	cat_set_custom_tags (ccl_dictionary_t *tags)
	set the custom tags

int	cat_clear_custom_tags (char *keys[], int key_count)
	clear the specific custom tags with keys

int	cat_clear_all_custom_tags ()
	clear all custom tags

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_BUILD_LENGTH

#define CAT_MAX_APP_BUILD_LENGTH 64

◆ CAT_MAX_APP_NAME_LENGTH

#define CAT_MAX_APP_NAME_LENGTH 64

◆ CAT_MAX_APP_VERSION_LENGTH

#define CAT_MAX_APP_VERSION_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

◆ STR_MAX_LEN_1024

#define STR_MAX_LEN_1024 1024

◆ STR_MAX_LEN_2048

#define STR_MAX_LEN_2048 2048

◆ STR_MAX_LEN_8192

#define STR_MAX_LEN_8192 8192

Typedef Documentation

◆ cat_anr_info_t

typedef struct cat_anr_info cat_anr_info_t

Application Not Responding details.

◆ cat_app_error_info_t

typedef struct cat_app_error_info cat_app_error_info_t

Application Error Information.

◆ cat_app_info_t

typedef struct cat_app_info cat_app_info_t

Use to set the application details.

◆ cat_error_lang_t

typedef enum cat_error_lang cat_error_lang_t

Language of the error message.

◆ cat_network_request_info_t

typedef struct cat_network_request_info cat_network_request_info_t

Use to set the network request details.

◆ cat_screen_info_t

typedef struct cat_screen_info cat_screen_info_t

Screen details.

Enumeration Type Documentation

◆ cat_error_lang

enum cat_error_lang

Language of the error message.

Enumerator
CAT_ERROR_LANG_UNKNOWN
CAT_ERROR_LANG_JAVA
CAT_ERROR_LANG_SCALA
CAT_ERROR_LANG_KOTLIN
CAT_ERROR_LANG_GROOVY
CAT_ERROR_LANG_RUBY
CAT_ERROR_LANG_GOLANG
CAT_ERROR_LANG_JAVASCRIPT
CAT_ERROR_LANG_PHP
CAT_ERROR_LANG_PYTHON
CAT_ERROR_LANG_OBJECTIVEC
CAT_ERROR_LANG_SWIFT
CAT_ERROR_LANG_C
CAT_ERROR_LANG_CPLUSPLUS
CAT_ERROR_LANG_CSHARP
CAT_ERROR_LANG_ACTIONSCRIPT
CAT_ERROR_LANG_LUA
CAT_ERROR_LANG_RUST
CAT_ERROR_LANG_HASKELL
CAT_ERROR_LANG_CLOJURE
CAT_ERROR_LANG_ERLANG
CAT_ERROR_LANG_ELIXIR
CAT_ERROR_LANG_CRYSTAL
CAT_ERROR_LANG_PONY
CAT_ERROR_LANG_NIM

Function Documentation

◆ cat_clear_all_custom_tags()

int cat_clear_all_custom_tags ( )

clear all custom tags

Returns

CCL_SUCCESS
CCL_ERROR

◆ cat_clear_custom_tags()

int cat_clear_custom_tags	(	char *	keys[],
		int	key_count
	)

clear the specific custom tags with keys

Parameters

keys,keys	to be deleted from tags.
key_count,number	of input keys.

Returns

CCL_SUCCESS
CCL_ERROR

◆ 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_application_info()

int cat_set_application_info ( cat_app_info_t * app_info )

set application info, can set right after the tracker creation.

Parameters

app_info application info parameters like buil, version and loading timing details.

Returns

CCL_SUCCESS
CCL_ERROR

◆ cat_set_custom_tags()

int cat_set_custom_tags ( ccl_dictionary_t * tags )

set the custom tags

Parameters

tags,tags key-value pairs.

Returns

CCL_SUCCESS
CCL_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_anr()

int cat_track_anr ( cat_anr_info_t * anr_info )

send the ANR(application not responding) event, shall send on unrecovered ANRs on next launch.

Parameters

anr_info,anr info inlcudes time of ANRs start and reason.

Returns

CCL_SUCCESS
CCL_ERROR

◆ cat_track_app_install()

int cat_track_app_install ( void )

notifies the app install event, normally calls on fresh launch after install or upgrade

Returns

CCL_SUCCESS
CCL_ERROR

◆ cat_track_application_error()

int cat_track_application_error ( cat_app_error_info_t * error_info )

send the application error to eco, use this API for realtime error tracking.

Parameters

error_info,error info inlcudes message, exception, class, function details.

Returns

CCL_SUCCESS
CCL_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 ( cat_screen_info_t * screen_info )

send the screen info

Parameters

screen_info details of the screen like name, type, load times.

Returns: CAT_SUCCESS / CAT_ERROR

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ CAT_ERROR

◆ CAT_INPUT_ERROR

◆ CAT_MAX_APP_BUILD_LENGTH

◆ CAT_MAX_APP_NAME_LENGTH

◆ CAT_MAX_APP_VERSION_LENGTH

◆ CAT_MAX_BODY_LENGTH

◆ CAT_MAX_IID_LENGTH

◆ CAT_MAX_METHOD_LENGTH

◆ CAT_MAX_URL_LENGTH

◆ CAT_MAX_USER_ID_LENGTH

◆ CAT_MEMORY_ERROR

◆ CAT_MUTEX_ERROR

◆ CAT_SUCCESS

◆ CAT_TIMER_ERROR

◆ CCL_APP_MAX_SCREEN_ID_LEN

◆ CCL_APP_MAX_SCREEN_NAME_LEN

◆ STR_MAX_LEN_1024

◆ STR_MAX_LEN_2048

◆ STR_MAX_LEN_8192

Typedef Documentation

◆ cat_anr_info_t

◆ cat_app_error_info_t

◆ cat_app_info_t

◆ cat_error_lang_t

◆ cat_network_request_info_t

◆ cat_screen_info_t

Enumeration Type Documentation

◆ cat_error_lang

Function Documentation

◆ cat_clear_all_custom_tags()

◆ cat_clear_custom_tags()

◆ cat_pause_tracker()

◆ cat_resume_tracker()

◆ cat_send_custom_event()

◆ cat_set_application_info()

◆ cat_set_custom_tags()

◆ cat_set_user_id()

◆ cat_track_anr()

◆ cat_track_app_install()

◆ cat_track_application_error()

◆ cat_track_network_request()

◆ cat_track_screen_view()