From 93adc6aec9ba4671884d9692308b239d3064e553 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Sat, 21 Aug 2010 19:15:30 +0000 Subject: add doc html --- doc/html/classQXmppVCardManager.html | 248 +++++++++++++++++++++++++++++++++++ 1 file changed, 248 insertions(+) create mode 100644 doc/html/classQXmppVCardManager.html (limited to 'doc/html/classQXmppVCardManager.html') diff --git a/doc/html/classQXmppVCardManager.html b/doc/html/classQXmppVCardManager.html new file mode 100644 index 00000000..313c0f49 --- /dev/null +++ b/doc/html/classQXmppVCardManager.html @@ -0,0 +1,248 @@ + + + + + +QXmpp: QXmppVCardManager Class Reference + + + + + + + + + +
+

QXmppVCardManager Class Reference
+ +[Managers] +

+

The QXmppVCardManager gets/sets XMPP vCards. It is an implentation of XEP-0054: vcard-temp. +More...

+ +

#include <QXmppVCardManager.h>

+ +

List of all members.

+ + + + + + + + + + + +

Signals

void vCardReceived (const QXmppVCard &)
void clientVCardReceived ()

Public Member Functions

+ QXmppVCardManager (QXmppStream *stream, QObject *parent=0)
void requestVCard (const QString &bareJid="")
const QXmppVCard & clientVCard () const
void setClientVCard (const QXmppVCard &)
void requestClientVCard ()
bool isClientVCardReceived ()
+

Detailed Description

+

The QXmppVCardManager gets/sets XMPP vCards. It is an implentation of XEP-0054: vcard-temp.

+
Note:
It's object should not be created using it's constructor. Instead QXmppClient::vCardManager() should be used to get the reference of instantiated object this class.
+

Getting vCards of entries in Roster:
+ It doesn't store vCards of the JIDs in the roster of connected user. Instead client has to request for a particular vCard using requestVCard(). And connect to the signal vCardReceived() to get the requested vCard.

+

Getting vCard of the connected client:
+ For getting the vCard of the connected user itself. Client can call requestClientVCard() and on the signal clientVCardReceived() it can get its vCard using clientVCard().

+

Settting vCard of the client:
+ Using setClientVCard() client can set its vCard.

+
Note:
Client can't set/change vCards of roster entries.
+

Member Function Documentation

+ +
+
+ + + + + + + + +
const QXmppVCard & QXmppVCardManager::clientVCard ( )  const
+
+
+

Returns the vCard of the connected client.

+
Returns:
QXmppVCard
+ +
+
+ +
+
+ + + + + + + + +
void QXmppVCardManager::clientVCardReceived ( )  [signal]
+
+
+

This signal is emitted when the client's vCard is received after calling the requestClientVCard() function.

+ +
+
+ +
+
+ + + + + + + + +
bool QXmppVCardManager::isClientVCardReceived ( ) 
+
+
+

Returns true if vCard of the connected client has been received else false.

+
Returns:
bool
+ +
+
+ +
+
+ + + + + + + + +
void QXmppVCardManager::requestClientVCard ( ) 
+
+
+

This function requests the server for vCard of the connected user itself. Once received the signal clientVCardReceived() is emitted. Received vCard can be get using clientVCard().

+ +
+
+ +
+
+ + + + + + + + + +
void QXmppVCardManager::requestVCard (const QString &  jid = "" ) 
+
+
+

This function requests the server for vCard of the specified jid. Once received the signal vCardReceived() is emitted.

+
Parameters:
+ + +
jid Jid of the specific entry in the roster
+
+
+ +
+
+ +
+
+ + + + + + + + + +
void QXmppVCardManager::setClientVCard (const QXmppVCard &  clientVCard ) 
+
+
+

Sets the vCard of the connected client.

+
Parameters:
+ + +
clientVCard QXmppVCard
+
+
+ +
+
+ +
+
+ + + + + + + + + +
void QXmppVCardManager::vCardReceived (const QXmppVCard &  )  [signal]
+
+
+

This signal is emitted when the requested vCard is received after calling the requestVCard() function.

+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Classes Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on Sun Aug 22 00:44:24 2010 for QXmpp by  + +doxygen 1.6.1
+ + -- cgit v1.2.3