KCalendarCore::Conference
#include <conference.h>
Public Types | |
using | List = QList<Conference> |
Properties | |
QStringList | features |
bool | isNull |
QString | label |
QString | language |
QUrl | uri |
Public Member Functions | |
Conference () | |
Conference (const Conference &conference) | |
Conference (const QUrl &uri, const QString &label, const QStringList &features={}, const QString &language={}) | |
~Conference () | |
void | addFeature (const QString &feature) |
CustomProperties & | customProperties () |
const CustomProperties & | customProperties () const |
QStringList | features () const |
bool | isNull () const |
QString | label () const |
QString | language () const |
bool | operator!= (const Conference &other) const |
Conference & | operator= (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 |
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.
Member Typedef Documentation
◆ List
Definition at line 41 of file conference.h.
Property Documentation
◆ features
|
readwrite |
Definition at line 35 of file conference.h.
◆ isNull
|
read |
Definition at line 34 of file conference.h.
◆ label
|
readwrite |
Definition at line 36 of file conference.h.
◆ language
|
readwrite |
Definition at line 38 of file conference.h.
◆ uri
|
readwrite |
Definition at line 37 of file conference.h.
Constructor & Destructor Documentation
◆ Conference() [1/3]
|
explicit |
Create a null Conference.
Private class that helps to provide binary compatibility between releases.
Definition at line 31 of file conference.cpp.
◆ Conference() [2/3]
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
-
uri Uri to join the conference. label Label of the URI. features Features of this particular conference method. language Language of the information present in other fields.
Definition at line 36 of file conference.cpp.
◆ Conference() [3/3]
|
default |
Constructs a conference by copying another conference.
- Parameters
-
conference is the conference to be copied.
◆ ~Conference()
|
default |
Destroys the conference.
Member Function Documentation
◆ addFeature()
void Conference::addFeature | ( | const QString & | feature | ) |
Adds feature
to the list of features.
- Parameters
-
feature Feature to add.
Definition at line 92 of file conference.cpp.
◆ customProperties() [1/2]
CustomProperties & Conference::customProperties | ( | ) |
Returns a reference to the CustomProperties object.
Definition at line 122 of file conference.cpp.
◆ customProperties() [2/2]
const CustomProperties & Conference::customProperties | ( | ) | const |
Returns a const reference to the CustomProperties object.
Definition at line 127 of file conference.cpp.
◆ features()
QStringList 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.
Definition at line 87 of file conference.cpp.
◆ isNull()
bool Conference::isNull | ( | ) | const |
Returns true
if this is a default-constructed Conference instance.
Definition at line 49 of file conference.cpp.
◆ label()
QString Conference::label | ( | ) | const |
Returns label with additional details regarding further use of the URI.
Definition at line 77 of file conference.cpp.
◆ language()
QString Conference::language | ( | ) | const |
Returns the language of the text present in other properties of this object.
Definition at line 107 of file conference.cpp.
◆ operator!=()
bool KCalendarCore::Conference::operator!= | ( | const Conference & | other | ) | const |
Compares this with conference
for inequality.
- Parameters
-
conference the conference to compare.
Definition at line 60 of file conference.cpp.
◆ operator=()
|
default |
Sets this conference equal to conference
.
- Parameters
-
conference is the conference to copy.
◆ operator==()
bool KCalendarCore::Conference::operator== | ( | const Conference & | conference | ) | const |
Compares this with conference
for equality.
- Parameters
-
conference the conference to compare.
Definition at line 55 of file conference.cpp.
◆ removeFeature()
void Conference::removeFeature | ( | const QString & | feature | ) |
Removes feature
from the list of features.
- Parameters
-
feature Feature to remove.
Definition at line 97 of file conference.cpp.
◆ setCustomProperty()
void Conference::setCustomProperty | ( | const QByteArray & | xname, |
const QString & | xvalue ) |
Adds a custom property.
If the property already exists it will be overwritten.
- Parameters
-
xname is the name of the property. xvalue is its value.
Definition at line 117 of file conference.cpp.
◆ setFeatures()
void Conference::setFeatures | ( | const QStringList & | features | ) |
Sets the list of features to features
.
Definition at line 102 of file conference.cpp.
◆ setLabel()
void Conference::setLabel | ( | const QString & | label | ) |
Sets the URI label to label
.
Definition at line 82 of file conference.cpp.
◆ setLanguage()
void Conference::setLanguage | ( | const QString & | language | ) |
Sets the language to language
.
Definition at line 112 of file conference.cpp.
◆ setUri()
void Conference::setUri | ( | const QUrl & | uri | ) |
Sets the URI to @uri.
Definition at line 72 of file conference.cpp.
◆ uri()
QUrl Conference::uri | ( | ) | const |
Returns URI to join the conference, with access code included.
Definition at line 67 of file conference.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 8 2024 12:00:28 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.