KGAPI2::ContactsService

KGAPI2::ContactsService Namespace Reference

Functions

QString APIVersion ()
 
QByteArray contactsGroupToXML (const ContactsGroupPtr &group)
 
QByteArray contactToXML (const ContactPtr &contact)
 
QUrl createContactUrl (const QString &user)
 
QUrl createGroupUrl (const QString &user)
 
QUrl fetchAllContactsUrl (const QString &user, bool showDeleted)
 
QUrl fetchAllGroupsUrl (const QString &user)
 
QUrl fetchContactUrl (const QString &user, const QString &contactID)
 
QUrl fetchGroupUrl (const QString &user, const QString &groupId)
 
ContactPtr JSONToContact (const QByteArray &jsonData)
 
ContactsGroupPtr JSONToContactsGroup (const QByteArray &jsonData)
 
ObjectsList parseJSONFeed (const QByteArray &jsonFeed, FeedData &feedData)
 
QUrl photoUrl (const QString &user, const QString &contactId)
 
QUrl removeContactUrl (const QString &user, const QString &contactID)
 
QUrl removeGroupUrl (const QString &user, const QString &groupId)
 
QUrl updateContactUrl (const QString &user, const QString &contactID)
 
QUrl updateGroupUrl (const QString &user, const QString &groupId)
 
ContactPtr XMLToContact (const QByteArray &xmlData)
 
ContactsGroupPtr XMLToContactsGroup (const QByteArray &xmlData)
 

Detailed Description

Additional methods for implementing support for Google Contacts service.

You should never need to use these methods, unless implementing your own Job

There are no methods to serialize objects into JSON, because Google Contacts API only supports XML for writing.

Function Documentation

KGAPICONTACTS_EXPORT QString KGAPI2::ContactsService::APIVersion ( )

Supported API version.

Definition at line 251 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QByteArray KGAPI2::ContactsService::contactsGroupToXML ( const ContactsGroupPtr group)

Serializes a ContactsGroup object into XML.

Parameters
group

Definition at line 814 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QByteArray KGAPI2::ContactsService::contactToXML ( const ContactPtr contact)

Serializes a Contact object into XML.

Parameters
contact

Definition at line 592 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::createContactUrl ( const QString user)

Returns URL for creating contacts.

Parameters
userUser. "default" or [email protected][email protected]gmai[email protected]l.com}

Definition at line 139 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::createGroupUrl ( const QString user)

Returns URL for creating a new contacts group.

Parameters
userUser ([email protected][email protected]gmai[email protected]l.com) in whose addressbook to create a group.

Definition at line 201 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::fetchAllContactsUrl ( const QString user,
bool  showDeleted 
)

Returns URL for fetching all contacts in addressbook.

Parameters
userUser. "default" or [email protected][email protected]gmai[email protected]l.com
showDeletedWhether to fetch deleted contacts placeholders as well

Definition at line 108 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::fetchAllGroupsUrl ( const QString user)

Returns URL for KGAPI::Request::FetchAll requests.

Parameters
userUser ("default" or [email protected][email protected]gmai[email protected]l.com) in whose addressbook to look.

Definition at line 174 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::fetchContactUrl ( const QString user,
const QString contactID 
)

Returns URL for fetching specific contact.

Parameters
userUser. "default" or [email protected][email protected]gmai[email protected]l.com
contactIDID of contact to fetch

Definition at line 122 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::fetchGroupUrl ( const QString user,
const QString groupId 
)

Returns URL for fetching all contacts groups.

Parameters
userUser ("default" or [email protected][email protected]gmai[email protected]l.com) in whose addressbook to look
groupIdID of group of which to fetch all data.

Definition at line 184 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT ContactPtr KGAPI2::ContactsService::JSONToContact ( const QByteArray jsonData)

Parses JSON data into Contact object.

Parameters
jsonData

Definition at line 568 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT ContactsGroupPtr KGAPI2::ContactsService::JSONToContactsGroup ( const QByteArray jsonData)

Parses JSON data into ContactsGroup object.

Parameters
jsonData

Definition at line 280 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT ObjectsList KGAPI2::ContactsService::parseJSONFeed ( const QByteArray jsonFeed,
FeedData feedData 
)

Parses JSON feed into list of ContactsGroups or Events.

Parameters
jsonFeed
feedDataThe structure will be filled with additional data

Definition at line 67 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::photoUrl ( const QString user,
const QString contactId 
)

Returns URL for modifying photo.

Send a GET request to fetch the photo, PUT to change it and DELETE to remove it.

Parameters
userUser ([email protected][email protected]gmai[email protected]l.com) in whose addressbook to lok
contactIdID of contacts whose photo to update

Definition at line 236 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::removeContactUrl ( const QString user,
const QString contactID 
)

Returns URL for removing a single contact.

Parameters
userUser. "default" or [email protected][email protected]gmai[email protected]l.com
contactIDID of contact to remove

Definition at line 160 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::removeGroupUrl ( const QString user,
const QString groupId 
)

Returns URL for removing a single contacts group.

Parameters
userUser ([email protected][email protected]gmai[email protected]l.com) in whose addressbook to look
groupIdID of group to delete

Definition at line 222 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::updateContactUrl ( const QString user,
const QString contactID 
)

Returns URL for updating a single contact.

Parameters
userUser. "default" or [email protected][email protected]gmai[email protected]l.com
contactIDID of contact to update

Definition at line 146 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT QUrl KGAPI2::ContactsService::updateGroupUrl ( const QString user,
const QString groupId 
)

Returns URL for updating a single contacts group.

Parameters
userUser ([email protected][email protected]gmai[email protected]l.com)) in whose addressbook to look
groupIdID of group to update.

Definition at line 208 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT ContactPtr KGAPI2::ContactsService::XMLToContact ( const QByteArray xmlData)

Parses XML data into Contact object.

Parameters
xmlData

Definition at line 824 of file contactsservice.cpp.

KGAPICONTACTS_EXPORT ContactsGroupPtr KGAPI2::ContactsService::XMLToContactsGroup ( const QByteArray xmlData)

Parses XML data into ContactsGroup object.

Parameters
xmlData

Definition at line 1143 of file contactsservice.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 30 2020 22:38:45 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.