QOAuth Documentation

1.0.1

What is the purpose of QOAuth?

The main motivation to create this library was to provide an interface to OAuth protocol for (Qt-based) C++ applications in an easy way. This is very early version of the library, and it lacks some functionality, but in the same time it is capable of sending OAuth authorization requests as well as preparing requests for accessing User's Protected Resources.

License and Authors

The project is licensed under GNU LGPL license version 2.1 or later. The work is done by Dominik Kapusta (d at ayoy dot net).

How to install?

Dependencies

There are a few things necessary to get OAuth library working:

  1. Qt libraries, version 4.4 or higher,
  2. QCA (Qt Cryptographic Architecture), available from Delta XMPP Project, version 2.0.0 or higher,
  3. OpenSSL plugin to QCA (qca-ossl), available from QCA page, and requiring OpenSSL.

Note: KDE4 users meet all the requirements out of the box.

Installation

The source code repository is hosted on GitHub and the code can be checked out from there easily using git:
    $ git clone git://github.com/ayoy/qoauth.git 

To compile the code, follow the simple procedure:

    $ qmake
    $ make
    $ sudo make install 

Usage

Configuring your project to work with QOAuth library is extremely simple. Firstly, append a line to your project file:
    CONFIG += oauth 

Then include the following header in your code:

    #include <QtOAuth> 

Note: This follows the Qt scheme, i.e. QT += xml ==> include <QtXml>, etc.

Bugs and issues

Please file all the bug reports to the QOAuth bug tracking system at lighthouseapp.com. If you wish to contribute, you're extremely welcome to fork a GitHub repository and add your input there.

Generated on Sun Aug 1 16:12:02 2010 for QOAuth by  doxygen 1.5.6