Liblinphone  5.5.0
Linphone.CallLog Class Reference
Inheritance diagram for Linphone.CallLog:
Linphone.LinphoneObject

Public Member Functions

string ToStr ()
 
bool WasConference ()
 

Properties

string CallId [get]
 
Linphone.ChatRoom ChatRoom [get]
 
Linphone.ConferenceInfo ConferenceInfo [get]
 
Linphone.CallDir Dir [get]
 
int Duration [get]
 
Linphone.ErrorInfo ErrorInfo [get]
 
Linphone.Address FromAddress [get]
 
Linphone.Address LocalAddress [get]
 
float Quality [get]
 
string RefKey [get, set]
 
Linphone.Address RemoteAddress [get, set]
 
long StartDate [get]
 
Linphone.CallStatus Status [get]
 
Linphone.Address ToAddress [get]
 
bool VideoEnabled [get]
 

Additional Inherited Members

- Protected Member Functions inherited from Linphone.LinphoneObject
static String linphone_pointer_to_string (IntPtr ptr)
 
static IntPtr linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
 
IntPtr StringArrayToBctbxList (IEnumerable< string > stringlist)
 
void CleanStringArrayPtrs (IntPtr l)
 

Detailed Description

Object used to keep track of all calls initiated, received or missed.

It contains the call ID, date & time at which the call took place and it's duration (0 if it wasn't answered). You can also know if video was enabled or not or if it was a conference, as well as it's average quality. If needed, you can also create a fake Linphone.CallLog using Linphone.Core.CreateCallLog(), otherwise use Linphone.Core.CallLogs or even Linphone.Call.CallLog to get the log of an ongoing call.

Member Function Documentation

string Linphone.CallLog.ToStr ( )
inline

Gets a human readable string describing the call.

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

Returns
A human readable string describing the call.
bool Linphone.CallLog.WasConference ( )
inline

Tells whether that call was part of a conference.

Returns
true if the call was part of a conference, false otherwise.

Property Documentation

string Linphone.CallLog.CallId
get

Gets the call ID used by the call.

Returns
The call ID used by the call as a string.
Linphone.ChatRoom Linphone.CallLog.ChatRoom
get

Returns the chat room associated with this call-log, if any.

This method is typically useful in order to retrieve an IM conversation associated with a past conference call.

Returns
The Linphone.ChatRoom associated.
Linphone.ConferenceInfo Linphone.CallLog.ConferenceInfo
get

Retrieves the conference info associated to this call log in DB.

Returns
The Linphone.ConferenceInfo associated.
Linphone.CallDir Linphone.CallLog.Dir
get

Gets the direction of the call.

Returns
The Linphone.CallDir of the call.
int Linphone.CallLog.Duration
get

Gets the duration of the call since it was connected.

Returns
The duration of the call in seconds.
Linphone.ErrorInfo Linphone.CallLog.ErrorInfo
get

When the call was failed, return an object describing the failure.

Returns
Linphone.ErrorInfo about the error encountered by the call associated with this call log or null.
Linphone.Address Linphone.CallLog.FromAddress
get

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

Returns
The origin Linphone.Address (ie from) of the call.
Linphone.Address Linphone.CallLog.LocalAddress
get

Gets the local address (that is from or to depending on call direction)

Returns
The local Linphone.Address of the call
float Linphone.CallLog.Quality
get

Gets the overall quality indication of the call.

See : Linphone.Call.CurrentQuality

Returns
The overall quality indication of the call.
string Linphone.CallLog.RefKey
getset

Gets 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.

Returns
The reference key string that has been associated to the call log, or null if none has been associated.
Linphone.Address Linphone.CallLog.RemoteAddress
getset

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

Returns
The remote Linphone.Address of the call.
long Linphone.CallLog.StartDate
get

Gets the start date of the call.

Returns
The date of the beginning of the call.
Linphone.CallStatus Linphone.CallLog.Status
get

Gets the status of the call.

Returns
The Linphone.CallStatus of the call.
Linphone.Address Linphone.CallLog.ToAddress
get

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

Returns
The destination Linphone.Address (ie to) of the call.
bool Linphone.CallLog.VideoEnabled
get

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

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

The documentation for this class was generated from the following file: