/*
|
* Copyright (c) 2010-2019 Belledonne Communications SARL.
|
*
|
* This file is part of Liblinphone.
|
*
|
* This program is free software: you can redistribute it and/or modify
|
* it under the terms of the GNU General Public License as published by
|
* the Free Software Foundation, either version 3 of the License, or
|
* (at your option) any later version.
|
*
|
* This program is distributed in the hope that it will be useful,
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
* GNU General Public License for more details.
|
*
|
* You should have received a copy of the GNU General Public License
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
*/
|
|
#ifndef _L_C_EVENT_LOG_H_
|
#define _L_C_EVENT_LOG_H_
|
|
#include "linphone/api/c-types.h"
|
|
// =============================================================================
|
|
#ifdef __cplusplus
|
extern "C" {
|
#endif // ifdef __cplusplus
|
|
/**
|
* @addtogroup events
|
* @{
|
*/
|
|
// -----------------------------------------------------------------------------
|
// EventLog.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Increment reference count of #LinphoneEventLog object.
|
**/
|
LINPHONE_PUBLIC LinphoneEventLog *linphone_event_log_ref (LinphoneEventLog *event_log);
|
|
/**
|
* Decrement reference count of #LinphoneEventLog object. When dropped to zero, memory is freed.
|
**/
|
LINPHONE_PUBLIC void linphone_event_log_unref (LinphoneEventLog *event_log);
|
|
/**
|
* Returns the type of a event log.
|
* @param[in] event_log A #LinphoneEventLog object
|
* @return The event type
|
*/
|
LINPHONE_PUBLIC LinphoneEventLogType linphone_event_log_get_type (const LinphoneEventLog *event_log);
|
|
/**
|
* Returns the creation time of a event log.
|
* @param[in] event_log A #LinphoneEventLog object
|
* @return The event creation time
|
*/
|
LINPHONE_PUBLIC time_t linphone_event_log_get_creation_time (const LinphoneEventLog *event_log);
|
|
/**
|
* Delete event log from database.
|
* @param[in] event_log A #LinphoneEventLog object
|
*/
|
LINPHONE_PUBLIC void linphone_event_log_delete_from_database (LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Returns the peer address of a conference event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The peer address.
|
*/
|
LINPHONE_PUBLIC const LinphoneAddress *linphone_event_log_get_peer_address (const LinphoneEventLog *event_log);
|
|
/**
|
* Returns the local address of a conference event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The local address.
|
*/
|
LINPHONE_PUBLIC const LinphoneAddress *linphone_event_log_get_local_address (const LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceNotifiedEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Returns the notify id of a conference notified event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The conference notify id.
|
*/
|
LINPHONE_PUBLIC unsigned int linphone_event_log_get_notify_id (const LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceCallEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Returns the call of a conference call event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The conference call.
|
*/
|
LINPHONE_PUBLIC LinphoneCall *linphone_event_log_get_call (const LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceChatMessageEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Returns the chat message of a conference chat message event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The conference chat message.
|
*/
|
LINPHONE_PUBLIC LinphoneChatMessage *linphone_event_log_get_chat_message (const LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceParticipantEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Returns the participant address of a conference participant event.
|
* @param[in] event_log A ConferenceParticipantEvent object.
|
* @return The conference participant address.
|
*/
|
LINPHONE_PUBLIC const LinphoneAddress *linphone_event_log_get_participant_address (const LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceParticipantDeviceEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Returns the device address of a conference participant device event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The conference device address.
|
*/
|
LINPHONE_PUBLIC const LinphoneAddress *linphone_event_log_get_device_address (const LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceSecurityEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Returns the type of security event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The security event type.
|
*/
|
LINPHONE_PUBLIC LinphoneSecurityEventType linphone_event_log_get_security_event_type (const LinphoneEventLog *event_log);
|
|
/**
|
* Returns the faulty device address of a conference security event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The address of the faulty device.
|
*/
|
LINPHONE_PUBLIC LinphoneAddress *linphone_event_log_get_security_event_faulty_device_address (const LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceSubjectEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* Returns the subject of a conference subject event.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The conference subject.
|
*/
|
LINPHONE_PUBLIC const char *linphone_event_log_get_subject (const LinphoneEventLog *event_log);
|
|
// -----------------------------------------------------------------------------
|
// ConferenceEphemeralMessageEvent.
|
// -----------------------------------------------------------------------------
|
|
/**
|
* 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.
|
* @param[in] event_log A #LinphoneEventLog object.
|
* @return The ephemeral message lifetime.
|
*/
|
LINPHONE_PUBLIC long linphone_event_log_get_ephemeral_message_lifetime (const LinphoneEventLog *event_log);
|
/**
|
* @}
|
*/
|
|
#ifdef __cplusplus
|
}
|
#endif // ifdef __cplusplus
|
|
#endif // ifndef _L_C_EVENT_LOG_H_
|
