KCalendarCore::Conference

Search for usage in LXR

KCalendarCore::Conference Class Reference

#include <conference.h>

Public Types

using List = QVector< Conference >
 

Properties

QStringList features
 
bool isNull
 
QString label
 
QString language
 
QUrl uri
 

Public Member Functions

 Conference ()
 
 Conference (const QUrl &uri, const QString &label, const QStringList &features={}, const QString &language={})
 
 Conference (const Conference &conference)
 
 ~Conference ()
 
void addFeature (const QString &feature)
 
CustomPropertiescustomProperties ()
 
const CustomPropertiescustomProperties () const
 
QStringList features () const
 
bool isNull () const
 
QString label () const
 
QString language () const
 
bool operator!= (const Conference &other) const
 
Conferenceoperator= (const Conference &conference)
 
bool operator== (const Conference &conference) const
 
void removeFeature (const QString &feature)
 
void setCustomProperty (const QByteArray &xname, const QString &xvalue)
 
void setFeatures (const QStringList &features)
 
void setLabel (const QString &label)
 
void setLanguage (const QString &language)
 
void setUri (const QUrl &uri)
 
QUrl uri () const
 

Friends

KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &, const KCalendarCore::Conference &)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &, KCalendarCore::Conference &)
 

Detailed Description

Represents information related to a conference information of an Calendar Incidence, typically a meeting or task (to-do).

Conference contains information needed to join a remote conference system (e.g. phone call, audio/video meeting etc.)

Since
5.77

Definition at line 31 of file conference.h.

Constructor & Destructor Documentation

Conference::Conference ( )
explicit

Create a null Conference.

Private class that helps to provide binary compatibility between releases.

Definition at line 31 of file conference.cpp.

Conference::Conference ( const QUrl uri,
const QString label,
const QStringList features = {},
const QString language = {} 
)

Constructs a conference consisting of a uri, description of the URI (label), list of features of the conference (features) and language.

Parameters
uriUri to join the conference.
labelLabel of the URI.
featuresFeatures of this particular conference method.
languageLanguage of the information present in other fields.

Definition at line 36 of file conference.cpp.

Conference::Conference ( const Conference conference)
default

Constructs a conference by copying another conference.

Parameters
conferenceis the conference to be copied.
Conference::~Conference ( )
default

Destroys the conference.

Member Function Documentation

void Conference::addFeature ( const QString feature)

Adds feature to the list of features.

Parameters
featureFeature to add.

Definition at line 92 of file conference.cpp.

CustomProperties & Conference::customProperties ( )

Returns a reference to the CustomProperties object.

Definition at line 122 of file conference.cpp.

const CustomProperties & Conference::customProperties ( ) const

Returns a const reference to the CustomProperties object.

Definition at line 127 of file conference.cpp.

QStringList KCalendarCore::Conference::features ( ) const

Returns the list of features of the conferencing system at given URI.

This can be e.g. CHAT, AUDIO, VIDEO, PHONE, etc.

bool KCalendarCore::Conference::isNull ( ) const

Returns true if this is a default-constructed Conference instance.

QString KCalendarCore::Conference::label ( ) const

Returns label with additional details regarding further use of the URI.

QString KCalendarCore::Conference::language ( ) const

Returns the language of the text present in other properties of this object.

bool KCalendarCore::Conference::operator!= ( const Conference other) const

Compares this with conference for inequality.

Parameters
conferencethe conference to compare.

Definition at line 60 of file conference.cpp.

Conference & KCalendarCore::Conference::operator= ( const Conference conference)
default

Sets this conference equal to conference.

Parameters
conferenceis the conference to copy.
bool KCalendarCore::Conference::operator== ( const Conference conference) const

Compares this with conference for equality.

Parameters
conferencethe conference to compare.

Definition at line 55 of file conference.cpp.

void Conference::removeFeature ( const QString feature)

Removes feature from the list of features.

Parameters
featureFeature to remove.

Definition at line 97 of file conference.cpp.

void Conference::setCustomProperty ( const QByteArray xname,
const QString xvalue 
)

Adds a custom property.

If the property already exists it will be overwritten.

Parameters
xnameis the name of the property.
xvalueis its value.

Definition at line 117 of file conference.cpp.

void Conference::setFeatures ( const QStringList features)

Sets the list of features to features.

Definition at line 102 of file conference.cpp.

void Conference::setLabel ( const QString label)

Sets the URI label to label.

Definition at line 82 of file conference.cpp.

void Conference::setLanguage ( const QString language)

Sets the language to language.

Definition at line 112 of file conference.cpp.

void Conference::setUri ( const QUrl uri)

Sets the URI to .

Definition at line 72 of file conference.cpp.

QUrl KCalendarCore::Conference::uri ( ) const

Returns URI to join the conference, with access code included.

Friends And Related Function Documentation

KCALENDARCORE_EXPORT QDataStream& operator<< ( QDataStream ,
const KCalendarCore::Conference  
)
friend

Serializes a Conference object into a data stream.

Parameters
streamis a QDataStream.
conferenceis a reference to a Conference object to be serialized.
KCALENDARCORE_EXPORT QDataStream& operator>> ( QDataStream ,
KCalendarCore::Conference  
)
friend

Initializes a Conference object from a data stream.

Parameters
streamis a QDataStream.
conferenceis a reference to a Conference object to be initialized.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Oct 23 2021 22:52:47 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.