Liblinphone  5.1.0
Public Member Functions | List of all members
linphone::ConferenceInfo Class Reference

Object defining all informations of a conference. More...

#include <conference_info.hh>

Inheritance diagram for linphone::ConferenceInfo:

Public Member Functions

 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 int getDuration () const
 Retrieve the duration (in minutes) of the conference. More...
 
LINPHONECXX_PUBLIC void setDuration (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::AddressgetOrganizer () const
 Retrieve the organizer of the conference. More...
 
LINPHONECXX_PUBLIC void setOrganizer (const std::shared_ptr< linphone::Address > &organizer)
 Set the organizer of the conference. More...
 
LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::Address > > getParticipants () const
 Retrieve the list of participants. More...
 
LINPHONECXX_PUBLIC void setParticipants (const std::list< std::shared_ptr< linphone::Address >> &participants)
 Set the list of participants. 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::AddressgetUri () const
 Retrieve the URI of the conference. More...
 
LINPHONECXX_PUBLIC void setUri (const std::shared_ptr< linphone::Address > &uri)
 Set the URI of the conference. More...
 
LINPHONECXX_PUBLIC void addParticipant (const std::shared_ptr< linphone::Address > &participant)
 Add a participant to the conference. More...
 

Detailed Description

Object defining all informations of a conference.

Member Function Documentation

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::addParticipant ( const std::shared_ptr< linphone::Address > &  participant)

Add a participant to the conference.

Parameters
participantThe participant (Address) to add.
LINPHONECXX_PUBLIC time_t linphone::ConferenceInfo::getDateTime ( ) const

Retrieve the date and time of the conference.

Returns
The date and time of the conference.
LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getDescription ( ) const

Retrieve the description of the conference.

Returns
The description of the conference.
LINPHONECXX_PUBLIC int linphone::ConferenceInfo::getDuration ( ) const

Retrieve the duration (in minutes) of the conference.

Returns
The duration of the conference.
LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getIcalendarString ( ) const

Retrieve the conference as an Icalendar string.

Returns
The conference as an Icalendar string. The returned char* must be freed by the caller.
LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> linphone::ConferenceInfo::getOrganizer ( ) const

Retrieve the organizer of the conference.

Returns
The Address of the conference's organizer.
LINPHONECXX_PUBLIC std::list<std::shared_ptr<linphone::Address> > linphone::ConferenceInfo::getParticipants ( ) const

Retrieve the list of participants.

Returns
The list of participants.
LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getSubject ( ) const

Retrieve the subject of the conference.

Returns
The subject of the conference.
LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> linphone::ConferenceInfo::getUri ( ) const

Retrieve the URI of the conference.

Returns
The URI of the conference (Address).
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDateTime ( time_t  datetime)

Set the date and time of the conference.

Parameters
datetimeThe date and time of the conference.
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDescription ( const std::string &  description)

Set the description of the conference.

Parameters
descriptionThe description of the conference.
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDuration ( int  duration)

Set the duration (in minutes) of the conference.

Parameters
durationThe duration of the conference.
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setOrganizer ( const std::shared_ptr< linphone::Address > &  organizer)

Set the organizer of the conference.

Parameters
organizerThe Address of the conference's organizer.
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setParticipants ( const std::list< std::shared_ptr< linphone::Address >> &  participants)

Set the list of participants.

Parameters
participantsThe list of participants to set.
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setSubject ( const std::string &  subject)

Set the subject of the conference.

Parameters
subjectThe subject of the conference.
LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setUri ( const std::shared_ptr< linphone::Address > &  uri)

Set the URI of the conference.

Parameters
uriThe URI of the conference (Address).

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