Liblinphone
5.3.0
|
Object defining all information related to a conference. More...
#include <conference_info.hh>
Public Types | |
enum | State { State::New = 0, State::Updated = 1, State::Cancelled = 2 } |
State is used to list all states of a conference info object More... | |
Public Member Functions | |
LINPHONECXX_PUBLIC | ConferenceInfo (void *ptr, bool takeRef=true) |
LINPHONECXX_PUBLIC _LinphoneConferenceInfo * | cPtr () |
LINPHONECXX_PUBLIC time_t | getDateTime () const |
Retrieve the date and time of the conference. More... | |
LINPHONECXX_PUBLIC void | setDateTime (time_t datetime) |
Set the date and time of the conference. More... | |
LINPHONECXX_PUBLIC std::string | getDescription () const |
Retrieve the description of the conference. More... | |
LINPHONECXX_PUBLIC void | setDescription (const std::string &description) |
Set the description of the conference. More... | |
LINPHONECXX_PUBLIC unsigned int | getDuration () const |
Retrieve the duration (in minutes) of the conference. More... | |
LINPHONECXX_PUBLIC void | setDuration (unsigned int duration) |
Set the duration (in minutes) of the conference. More... | |
LINPHONECXX_PUBLIC std::string | getIcalendarString () const |
Retrieve the conference as an Icalendar string. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > | getOrganizer () const |
Retrieve the organizer of the conference. More... | |
LINPHONECXX_PUBLIC void | setOrganizer (const std::shared_ptr< const linphone::Address > &organizer) |
Set the organizer of the conference. More... | |
LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::ParticipantInfo > > | getParticipantInfos () const |
Retrieve the list of participants as list of participant infos. More... | |
LINPHONECXX_PUBLIC void | setParticipantInfos (const std::list< std::shared_ptr< linphone::ParticipantInfo >> &participantInfos) |
Set the list of participants. More... | |
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::list< std::shared_ptr< linphone::Address > > | getParticipants () const |
Retrieve the list of participants as list of addresses. More... | |
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void | setParticipants (const std::list< std::shared_ptr< linphone::Address >> &participants) |
Set the list of participants. More... | |
LINPHONECXX_PUBLIC linphone::Conference::SecurityLevel | getSecurityLevel () const |
Retrieve the desired security level of the conference. More... | |
LINPHONECXX_PUBLIC void | setSecurityLevel (linphone::Conference::SecurityLevel securityLevel) |
Set the desired security level of the conference. More... | |
LINPHONECXX_PUBLIC State | getState () const |
Retrieve the state of the conference info. More... | |
LINPHONECXX_PUBLIC std::string | getSubject () const |
Retrieve the subject of the conference. More... | |
LINPHONECXX_PUBLIC void | setSubject (const std::string &subject) |
Set the subject of the conference. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > | getUri () const |
Retrieve the URI of the conference. More... | |
LINPHONECXX_PUBLIC void | addParticipant (const std::shared_ptr< const linphone::Address > &participant) |
Add a participant to the conference. More... | |
LINPHONECXX_PUBLIC void | addParticipant (const std::shared_ptr< const linphone::ParticipantInfo > &participantInfo) |
Add a participant to the conference. More... | |
LINPHONECXX_PUBLIC void | addParticipantInfos (const std::list< std::shared_ptr< linphone::ParticipantInfo >> &participantInfos) |
Add a list of participants. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ConferenceInfo > | clone () const |
Clone an object ConferenceInfo. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::ParticipantInfo > | findParticipant (const std::shared_ptr< const linphone::Address > &participant) |
Find a participant information in the conference information. More... | |
LINPHONECXX_PUBLIC void | removeParticipant (const std::shared_ptr< const linphone::Address > &participant) |
Remove a participant from the conference. More... | |
LINPHONECXX_PUBLIC void | updateParticipant (const std::shared_ptr< const linphone::ParticipantInfo > &participantInfo) |
Update the participant information in the conference informations. More... | |
Object defining all information related to a conference.
|
strong |
State is used to list all states of a conference info object
Enumerator | |
---|---|
New | New conference. |
Updated | Conference has been updated. |
Cancelled | Canceling a conference. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::addParticipant | ( | const std::shared_ptr< const linphone::Address > & | participant | ) |
Add a participant to the conference.
participant | The participant (Address) to add. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::addParticipant | ( | const std::shared_ptr< const linphone::ParticipantInfo > & | participantInfo | ) |
Add a participant to the conference.
participantInfo | The participant information (ParticipantInfo) to add. This method can be called to set attributes such as the role to the organizer of the conference |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::addParticipantInfos | ( | const std::list< std::shared_ptr< linphone::ParticipantInfo >> & | participantInfos | ) |
Add a list of participants.
participantInfos | The list of participant informations to add. |
LINPHONECXX_PUBLIC std::shared_ptr<linphone::ConferenceInfo> linphone::ConferenceInfo::clone | ( | ) | const |
Clone an object ConferenceInfo.
LINPHONECXX_PUBLIC std::shared_ptr<const linphone::ParticipantInfo> linphone::ConferenceInfo::findParticipant | ( | const std::shared_ptr< const linphone::Address > & | participant | ) |
Find a participant information in the conference information.
participant | The participant (Address) to search. |
LINPHONECXX_PUBLIC time_t linphone::ConferenceInfo::getDateTime | ( | ) | const |
Retrieve the date and time of the conference.
LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getDescription | ( | ) | const |
Retrieve the description of the conference.
LINPHONECXX_PUBLIC unsigned int linphone::ConferenceInfo::getDuration | ( | ) | const |
Retrieve the duration (in minutes) of the conference.
LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getIcalendarString | ( | ) | const |
Retrieve the conference as an Icalendar string.
LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> linphone::ConferenceInfo::getOrganizer | ( | ) | const |
Retrieve the organizer of the conference.
LINPHONECXX_PUBLIC std::list<std::shared_ptr<linphone::ParticipantInfo> > linphone::ConferenceInfo::getParticipantInfos | ( | ) | const |
Retrieve the list of participants as list of participant infos.
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::list<std::shared_ptr<linphone::Address> > linphone::ConferenceInfo::getParticipants | ( | ) | const |
Retrieve the list of participants as list of addresses.
LINPHONECXX_PUBLIC linphone::Conference::SecurityLevel linphone::ConferenceInfo::getSecurityLevel | ( | ) | const |
Retrieve the desired security level of the conference.
LINPHONECXX_PUBLIC State linphone::ConferenceInfo::getState | ( | ) | const |
Retrieve the state of the conference info.
LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getSubject | ( | ) | const |
Retrieve the subject of the conference.
LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> linphone::ConferenceInfo::getUri | ( | ) | const |
Retrieve the URI of the conference.
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::removeParticipant | ( | const std::shared_ptr< const linphone::Address > & | participant | ) |
Remove a participant from the conference.
participant | The participant (Address) to remove. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDateTime | ( | time_t | datetime | ) |
Set the date and time of the conference.
datetime | The date and time of the conference. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDescription | ( | const std::string & | description | ) |
Set the description of the conference.
description | The description of the conference. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDuration | ( | unsigned int | duration | ) |
Set the duration (in minutes) of the conference.
duration | The duration of the conference. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setOrganizer | ( | const std::shared_ptr< const linphone::Address > & | organizer | ) |
Set the organizer of the conference.
organizer | The Address of the conference's organizer. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setParticipantInfos | ( | const std::list< std::shared_ptr< linphone::ParticipantInfo >> & | participantInfos | ) |
Set the list of participants.
participantInfos | The list of participant informations to set. |
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ConferenceInfo::setParticipants | ( | const std::list< std::shared_ptr< linphone::Address >> & | participants | ) |
Set the list of participants.
participants | The list of participants to set. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setSecurityLevel | ( | linphone::Conference::SecurityLevel | securityLevel | ) |
Set the desired security level of the conference.
securityLevel | The desired security level of the conference. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setSubject | ( | const std::string & | subject | ) |
Set the subject of the conference.
subject | The subject of the conference. |
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::updateParticipant | ( | const std::shared_ptr< const linphone::ParticipantInfo > & | participantInfo | ) |
Update the participant information in the conference informations.
participantInfo | The participant information (ParticipantInfo) to update. This method can be called to change attributes such as the role to the organizer of the conference |