Object defining all information related to a past or future conference. More...

#include <conference_info.hh>

Inheritance diagram for linphone::ConferenceInfo:

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 std::string	getCcmpUri () const
	Retrieve the CCMP URI of the conference. More...

LINPHONECXX_PUBLIC void	setCcmpUri (const std::string &uri)
	Set the CCMP URI of the conference. More...

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 std::string	getDescriptionUtf8 () const
	Retrieve the description of the conference. More...

LINPHONECXX_PUBLIC void	setDescriptionUtf8 (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::string	getIcsUid () const
	Retrieve the ICS UID linked to a conference info. More...

LINPHONECXX_PUBLIC void	setIcsUid (const std::string &uid)
	Store the ICS UID in the conference info. 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::shared_ptr< const linphone::ParticipantInfo >	getOrganizerInfo () const
	Retrieve 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::string	getSubjectUtf8 () const
	Retrieve the subject of the conference. More...

LINPHONECXX_PUBLIC void	setSubjectUtf8 (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 bool	getCapability (linphone::StreamType streamType) const
	Get the capability of the conference. More...

LINPHONECXX_PUBLIC void	removeParticipant (const std::shared_ptr< const linphone::Address > &participant)
	Remove a participant from the conference. More...

LINPHONECXX_PUBLIC void	setCapability (linphone::StreamType streamType, bool enable)
	Set the capability of the conference. More...

LINPHONECXX_PUBLIC void	updateParticipant (const std::shared_ptr< const linphone::ParticipantInfo > &participantInfo)
	Update the participant information in the conference informations. More...

Detailed Description

Object defining all information related to a past or future conference.

Member Enumeration Documentation

◆ State

enum linphone::ConferenceInfo::State

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.

Member Function Documentation

◆ addParticipant() [1/2]

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

Add a participant to the conference.

Parameters

participant The participant (Address) to add.

◆ addParticipant() [2/2]

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::addParticipant ( const std::shared_ptr< const linphone::ParticipantInfo > & participantInfo )

Add a participant to the conference.

Parameters

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

◆ addParticipantInfos()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::addParticipantInfos ( const std::list< std::shared_ptr< linphone::ParticipantInfo >> & participantInfos )

Add a list of participants.

Parameters

participantInfos The list of participant informations to add.

◆ clone()

LINPHONECXX_PUBLIC std::shared_ptr<linphone::ConferenceInfo> linphone::ConferenceInfo::clone ( ) const

Clone an object ConferenceInfo.

Returns: the cloned ConferenceInfo object.

◆ findParticipant()

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.

Parameters

participant The participant (Address) to search.

Returns: The participant information (ParticipantInfo).

◆ getCapability()

LINPHONECXX_PUBLIC bool linphone::ConferenceInfo::getCapability ( linphone::StreamType streamType ) const

Get the capability of the conference.

The capability information represents the capability for the conference linked to the #ConferenceInfo to handle a given stream type (audio, video or text).

Parameters

streamType A StreamType

Returns: the capability of the conference linked to conference information ConferenceInfo

◆ getCcmpUri()

LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getCcmpUri ( ) const

Retrieve the CCMP URI of the conference.

Returns: The URI of the conference stored in the CCMP server.

◆ getDateTime()

LINPHONECXX_PUBLIC time_t linphone::ConferenceInfo::getDateTime ( ) const

Retrieve the date and time of the conference.

Returns: The date and time of the conference.

◆ getDescription()

LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getDescription ( ) const

Retrieve the description of the conference.

Returns: The description of the conference.

◆ getDescriptionUtf8()

LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getDescriptionUtf8 ( ) const

Retrieve the description of the conference.

Returns: The description of the conference.

◆ getDuration()

LINPHONECXX_PUBLIC unsigned int linphone::ConferenceInfo::getDuration ( ) const

Retrieve the duration (in minutes) of the conference.

Returns: The duration of the conference.

◆ getIcalendarString()

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.

◆ getIcsUid()

LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getIcsUid ( ) const

Retrieve the ICS UID linked to a conference info.

Returns: the ICS UID.

◆ getOrganizer()

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.

◆ getOrganizerInfo()

LINPHONECXX_PUBLIC std::shared_ptr<const linphone::ParticipantInfo> linphone::ConferenceInfo::getOrganizerInfo ( ) const

Retrieve the organizer of the conference.

Returns: The ParticipantInfo of the conference's organizer.

◆ getParticipantInfos()

LINPHONECXX_PUBLIC std::list<std::shared_ptr<linphone::ParticipantInfo> > linphone::ConferenceInfo::getParticipantInfos ( ) const

Retrieve the list of participants as list of participant infos.

Returns: The list of participant informations.

◆ getParticipants()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::list<std::shared_ptr<linphone::Address> > linphone::ConferenceInfo::getParticipants ( ) const

Retrieve the list of participants as list of addresses.

Returns: The list of participants.

Deprecated:: 24/08/2023 use linphone_conference_info_get_participant_infos instead

◆ getSecurityLevel()

LINPHONECXX_PUBLIC linphone::Conference::SecurityLevel linphone::ConferenceInfo::getSecurityLevel ( ) const

Retrieve the desired security level of the conference.

Returns: The desired security level of the conference.

◆ getState()

LINPHONECXX_PUBLIC State linphone::ConferenceInfo::getState ( ) const

Retrieve the state of the conference info.

Returns: State object.

◆ getSubject()

LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getSubject ( ) const

Retrieve the subject of the conference.

Returns: The subject of the conference.

◆ getSubjectUtf8()

LINPHONECXX_PUBLIC std::string linphone::ConferenceInfo::getSubjectUtf8 ( ) const

Retrieve the subject of the conference.

Returns: The subject of the conference.

◆ getUri()

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

◆ removeParticipant()

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

Remove a participant from the conference.

Parameters

participant The participant (Address) to remove.

◆ setCapability()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setCapability	(	linphone::StreamType	streamType,
		bool	enable
	)

Set the capability of the conference.

The capability information represents the capability for the conference linked to the #ConferenceInfo to handle a given stream type (audio, video or text).

Parameters

streamType	A StreamType
enable	the capability of the conference linked to conference information ConferenceInfo

◆ setCcmpUri()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setCcmpUri ( const std::string & uri )

Set the CCMP URI of the conference.

Parameters

uri	The URI of the conference in the CCMP server.

◆ setDateTime()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDateTime ( time_t datetime )

Set the date and time of the conference.

Parameters

datetime The date and time of the conference.

◆ setDescription()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDescription ( const std::string & description )

Set the description of the conference.

Parameters

description The description of the conference.

◆ setDescriptionUtf8()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDescriptionUtf8 ( const std::string & description )

Set the description of the conference.

Parameters

description The description of the conference.

◆ setDuration()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setDuration ( unsigned int duration )

Set the duration (in minutes) of the conference.

Parameters

duration The duration of the conference.

◆ setIcsUid()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setIcsUid ( const std::string & uid )

Store the ICS UID in the conference info.

Parameters

uid	the ICS UID to be associated to the ConferenceInfo object.

◆ setOrganizer()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setOrganizer ( const std::shared_ptr< const linphone::Address > & organizer )

Set the organizer of the conference.

Parameters

organizer The Address of the conference's organizer.

◆ setParticipantInfos()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setParticipantInfos ( const std::list< std::shared_ptr< linphone::ParticipantInfo >> & participantInfos )

Set the list of participants.

Parameters

participantInfos The list of participant informations to set.

◆ setParticipants()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ConferenceInfo::setParticipants ( const std::list< std::shared_ptr< linphone::Address >> & participants )

Set the list of participants.

Parameters

participants The list of participants to set.

Deprecated:: 24/08/2023 use linphone_conference_info_set_participant_infos instead

◆ setSecurityLevel()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setSecurityLevel ( linphone::Conference::SecurityLevel securityLevel )

Set the desired security level of the conference.

Parameters

securityLevel The desired security level of the conference.

◆ setSubject()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setSubject ( const std::string & subject )

Set the subject of the conference.

Parameters

subject The subject of the conference.

◆ setSubjectUtf8()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::setSubjectUtf8 ( const std::string & subject )

Set the subject of the conference.

Parameters

subject The subject of the conference.

◆ updateParticipant()

LINPHONECXX_PUBLIC void linphone::ConferenceInfo::updateParticipant ( const std::shared_ptr< const linphone::ParticipantInfo > & participantInfo )

Update the participant information in the conference informations.

Parameters

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

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

conference_info.hh

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ State

Member Function Documentation

◆ addParticipant() [1/2]

◆ addParticipant() [2/2]

◆ addParticipantInfos()

◆ clone()

◆ findParticipant()

◆ getCapability()

◆ getCcmpUri()

◆ getDateTime()

◆ getDescription()

◆ getDescriptionUtf8()

◆ getDuration()

◆ getIcalendarString()

◆ getIcsUid()

◆ getOrganizer()

◆ getOrganizerInfo()

◆ getParticipantInfos()

◆ getParticipants()

◆ getSecurityLevel()

◆ getState()

◆ getSubject()

◆ getSubjectUtf8()

◆ getUri()

◆ removeParticipant()

◆ setCapability()

◆ setCcmpUri()

◆ setDateTime()

◆ setDescription()

◆ setDescriptionUtf8()

◆ setDuration()

◆ setIcsUid()

◆ setOrganizer()

◆ setParticipantInfos()

◆ setParticipants()

◆ setSecurityLevel()

◆ setSubject()

◆ setSubjectUtf8()

◆ updateParticipant()