<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>QOAuth: src/qoauth_namespace.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#namespaces">Namespaces</a> | <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>src/qoauth_namespace.h File Reference</h1> </div> </div> <div class="contents"> <code>#include <QMultiMap></code><br/> <code>#include <QByteArray></code><br/> <code>#include "<a class="el" href="qoauth__global_8h_source.html">qoauth_global.h</a>"</code><br/> <p><a href="qoauth__namespace_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="namespaces"></a> Namespaces</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html">QOAuth</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This namespace encapsulates all classes and definitions provided by libqoauth. </p> <br/></td></tr> </p> <tr><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a001535b7fdb06cc9d34cad1af27d2f"></a><!-- doxytag: member="qoauth_namespace.h::ParamMap" ref="a4a001535b7fdb06cc9d34cad1af27d2f" args="" --> typedef QMultiMap< QByteArray, <br class="typebreak"/> QByteArray > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a4a001535b7fdb06cc9d34cad1af27d2f">QOAuth::ParamMap</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A typedef for the data structure for storing request parameters. <br/></td></tr> <tr><td colspan="2"><h2><a name="enum-members"></a> Enumerations</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">QOAuth::SignatureMethod</a> { <a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fa74bc0d418aa61ebf3efc38282d6d22b0">QOAuth::HMAC_SHA1</a>, <a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fad9558ec24221a8aaba51ac44d48c90f2">QOAuth::RSA_SHA1</a>, <a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fad62af8a1d2ad0aa70d266917067e0cbd">QOAuth::PLAINTEXT</a> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum type describes the signature method used by the request. </p> <a href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">QOAuth::HttpMethod</a> { <br/> <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319a7c85f104ca7dd13458329f66207f6be4">QOAuth::GET</a>, <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319af8cfac32beb6ddefef094014cfa8d60b">QOAuth::POST</a>, <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319a3e8ed32617cd0fbd51f10dd5f686ef57">QOAuth::HEAD</a>, <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319ac5c2b091a476fe2705ddf28dc32b13f7">QOAuth::PUT</a>, <br/> <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319a093fd98d3154ee52c88f466f92035b3c">QOAuth::DELETE</a> <br/> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum type specifies the HTTP method used for creating a <a href="http://oauth.net/core/1.0/#anchor14">Signature Base String</a> and/or sending a request. </p> <a href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4">QOAuth::ParsingMode</a> { <a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4ad28f70298ea8c4c1bec8c9c27b0aeaf5">QOAuth::ParseForRequestContent</a>, <a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4ad5e9093e69391cce3735734f909cf759">QOAuth::ParseForInlineQuery</a>, <a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4a6c2747775846e2d5e7c96f7db6314d28">QOAuth::ParseForHeaderArguments</a>, <a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4ad12a3ed424be9e87704f138dc28804cf">QOAuth::ParseForSignatureBaseString</a> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum type specifies the method of parsing parameters into a parameter string. </p> <a href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137">QOAuth::ErrorCode</a> { <br/> <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137acd78d96aa204e78fe3a3b3d9197b00e9">QOAuth::NoError</a> = 200, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a03853d821a7cb2f8df693c031333d80a">QOAuth::BadRequest</a> = 400, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a03d29f6b9d0f2675d4ceea297f1df9fe">QOAuth::Unauthorized</a> = 401, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137afeedd3cb28fe0fef4831bc02fc9c9a4f">QOAuth::Forbidden</a> = 403, <br/> <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a6ad252dcc734f5df5177cbadb7aa347b">QOAuth::Timeout</a> = 1001, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a68d83fbe8a9177a62055a0436acba730">QOAuth::ConsumerKeyEmpty</a>, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137ae2dd54170fbec86792f903d3783b56d2">QOAuth::ConsumerSecretEmpty</a>, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a834b1b12690f8cd7f97b8c4c576b4247">QOAuth::UnsupportedHttpMethod</a>, <br/> <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a0fe52c1f836a69c7c9e0f0988f5a6d35">QOAuth::RSAPrivateKeyEmpty</a> = 1101, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a7a547bd32c7474766969573dad8e5694">QOAuth::RSADecodingError</a>, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a8099e324c0dcef5b2267427edc833bdb">QOAuth::RSAKeyFileError</a>, <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137ab7f420565c23868e81b73a4efd62f256">QOAuth::OtherError</a> <br/> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum type defines error types that are assigned to the <a class="el" href="class_q_o_auth_1_1_interface.html#a99c6f33258eccdb3d6ea28e4944f94e9">QOAuth::Interface::error</a> property. </p> <a href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa83657be57a2092cbf6a51a49b44e7c1"></a><!-- doxytag: member="qoauth_namespace.h::supportedOAuthVersion" ref="aa83657be57a2092cbf6a51a49b44e7c1" args="()" --> QOAUTH_EXPORT QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#aa83657be57a2092cbf6a51a49b44e7c1">QOAuth::supportedOAuthVersion</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the supported OAuth protocol version. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QOAUTH_EXPORT QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a84c62aa0297aa05562462798f3d7e910">QOAuth::tokenParameterName</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the Access Token argument parameter (<code>oauth_token</code> in current implementation). <a href="#a84c62aa0297aa05562462798f3d7e910"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QOAUTH_EXPORT QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#ae1a36aa1528f69b04e74d5d3e6364393">QOAuth::tokenSecretParameterName</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the Token Secret argument parameter (<code>oauth_token_secret</code> in current implementation). <a href="#ae1a36aa1528f69b04e74d5d3e6364393"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This file is a part of libqoauth. You should not include it directly in your application. Instead please use <code>#include <QtOAuth></code>. </p> </div> <hr class="footer"/><address class="footer"><small>Generated on Sun Aug 8 2010 for QOAuth by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> </body> </html>