• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KXMLRPC Client Library

  • KXmlRpc
  • Client
Public Slots | Public Member Functions | List of all members
KXmlRpc::Client Class Reference

#include <client.h>

Inherits QObject.

Public Slots

void call (const QString &method, bool arg, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 
void call (const QString &method, const QByteArray &arg, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 
void call (const QString &method, const QDateTime &arg, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 
void call (const QString &method, const QList< QVariant > &args, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 
void call (const QString &method, const QString &arg, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 
void call (const QString &method, const QStringList &arg, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 
void call (const QString &method, const QVariant &arg, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 
void call (const QString &method, double arg, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 
void call (const QString &method, int arg, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
 

Public Member Functions

 Client (const KUrl &url, QObject *parent=0)
 
 Client (QObject *parent=0)
 
 ~Client ()
 
bool isDigestAuthEnabled () const
 
void setDigestAuthEnabled (bool enabled)
 
void setUrl (const KUrl &url)
 
void setUserAgent (const QString &userAgent)
 
KUrl url () const
 
QString userAgent () const
 

Detailed Description

A class that represents a connection to a XML-RPC server.

This is the main interface to the XML-RPC client library.

KXmlRpc::Client *c = new Client(KUrl( "http://localhost" ), this);
c->setUserAgent( "Test/1.0" );
c->call( "xmlrpc.command1", "Hi!",
this, SLOT( gotData( const QList<QVariant>&, const QVariant ) ),
this, SLOT( gotError( const QString&, const QVariant& ) ) );
KXmlRpc::Client
A class that represents a connection to a XML-RPC server.
Definition: client.h:54
KXmlRpc::Client::call
void call(const QString &method, const QList< QVariant > &args, QObject *msgObj, const char *messageSlot, QObject *faultObj, const char *faultSlot, const QVariant &id=QVariant())
Calls the given method on a XML-RPC server, with the given argument list.
Definition: client.cpp:106
KXmlRpc::Client::setUserAgent
void setUserAgent(const QString &userAgent)
Sets the userAgent string the Client will use to identify itself.
Definition: client.cpp:91
Author
Narayan Newton naray.nosp@m.anne.nosp@m.wton@.nosp@m.gmai.nosp@m.l.com

Definition at line 53 of file client.h.

Constructor & Destructor Documentation

◆ Client() [1/2]

Client::Client ( QObject *  parent = 0)
explicit

Constructs a XML-RPC Client.

Parameters
parentthe parent of this object, defaults to NULL.

Definition at line 53 of file client.cpp.

◆ Client() [2/2]

Client::Client ( const KUrl &  url,
QObject *  parent = 0 
)
explicit

Constructs a XML-RPC Client, which will connect to url.

Parameters
urlthe url of the xml-rpc server.
parentthe parent of this object, defaults to NULL.

Definition at line 58 of file client.cpp.

◆ ~Client()

Client::~Client ( )

Destroys the XML-RPC Client.

Definition at line 64 of file client.cpp.

Member Function Documentation

◆ call [1/9]

void Client::call ( const QString &  method,
bool  arg,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given bool as the argument.

Parameters
methodthe method on the server we are going to be calling
argthe bool to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 157 of file client.cpp.

◆ call [2/9]

void Client::call ( const QString &  method,
const QByteArray &  arg,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given byte array as the argument.

Parameters
methodthe method on the server we are going to be calling
argthe array to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 187 of file client.cpp.

◆ call [3/9]

void Client::call ( const QString &  method,
const QDateTime &  arg,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given date as the argument.

Parameters
methodthe method on the server we are going to be calling
argthe date and/or time to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 197 of file client.cpp.

◆ call [4/9]

void Client::call ( const QString &  method,
const QList< QVariant > &  args,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given argument list.

Parameters
methodthe method on the server we are going to be calling
argsthe argument list to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 106 of file client.cpp.

◆ call [5/9]

void Client::call ( const QString &  method,
const QString &  arg,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given string as the argument.

Parameters
methodthe method on the server we are going to be calling
argthe string to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 177 of file client.cpp.

◆ call [6/9]

void Client::call ( const QString &  method,
const QStringList &  arg,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given string list as the argument.

Parameters
methodthe method on the server we are going to be calling
argthe list of strings to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 207 of file client.cpp.

◆ call [7/9]

void Client::call ( const QString &  method,
const QVariant &  arg,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given argument.

Parameters
methodthe method on the server we are going to be calling
argthe argument to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 137 of file client.cpp.

◆ call [8/9]

void Client::call ( const QString &  method,
double  arg,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given double as the argument.

Parameters
methodthe method on the server we are going to be calling
argthe double to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 167 of file client.cpp.

◆ call [9/9]

void Client::call ( const QString &  method,
int  arg,
QObject *  msgObj,
const char *  messageSlot,
QObject *  faultObj,
const char *  faultSlot,
const QVariant &  id = QVariant() 
)
slot

Calls the given method on a XML-RPC server, with the given int as the argument.

Parameters
methodthe method on the server we are going to be calling
argthe int to pass to the server
msgObjthe object containing the data slot
messageSlotthe data slot itself
faultObjthe object containing the error slot
faultSlotthe error slot itself
idthe id for our Client object, defaults to empty

Definition at line 147 of file client.cpp.

◆ isDigestAuthEnabled()

bool Client::isDigestAuthEnabled ( ) const

Returns true if HTTP-Digest authentication is enabled, false if not.

See also
setDigestAuthEnabled()

Definition at line 96 of file client.cpp.

◆ setDigestAuthEnabled()

void Client::setDigestAuthEnabled ( bool  enabled)

Enables/disables HTTP-Digest authentication.

See also
isDigestAuthEnabled()

Definition at line 101 of file client.cpp.

◆ setUrl()

void Client::setUrl ( const KUrl &  url)

Sets the url the Client will connect to.

Parameters
urlthe url for the xml-rpc server we will be connecting to.
See also
url()

Definition at line 76 of file client.cpp.

◆ setUserAgent()

void Client::setUserAgent ( const QString &  userAgent)

Sets the userAgent string the Client will use to identify itself.

Parameters
userAgentthe user agent string to use.
See also
userAgent()

Definition at line 91 of file client.cpp.

◆ url()

KUrl Client::url ( ) const

Returns the current url the XML-RPC Client will connect to.

See also
setUrl()

Definition at line 81 of file client.cpp.

◆ userAgent()

QString Client::userAgent ( ) const

Returns the user agent string currently used by the Client.

See also
setUserAgent()

Definition at line 86 of file client.cpp.


The documentation for this class was generated from the following files:
  • client.h
  • client.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KXMLRPC Client Library

Skip menu "KXMLRPC Client Library"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal