KGAPI2::People::ContactGroup Class Reference

#include <contactgroup.h>

Inheritance diagram for KGAPI2::People::ContactGroup:

Public Types
enum class	GroupType { GROUP_TYPE_UNSPECIFIED , USER_CONTACT_GROUP , SYSTEM_CONTACT_GROUP }

Public Member Functions
	ContactGroup ()
	~ContactGroup ()
void	addGroupClientData (const GroupClientData &value)
void	clearClientData ()
QList< GroupClientData >	clientData () const
QString	etag () const
QString	formattedName () const
ContactGroup::GroupType	groupType () const
int	memberCount () const
QList< QString >	memberResourceNames () const
ContactGroupMetadata	metadata () const
QString	name () const
bool	operator!= (const ContactGroup &) const
bool	operator== (const ContactGroup &) const
void	removeGroupClientData (const GroupClientData &value)
QString	resourceName () const
void	setClientData (const QList< GroupClientData > &value)
void	setEtag (const QString &value)
void	setName (const QString &value)
void	setResourceName (const QString &value)
QJsonValue	toJSON () const
Public Member Functions inherited from KGAPI2::Object
	Object ()
	Object (const Object &other)
virtual	~Object ()
QString	etag () const
bool	operator== (const Object &other) const
void	setEtag (const QString &etag)

Static Public Member Functions
static ContactGroupPtr	fromJSON (const QJsonObject &)

Detailed Description

A contact group.

See also

https://developers.google.com/people/api/rest/v1/people#contactgroup

Since

5.23.0

Definition at line 36 of file contactgroup.h.

Member Enumeration Documentation

GroupType

enum class KGAPI2::People::ContactGroup::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()

KGAPI2::People::ContactGroup::ContactGroup ( )

explicit

Constructs a new ContactGroup.

Definition at line 58 of file contactgroup.cpp.

~ContactGroup()

KGAPI2::People::ContactGroup::~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

nodiscard

The group's client data.

Definition at line 96 of file contactgroup.cpp.

etag()

QString KGAPI2::People::ContactGroup::etag ( ) const

nodiscard

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

nodiscard

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

ContactGroupPtr KGAPI2::People::ContactGroup::fromJSON ( const QJsonObject & obj )

staticnodiscard

Definition at line 148 of file contactgroup.cpp.

groupType()

ContactGroup::ContactGroup::GroupType KGAPI2::People::ContactGroup::groupType ( ) const

nodiscard

Output only.

The contact group type.

Definition at line 92 of file contactgroup.cpp.

memberCount()

int KGAPI2::People::ContactGroup::memberCount ( ) const

nodiscard

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

QList< QString > KGAPI2::People::ContactGroup::memberResourceNames ( ) const

nodiscard

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

nodiscard

Output only.

Metadata about the contact group.

Definition at line 130 of file contactgroup.cpp.

name()

QString KGAPI2::People::ContactGroup::name ( ) const

nodiscard

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

nodiscard

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

nodiscard

Definition at line 182 of file contactgroup.cpp.

---

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

• contactgroup.h
• contactgroup.cpp