Liblinphone  5.1.0
Typedefs | Enumerations | Functions
Events

Typedefs

typedef struct _LinphoneEventLog LinphoneEventLog
 Object that represents an event that must be stored in database. More...
 
typedef enum _EventLogType LinphoneEventLogType
 LinphoneEventLogType is used to indicate the type of an event. More...
 
typedef enum _SecurityEventType LinphoneSecurityEventType
 LinphoneSecurityEventType is used to indicate the type of security event.
 

Enumerations

enum  _EventLogType {
  LinphoneEventLogTypeNone = 0,
  LinphoneEventLogTypeConferenceCreated = 1,
  LinphoneEventLogTypeConferenceTerminated = 2,
  LinphoneEventLogTypeConferenceCallStart = 3,
  LinphoneEventLogTypeConferenceCallEnd = 4,
  LinphoneEventLogTypeConferenceChatMessage = 5,
  LinphoneEventLogTypeConferenceParticipantAdded = 6,
  LinphoneEventLogTypeConferenceParticipantRemoved = 7,
  LinphoneEventLogTypeConferenceParticipantSetAdmin = 8,
  LinphoneEventLogTypeConferenceParticipantUnsetAdmin = 9,
  LinphoneEventLogTypeConferenceParticipantDeviceAdded = 10,
  LinphoneEventLogTypeConferenceParticipantDeviceRemoved = 11,
  LinphoneEventLogTypeConferenceParticipantDeviceMediaChanged = 17,
  LinphoneEventLogTypeConferenceSubjectChanged = 12,
  LinphoneEventLogTypeConferenceAvailableMediaChanged = 18,
  LinphoneEventLogTypeConferenceSecurityEvent = 13,
  LinphoneEventLogTypeConferenceEphemeralMessageLifetimeChanged = 14,
  LinphoneEventLogTypeConferenceEphemeralMessageEnabled = 15,
  LinphoneEventLogTypeConferenceEphemeralMessageDisabled = 16,
  LinphoneEventLogTypeConferenceEphemeralMessageManagedByAdmin = 19,
  LinphoneEventLogTypeConferenceEphemeralMessageManagedByParticipants = 20
}
 LinphoneEventLogType is used to indicate the type of an event. More...
 
enum  _SecurityEventType {
  LinphoneSecurityEventTypeNone = 0,
  LinphoneSecurityEventTypeSecurityLevelDowngraded = 1,
  LinphoneSecurityEventTypeParticipantMaxDeviceCountExceeded = 2,
  LinphoneSecurityEventTypeEncryptionIdentityKeyChanged = 3,
  LinphoneSecurityEventTypeManInTheMiddleDetected = 4
}
 LinphoneSecurityEventType is used to indicate the type of security event. More...
 

Functions

LinphoneEventLoglinphone_event_log_ref (LinphoneEventLog *event_log)
 Increment reference count of LinphoneEventLog object. More...
 
void linphone_event_log_unref (LinphoneEventLog *event_log)
 Decrement reference count of LinphoneEventLog object. More...
 
LinphoneEventLogType linphone_event_log_get_type (const LinphoneEventLog *event_log)
 Returns the type of a event log. More...
 
time_t linphone_event_log_get_creation_time (const LinphoneEventLog *event_log)
 Returns the creation time of a event log. More...
 
void linphone_event_log_delete_from_database (LinphoneEventLog *event_log)
 Delete event log from database. More...
 
const LinphoneAddresslinphone_event_log_get_peer_address (const LinphoneEventLog *event_log)
 Returns the peer address of a conference event. More...
 
const LinphoneAddresslinphone_event_log_get_local_address (const LinphoneEventLog *event_log)
 Returns the local address of a conference event. More...
 
unsigned int linphone_event_log_get_notify_id (const LinphoneEventLog *event_log)
 Returns the notify id of a conference notified event. More...
 
LinphoneCalllinphone_event_log_get_call (const LinphoneEventLog *event_log)
 Returns the call of a conference call event. More...
 
LinphoneChatMessagelinphone_event_log_get_chat_message (const LinphoneEventLog *event_log)
 Returns the chat message of a conference chat message event. More...
 
const LinphoneAddresslinphone_event_log_get_participant_address (const LinphoneEventLog *event_log)
 Returns the participant address of a conference participant event. More...
 
const LinphoneAddresslinphone_event_log_get_device_address (const LinphoneEventLog *event_log)
 Returns the device address of a conference participant device event. More...
 
LinphoneSecurityEventType linphone_event_log_get_security_event_type (const LinphoneEventLog *event_log)
 Returns the type of security event. More...
 
LinphoneAddresslinphone_event_log_get_security_event_faulty_device_address (const LinphoneEventLog *event_log)
 Returns the faulty device address of a conference security event. More...
 
const char * linphone_event_log_get_subject (const LinphoneEventLog *event_log)
 Returns the subject of a conference subject event. More...
 
long linphone_event_log_get_ephemeral_message_lifetime (const LinphoneEventLog *event_log)
 Returns the ephemeral message lifetime of a conference ephemeral message event. More...
 

Detailed Description

Typedef Documentation

◆ LinphoneEventLog

typedef struct _LinphoneEventLog LinphoneEventLog

Object that represents an event that must be stored in database.

For example, all chat related events are wrapped in an LinphoneEventLog, and many callbacks use this kind of type as parameter.

Use linphone_event_log_get_type() to get the LinphoneEventLogType it refers to, and then you can use one of the accessor methods to get the underlying object, for example linphone_event_log_get_chat_message() for a LinphoneChatMessage.

◆ LinphoneEventLogType

LinphoneEventLogType is used to indicate the type of an event.

Useful for cast.

Enumeration Type Documentation

◆ _EventLogType

LinphoneEventLogType is used to indicate the type of an event.

Useful for cast.

Enumerator
LinphoneEventLogTypeNone 

No defined event.

LinphoneEventLogTypeConferenceCreated 

Conference (created) event.

LinphoneEventLogTypeConferenceTerminated 

Conference (terminated) event.

LinphoneEventLogTypeConferenceCallStart 

Conference call (start) event.

LinphoneEventLogTypeConferenceCallEnd 

Conference call (end) event.

LinphoneEventLogTypeConferenceChatMessage 

Conference chat message event.

LinphoneEventLogTypeConferenceParticipantAdded 

Conference participant (added) event.

LinphoneEventLogTypeConferenceParticipantRemoved 

Conference participant (removed) event.

LinphoneEventLogTypeConferenceParticipantSetAdmin 

Conference participant (set admin) event.

LinphoneEventLogTypeConferenceParticipantUnsetAdmin 

Conference participant (unset admin) event.

LinphoneEventLogTypeConferenceParticipantDeviceAdded 

Conference participant device (added) event.

LinphoneEventLogTypeConferenceParticipantDeviceRemoved 

Conference participant device (removed) event.

LinphoneEventLogTypeConferenceParticipantDeviceMediaChanged 

Conference participant device (media changed) event.

LinphoneEventLogTypeConferenceSubjectChanged 

Conference subject event.

LinphoneEventLogTypeConferenceAvailableMediaChanged 

Conference available media event.

LinphoneEventLogTypeConferenceSecurityEvent 

Conference encryption security event.

LinphoneEventLogTypeConferenceEphemeralMessageLifetimeChanged 

Conference ephemeral message (ephemeral message lifetime changed) event.

LinphoneEventLogTypeConferenceEphemeralMessageEnabled 

Conference ephemeral message (ephemeral message enabled) event.

LinphoneEventLogTypeConferenceEphemeralMessageDisabled 

Conference ephemeral message (ephemeral message disabled) event.

LinphoneEventLogTypeConferenceEphemeralMessageManagedByAdmin 

Conference ephemeral message (ephemeral message settings managed by admin) event.

LinphoneEventLogTypeConferenceEphemeralMessageManagedByParticipants 

Conference ephemeral message (ephemeral message settings managed by participants) event.

◆ _SecurityEventType

LinphoneSecurityEventType is used to indicate the type of security event.

Enumerator
LinphoneSecurityEventTypeNone 

Event is not a security event.

LinphoneSecurityEventTypeSecurityLevelDowngraded 

Chatroom security level downgraded event.

LinphoneSecurityEventTypeParticipantMaxDeviceCountExceeded 

Participant has exceeded the maximum number of device event.

LinphoneSecurityEventTypeEncryptionIdentityKeyChanged 

Peer device instant messaging encryption identity key has changed event.

LinphoneSecurityEventTypeManInTheMiddleDetected 

Man in the middle detected event.

Function Documentation

◆ linphone_event_log_delete_from_database()

void linphone_event_log_delete_from_database ( LinphoneEventLog event_log)

Delete event log from database.

Parameters
event_logA LinphoneEventLog object

◆ linphone_event_log_get_call()

LinphoneCall* linphone_event_log_get_call ( const LinphoneEventLog event_log)

Returns the call of a conference call event.

Parameters
event_logA LinphoneEventLog object.
Returns
The conference LinphoneCall.

◆ linphone_event_log_get_chat_message()

LinphoneChatMessage* linphone_event_log_get_chat_message ( const LinphoneEventLog event_log)

Returns the chat message of a conference chat message event.

Parameters
event_logA LinphoneEventLog object.
Returns
The conference LinphoneChatMessage.

◆ linphone_event_log_get_creation_time()

time_t linphone_event_log_get_creation_time ( const LinphoneEventLog event_log)

Returns the creation time of a event log.

Parameters
event_logA LinphoneEventLog object
Returns
The event creation time

◆ linphone_event_log_get_device_address()

const LinphoneAddress* linphone_event_log_get_device_address ( const LinphoneEventLog event_log)

Returns the device address of a conference participant device event.

Parameters
event_logA LinphoneEventLog object.
Returns
The conference device LinphoneAddress.

◆ linphone_event_log_get_ephemeral_message_lifetime()

long linphone_event_log_get_ephemeral_message_lifetime ( const LinphoneEventLog event_log)

Returns the ephemeral message lifetime of a conference ephemeral message event.

Ephemeral lifetime means the time before an ephemeral message which has been viewed gets deleted.

Parameters
event_logA LinphoneEventLog object.
Returns
The ephemeral message lifetime.

◆ linphone_event_log_get_local_address()

const LinphoneAddress* linphone_event_log_get_local_address ( const LinphoneEventLog event_log)

Returns the local address of a conference event.

Parameters
event_logA LinphoneEventLog object.
Returns
The local LinphoneAddress.

◆ linphone_event_log_get_notify_id()

unsigned int linphone_event_log_get_notify_id ( const LinphoneEventLog event_log)

Returns the notify id of a conference notified event.

Parameters
event_logA LinphoneEventLog object.
Returns
The conference notify id.

◆ linphone_event_log_get_participant_address()

const LinphoneAddress* linphone_event_log_get_participant_address ( const LinphoneEventLog event_log)

Returns the participant address of a conference participant event.

Parameters
event_logA ConferenceParticipantEvent object.
Returns
The conference participant LinphoneAddress.

◆ linphone_event_log_get_peer_address()

const LinphoneAddress* linphone_event_log_get_peer_address ( const LinphoneEventLog event_log)

Returns the peer address of a conference event.

Parameters
event_logA LinphoneEventLog object.
Returns
The peer LinphoneAddress.

◆ linphone_event_log_get_security_event_faulty_device_address()

LinphoneAddress* linphone_event_log_get_security_event_faulty_device_address ( const LinphoneEventLog event_log)

Returns the faulty device address of a conference security event.

Parameters
event_logA LinphoneEventLog object.
Returns
The LinphoneAddress of the faulty device.

◆ linphone_event_log_get_security_event_type()

LinphoneSecurityEventType linphone_event_log_get_security_event_type ( const LinphoneEventLog event_log)

Returns the type of security event.

Parameters
event_logA LinphoneEventLog object.
Returns
The LinphoneSecurityEventType type.

◆ linphone_event_log_get_subject()

const char* linphone_event_log_get_subject ( const LinphoneEventLog event_log)

Returns the subject of a conference subject event.

Parameters
event_logA LinphoneEventLog object.
Returns
The conference subject.

◆ linphone_event_log_get_type()

LinphoneEventLogType linphone_event_log_get_type ( const LinphoneEventLog event_log)

Returns the type of a event log.

Parameters
event_logA LinphoneEventLog object
Returns
The LinphoneEventLogType type

◆ linphone_event_log_ref()

LinphoneEventLog* linphone_event_log_ref ( LinphoneEventLog event_log)

Increment reference count of LinphoneEventLog object.

Parameters
event_logA LinphoneEventLog object
Returns
the same LinphoneEventLog object

◆ linphone_event_log_unref()

void linphone_event_log_unref ( LinphoneEventLog event_log)

Decrement reference count of LinphoneEventLog object.

When dropped to zero, memory is freed.

Parameters
event_logA LinphoneEventLog object