Managing call logs

Macros
#define	linphone_call_log_get_from(cl)   linphone_call_log_get_from_address(cl)
#define	linphone_call_log_get_to(cl)   linphone_call_log_get_to_address(cl)
#define	linphone_call_log_set_user_pointer(cl, ud)   linphone_call_log_set_user_data(cl, ud)
#define	linphone_call_log_get_user_pointer(cl)   linphone_call_log_get_user_data(cl)

Typedefs
typedef enum _LinphoneCallDir	LinphoneCallDir
typedef struct _LinphoneCallLog	LinphoneCallLog
typedef enum _LinphoneCallStatus	LinphoneCallStatus

Enumerations
enum	_LinphoneCallDir {   LinphoneCallOutgoing,   LinphoneCallIncoming }
enum	_LinphoneCallStatus {   LinphoneCallSuccess,   LinphoneCallAborted,   LinphoneCallMissed,   LinphoneCallDeclined }

Functions
const char *	linphone_call_log_get_call_id (const LinphoneCallLog *cl)
LinphoneCallDir	linphone_call_log_get_dir (LinphoneCallLog *cl)
int	linphone_call_log_get_duration (LinphoneCallLog *cl)
LinphoneAddress *	linphone_call_log_get_from_address (LinphoneCallLog *cl)
const rtp_stats_t *	linphone_call_log_get_local_stats (const LinphoneCallLog *cl)
float	linphone_call_log_get_quality (LinphoneCallLog *cl)
const char *	linphone_call_log_get_ref_key (const LinphoneCallLog *cl)
LinphoneAddress *	linphone_call_log_get_remote_address (LinphoneCallLog *cl)
const rtp_stats_t *	linphone_call_log_get_remote_stats (const LinphoneCallLog *cl)
time_t	linphone_call_log_get_start_date (LinphoneCallLog *cl)
LinphoneCallStatus	linphone_call_log_get_status (LinphoneCallLog *cl)
LinphoneAddress *	linphone_call_log_get_to_address (LinphoneCallLog *cl)
void	linphone_call_log_set_ref_key (LinphoneCallLog *cl, const char *refkey)
bool_t	linphone_call_log_video_enabled (LinphoneCallLog *cl)
char *	linphone_call_log_to_str (LinphoneCallLog *cl)
bool_t	linphone_call_log_was_conference (LinphoneCallLog *cl)
void *	linphone_call_log_get_user_data (const LinphoneCallLog *cl)
void	linphone_call_log_set_user_data (LinphoneCallLog *cl, void *ud)
LinphoneCallLog *	linphone_call_log_ref (LinphoneCallLog *cl)
void	linphone_call_log_unref (LinphoneCallLog *cl)
void	linphone_call_log_destroy (LinphoneCallLog *cl)
const bctbx_list_t *	linphone_core_get_call_logs (LinphoneCore *lc)
bctbx_list_t *	linphone_core_get_call_history_for_address (LinphoneCore *lc, const LinphoneAddress *addr)
LinphoneCallLog *	linphone_core_get_last_outgoing_call_log (LinphoneCore *lc)
LinphoneCallLog *	linphone_core_find_call_log_from_call_id (LinphoneCore *lc, const char *call_id)
void	linphone_core_clear_call_logs (LinphoneCore *lc)
int	linphone_core_get_missed_calls_count (LinphoneCore *lc)
void	linphone_core_reset_missed_calls_count (LinphoneCore *lc)
void	linphone_core_remove_call_log (LinphoneCore *lc, LinphoneCallLog *call_log)

Detailed Description

Macro Definition Documentation

linphone_call_log_get_from

#define linphone_call_log_get_from

(

cl

)

linphone_call_log_get_from_address(cl)

Deprecated:

Use linphone_call_log_get_from_address() instead.

linphone_call_log_get_to

#define linphone_call_log_get_to

(

cl

)

linphone_call_log_get_to_address(cl)

Deprecated:

Use linphone_call_log_get_to_address() instead.

linphone_call_log_get_user_pointer

#define linphone_call_log_get_user_pointer

(

cl

)

linphone_call_log_get_user_data(cl)

Deprecated:

Use linphone_call_log_get_user_data() instead.

linphone_call_log_set_user_pointer

#define linphone_call_log_set_user_pointer	(		cl,
			ud
	)		linphone_call_log_set_user_data(cl, ud)

Deprecated:

Use linphone_call_log_set_user_data() instead.

Typedef Documentation

LinphoneCallDir

typedef enum _LinphoneCallDir LinphoneCallDir

Enum representing the direction of a call.

LinphoneCallLog

typedef struct _LinphoneCallLog LinphoneCallLog

Structure representing a call log.

LinphoneCallStatus

typedef enum _LinphoneCallStatus LinphoneCallStatus

Enum representing the status of a call

Enumeration Type Documentation

_LinphoneCallDir

enum _LinphoneCallDir

Enum representing the direction of a call.

Enumerator
LinphoneCallOutgoing	outgoing calls
LinphoneCallIncoming	incoming calls

_LinphoneCallStatus

enum _LinphoneCallStatus

Enum representing the status of a call

Enumerator
LinphoneCallSuccess	The call was sucessful
LinphoneCallAborted	The call was aborted
LinphoneCallMissed	The call was missed (unanswered)
LinphoneCallDeclined	The call was declined, either locally or by remote end

Function Documentation

linphone_call_log_destroy()

void linphone_call_log_destroy

(

LinphoneCallLog *

cl

)

Destroy a LinphoneCallLog.

Parameters

cl	LinphoneCallLog object

Deprecated:

Use linphone_call_log_unref() instead.

linphone_call_log_get_call_id()

const char* linphone_call_log_get_call_id

(

const LinphoneCallLog *

cl

)

Get the call ID used by the call.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The call ID used by the call as a string.

linphone_call_log_get_dir()

LinphoneCallDir linphone_call_log_get_dir

(

LinphoneCallLog *

cl

)

Get the direction of the call.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The direction of the call.

linphone_call_log_get_duration()

int linphone_call_log_get_duration

(

LinphoneCallLog *

cl

)

Get the duration of the call since connected.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The duration of the call in seconds.

linphone_call_log_get_from_address()

LinphoneAddress* linphone_call_log_get_from_address

(

LinphoneCallLog *

cl

)

Get the origin address (ie from) of the call.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The origin address (ie from) of the call.

linphone_call_log_get_local_stats()

const rtp_stats_t* linphone_call_log_get_local_stats

(

const LinphoneCallLog *

cl

)

Get the RTP statistics computed locally regarding the call.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The RTP statistics that have been computed locally for the call.

linphone_call_log_get_quality()

float linphone_call_log_get_quality

(

LinphoneCallLog *

cl

)

Get the overall quality indication of the call.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The overall quality indication of the call.

linphone_call_log_get_ref_key()

const char* linphone_call_log_get_ref_key

(

const LinphoneCallLog *

cl

)

Get the persistent reference key associated to the call log.

The reference key can be for example an id to an external database. It is stored in the config file, thus can survive to process exits/restarts.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The reference key string that has been associated to the call log, or NULL if none has been associated.

linphone_call_log_get_remote_address()

LinphoneAddress* linphone_call_log_get_remote_address

(

LinphoneCallLog *

cl

)

Get the remote address (that is from or to depending on call direction).

Parameters

[in]

cl

LinphoneCallLog object

Returns

The remote address of the call.

linphone_call_log_get_remote_stats()

const rtp_stats_t* linphone_call_log_get_remote_stats

(

const LinphoneCallLog *

cl

)

Get the RTP statistics computed by the remote end and sent back via RTCP.

Note

Not implemented yet.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The RTP statistics that have been computed by the remote end for the call.

linphone_call_log_get_start_date()

time_t linphone_call_log_get_start_date

(

LinphoneCallLog *

cl

)

Get the start date of the call.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The date of the beginning of the call.

linphone_call_log_get_status()

LinphoneCallStatus linphone_call_log_get_status

(

LinphoneCallLog *

cl

)

Get the status of the call.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The status of the call.

linphone_call_log_get_to_address()

LinphoneAddress* linphone_call_log_get_to_address

(

LinphoneCallLog *

cl

)

Get the destination address (ie to) of the call.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The destination address (ie to) of the call.

linphone_call_log_get_user_data()

void* linphone_call_log_get_user_data

(

const LinphoneCallLog *

cl

)

Get the user data associated with the call log.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The user data associated with the call log.

linphone_call_log_ref()

LinphoneCallLog* linphone_call_log_ref

(

LinphoneCallLog *

cl

)

Acquire a reference to the call log.

Parameters

[in]

cl

LinphoneCallLog object

Returns

The same LinphoneCallLog object

linphone_call_log_set_ref_key()

void linphone_call_log_set_ref_key	(	LinphoneCallLog *	cl,
		const char *	refkey
	)

Associate a persistent reference key to the call log.

The reference key can be for example an id to an external database. It is stored in the config file, thus can survive to process exits/restarts.

Parameters

[in]	cl	LinphoneCallLog object
[in]	refkey	The reference key string to associate to the call log.

linphone_call_log_set_user_data()

void linphone_call_log_set_user_data	(	LinphoneCallLog *	cl,
		void *	ud
	)

Assign a user data to the call log.

Parameters

[in]	cl	LinphoneCallLog object
[in]	ud	The user data to associate with the call log.

linphone_call_log_to_str()

char* linphone_call_log_to_str

(

LinphoneCallLog *

cl

)

Get a human readable string describing the call.

Note

: the returned string must be freed by the application (use ms_free()).

Parameters

[in]

cl

LinphoneCallLog object

Returns

A human readable string describing the call.

linphone_call_log_unref()

void linphone_call_log_unref

(

LinphoneCallLog *

cl

)

Release a reference to the call log.

Parameters

[in]

cl

LinphoneCallLog object

linphone_call_log_video_enabled()

bool_t linphone_call_log_video_enabled

(

LinphoneCallLog *

cl

)

Tell whether video was enabled at the end of the call or not.

Parameters

[in]

cl

LinphoneCallLog object

Returns

A boolean value telling whether video was enabled at the end of the call.

linphone_call_log_was_conference()

bool_t linphone_call_log_was_conference

(

LinphoneCallLog *

cl

)

Tells whether that call was a call to a conference server

Parameters

[in]

cl

LinphoneCallLog object

Returns

TRUE if the call was a call to a conference server

linphone_core_clear_call_logs()

void linphone_core_clear_call_logs

(

LinphoneCore *

lc

)

Erase the call log.

Parameters

[in]

lc

LinphoneCore object

linphone_core_find_call_log_from_call_id()

LinphoneCallLog* linphone_core_find_call_log_from_call_id	(	LinphoneCore *	lc,
		const char *	call_id
	)

Get the call log matching the call id, or NULL if can't be found.

Parameters

[in]	lc	LinphoneCore object
[in]	call_id	Call id of the call log to find

Returns

{LinphoneCallLog}

linphone_core_get_call_history_for_address()

bctbx_list_t* linphone_core_get_call_history_for_address	(	LinphoneCore *	lc,
		const LinphoneAddress *	addr
	)

Get the list of call logs (past calls) that matches the given LinphoneAddress. At the contrary of linphone_core_get_call_logs, it is your responsibility to unref the logs and free this list once you are done using it.

Parameters

[in]	lc	LinphoneCore object
[in]	addr	LinphoneAddress object

Returns

A list of LinphoneCallLog objects.

linphone_core_get_call_logs()

const bctbx_list_t* linphone_core_get_call_logs

(

LinphoneCore *

lc

)

Get the list of call logs (past calls).

Parameters

[in]

lc

LinphoneCore object

Returns

A list of LinphoneCallLog objects.

linphone_core_get_last_outgoing_call_log()

LinphoneCallLog* linphone_core_get_last_outgoing_call_log

(

LinphoneCore *

lc

)

Get the latest outgoing call log.

Parameters

[in]

lc

LinphoneCore object

Returns

{LinphoneCallLog}

linphone_core_get_missed_calls_count()

int linphone_core_get_missed_calls_count

(

LinphoneCore *

lc

)

Get the number of missed calls. Once checked, this counter can be reset with linphone_core_reset_missed_calls_count().

Parameters

[in]

lc

LinphoneCore object.

Returns

The number of missed calls.

linphone_core_remove_call_log()

void linphone_core_remove_call_log	(	LinphoneCore *	lc,
		LinphoneCallLog *	call_log
	)

Remove a specific call log from call history list. This function destroys the call log object. It must not be accessed anymore by the application after calling this function.

Parameters

[in]	lc	LinphoneCore object
[in]	call_log	LinphoneCallLog object to remove.

linphone_core_reset_missed_calls_count()

void linphone_core_reset_missed_calls_count

(

LinphoneCore *

lc

)

Reset the counter of missed calls.

Parameters

[in]

lc

LinphoneCore object.