KGAPI2::People::ContactGroup
#include <contactgroup.h>
Public Types | |
| enum class | GroupType { GROUP_TYPE_UNSPECIFIED , USER_CONTACT_GROUP , SYSTEM_CONTACT_GROUP } |
Public Member Functions inherited from Static Public Member Functions | |
| static ContactGroupPtr | fromJSON (const QJsonObject &) |
Detailed Description
Member Enumeration Documentation
◆ GroupType
|
strong |
| Enumerator | |
|---|---|
| GROUP_TYPE_UNSPECIFIED | Unspecified. |
| USER_CONTACT_GROUP | User defined contact group. |
| SYSTEM_CONTACT_GROUP | System defined contact group. |
Definition at line 39 of file contactgroup.h.
Constructor & Destructor Documentation
◆ ContactGroup()
|
explicit |
Constructs a new ContactGroup.
Definition at line 58 of file contactgroup.cpp.
◆ ~ContactGroup()
|
default |
Destructor.
Member Function Documentation
◆ addGroupClientData()
| void KGAPI2::People::ContactGroup::addGroupClientData | ( | const GroupClientData & | value | ) |
Appends the given value to the list of clientData.
Definition at line 106 of file contactgroup.cpp.
◆ clearClientData()
| void KGAPI2::People::ContactGroup::clearClientData | ( | ) |
Clears the list of clientData.
Definition at line 116 of file contactgroup.cpp.
◆ clientData()
| QList< GroupClientData > KGAPI2::People::ContactGroup::clientData | ( | ) | const |
The group's client data.
Definition at line 96 of file contactgroup.cpp.
◆ etag()
| QString KGAPI2::People::ContactGroup::etag | ( | ) | const |
The HTTP entity tag of the resource.
Used for web cache validation.
Definition at line 83 of file contactgroup.cpp.
◆ formattedName()
| QString KGAPI2::People::ContactGroup::formattedName | ( | ) | const |
Output only.
The name translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale for system groups names. Group names set by the owner are the same as name.
Definition at line 75 of file contactgroup.cpp.
◆ fromJSON()
|
static |
Definition at line 148 of file contactgroup.cpp.
◆ groupType()
| ContactGroup::ContactGroup::GroupType KGAPI2::People::ContactGroup::groupType | ( | ) | const |
◆ memberCount()
| int KGAPI2::People::ContactGroup::memberCount | ( | ) | const |
Output only.
The total number of contacts in the group irrespective of max members in specified in the request.
Definition at line 79 of file contactgroup.cpp.
◆ memberResourceNames()
Output only.
The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as maxMembers in the get request.
Definition at line 143 of file contactgroup.cpp.
◆ metadata()
| ContactGroupMetadata KGAPI2::People::ContactGroup::metadata | ( | ) | const |
◆ name()
| QString KGAPI2::People::ContactGroup::name | ( | ) | const |
The contact group name set by the group owner or a system provided name for system groups.
For contactGroups.create or contactGroups.update the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
Definition at line 121 of file contactgroup.cpp.
◆ operator!=()
| bool KGAPI2::People::ContactGroup::operator!= | ( | const ContactGroup & | other | ) | const |
Definition at line 70 of file contactgroup.cpp.
◆ operator==()
| bool KGAPI2::People::ContactGroup::operator== | ( | const ContactGroup & | other | ) | const |
Definition at line 65 of file contactgroup.cpp.
◆ removeGroupClientData()
| void KGAPI2::People::ContactGroup::removeGroupClientData | ( | const GroupClientData & | value | ) |
Removes the given value from the list of clientData if it exists.
Definition at line 111 of file contactgroup.cpp.
◆ resourceName()
| QString KGAPI2::People::ContactGroup::resourceName | ( | ) | const |
The resource name for the contact group, assigned by the server.
An ASCII string, in the form of contactGroups/{contact_group_id}.
Definition at line 134 of file contactgroup.cpp.
◆ setClientData()
| void KGAPI2::People::ContactGroup::setClientData | ( | const QList< GroupClientData > & | value | ) |
Sets value of the clientData property.
Definition at line 101 of file contactgroup.cpp.
◆ setEtag()
| void KGAPI2::People::ContactGroup::setEtag | ( | const QString & | value | ) |
Sets value of the etag property.
Definition at line 88 of file contactgroup.cpp.
◆ setName()
| void KGAPI2::People::ContactGroup::setName | ( | const QString & | value | ) |
Sets value of the name property.
Definition at line 126 of file contactgroup.cpp.
◆ setResourceName()
| void KGAPI2::People::ContactGroup::setResourceName | ( | const QString & | value | ) |
Sets value of the resourceName property.
Definition at line 139 of file contactgroup.cpp.
◆ toJSON()
| QJsonValue KGAPI2::People::ContactGroup::toJSON | ( | ) | const |
Definition at line 182 of file contactgroup.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Apr 27 2024 22:14:20 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.