Query Class Reference

A wrapping class for the XEP-0077 <query> element. More...

#include <registration.h>

Inherits gloox::StanzaExtension.

List of all members.

Public Member Functions

 Query (DataForm *form)
 Query (bool del=false)
 Query (int fields, const RegistrationFields &values)
 Query (const Tag *tag)
virtual ~Query ()
const DataFormform () const
const std::string & instructions () const
int fields () const
bool registered () const
bool remove () const
const OOBoob () const
virtual const std::string & filterString () const
virtual StanzaExtensionnewInstance (const Tag *tag) const
virtual Tagtag () const
virtual StanzaExtensionclone () const

Detailed Description

A wrapping class for the XEP-0077 <query> element.

Author:
Jakob Schroeter <js@camaya.net>
Since:
1.0

Definition at line 125 of file registration.h.


Constructor & Destructor Documentation

Query ( DataForm form  ) 

Creates a new object that can be used to carry out a registration.

Parameters:
form A DataForm containing the registration terms.

Definition at line 18 of file registration.cpp.

Query ( bool  del = false  ) 

Creates a new object that can be used to carry out a registration.

Parameters:
del Whether or not to remove the account.

Definition at line 24 of file registration.cpp.

Query ( int  fields,
const RegistrationFields values 
)

Creates a new object that can be used to carry out a registration.

Parameters:
fields Bit-wise ORed fieldEnum values describing the valid (i.e., set) fields in the values parameter.
values Contains the registration fields.

Definition at line 30 of file registration.cpp.

Query ( const Tag tag  ) 

Creates a new object from the given Tag.

Parameters:
tag The Tag to parse.

Definition at line 36 of file registration.cpp.

~Query (  )  [virtual]

Virtual Destructor.

Definition at line 141 of file registration.cpp.


Member Function Documentation

virtual StanzaExtension* clone (  )  const [inline, virtual]

Returns an identical copy of the current StanzaExtension.

Returns:
An identical copy of the current StanzaExtension.

Implements StanzaExtension.

Definition at line 213 of file registration.h.

int fields (  )  const [inline]

Returns the registration fields, if set.

Returns:
The registration fields.

Definition at line 175 of file registration.h.

const std::string & filterString (  )  const [virtual]

Returns an XPath expression that describes a path to child elements of a stanza that an extension handles.

Returns:
The extension's filter string.

Implements StanzaExtension.

Definition at line 147 of file registration.cpp.

const DataForm* form (  )  const [inline]

Returns the contained registration form, if any.

Returns:
The registration form. May be 0.

Definition at line 163 of file registration.h.

const std::string& instructions (  )  const [inline]

Returns the registration instructions, if given

Returns:
The registration instructions.

Definition at line 169 of file registration.h.

virtual StanzaExtension* newInstance ( const Tag tag  )  const [inline, virtual]

Returns a new Instance of the derived type. Usually, for a derived class FooExtension, the implementation of this function looks like:

 StanzaExtension* FooExtension::newInstance( const Tag* tag ) const
 {
   return new FooExtension( tag );
 }
Returns:
The derived extension's new instance.

Implements StanzaExtension.

Definition at line 204 of file registration.h.

const OOB* oob (  )  const [inline]

Returns an optional OOB object.

Returns:
A pointer to an OOB object, if present, 0 otherwise.

Definition at line 198 of file registration.h.

bool registered (  )  const [inline]

Indicates whether the account is already registered.

Returns:
True if the <registered> element is present, false otherwise.

Definition at line 186 of file registration.h.

bool remove (  )  const [inline]

Indicates whether the account shall be removed.

Returns:
True if the <remove> element is present, false otherwise.

Definition at line 192 of file registration.h.

Tag * tag (  )  const [virtual]

Returns a Tag representation of the extension.

Returns:
A Tag representation of the extension.

Implements StanzaExtension.

Definition at line 153 of file registration.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Jun 8 23:37:56 2010 for gloox by  doxygen 1.6.3