<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QOAuth: QOAuth Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">QOAuth
 <span id="projectnumber">1.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">QOAuth Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This namespace encapsulates all classes and definitions provided by libqoauth.
</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_o_auth_1_1_interface.html">Interface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This class provides means for interaction with network services supporting OAuth authorization scheme. <a href="class_q_o_auth_1_1_interface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a4a001535b7fdb06cc9d34cad1af27d2f"><td class="memItemLeft" align="right" valign="top"><a id="a4a001535b7fdb06cc9d34cad1af27d2f"></a>
typedef QMultiMap< QByteArray, QByteArray > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a4a001535b7fdb06cc9d34cad1af27d2f">ParamMap</a></td></tr>
<tr class="memdesc:a4a001535b7fdb06cc9d34cad1af27d2f"><td class="mdescLeft"> </td><td class="mdescRight">A typedef for the data structure for storing request parameters. <br /></td></tr>
<tr class="separator:a4a001535b7fdb06cc9d34cad1af27d2f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a4cc48c641aa9025d289d7d7e013f766f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">SignatureMethod</a> { <a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fa74bc0d418aa61ebf3efc38282d6d22b0">HMAC_SHA1</a>,
<a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fad9558ec24221a8aaba51ac44d48c90f2">RSA_SHA1</a>,
<a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fad62af8a1d2ad0aa70d266917067e0cbd">PLAINTEXT</a>
}<tr class="memdesc:a4cc48c641aa9025d289d7d7e013f766f"><td class="mdescLeft"> </td><td class="mdescRight">This enum type describes the signature method used by the request. <a href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a4cc48c641aa9025d289d7d7e013f766f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0e0bd4d8c1802873d3b3d2deb099319"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">HttpMethod</a> { <br />
  <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319a7c85f104ca7dd13458329f66207f6be4">GET</a>,
<a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319af8cfac32beb6ddefef094014cfa8d60b">POST</a>,
<a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319a3e8ed32617cd0fbd51f10dd5f686ef57">HEAD</a>,
<a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319ac5c2b091a476fe2705ddf28dc32b13f7">PUT</a>,
<br />
  <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319a093fd98d3154ee52c88f466f92035b3c">DELETE</a>
<br />
}<tr class="memdesc:aa0e0bd4d8c1802873d3b3d2deb099319"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:aa0e0bd4d8c1802873d3b3d2deb099319"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a442456118c9a45ac446554f17620def4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4">ParsingMode</a> { <a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4ad28f70298ea8c4c1bec8c9c27b0aeaf5">ParseForRequestContent</a>,
<a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4ad5e9093e69391cce3735734f909cf759">ParseForInlineQuery</a>,
<a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4a6c2747775846e2d5e7c96f7db6314d28">ParseForHeaderArguments</a>,
<a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4ad12a3ed424be9e87704f138dc28804cf">ParseForSignatureBaseString</a>
}<tr class="memdesc:a442456118c9a45ac446554f17620def4"><td class="mdescLeft"> </td><td class="mdescRight">This enum type specifies the method of parsing parameters into a parameter string. <a href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a442456118c9a45ac446554f17620def4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38fb8bcd101c339c7fd77b5de22df137"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137">ErrorCode</a> { <br />
  <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137acd78d96aa204e78fe3a3b3d9197b00e9">NoError</a> = 200,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a03853d821a7cb2f8df693c031333d80a">BadRequest</a> = 400,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a03d29f6b9d0f2675d4ceea297f1df9fe">Unauthorized</a> = 401,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137afeedd3cb28fe0fef4831bc02fc9c9a4f">Forbidden</a> = 403,
<br />
  <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a6ad252dcc734f5df5177cbadb7aa347b">Timeout</a> = 1001,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a68d83fbe8a9177a62055a0436acba730">ConsumerKeyEmpty</a>,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137ae2dd54170fbec86792f903d3783b56d2">ConsumerSecretEmpty</a>,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a834b1b12690f8cd7f97b8c4c576b4247">UnsupportedHttpMethod</a>,
<br />
  <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a0fe52c1f836a69c7c9e0f0988f5a6d35">RSAPrivateKeyEmpty</a> = 1101,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a7a547bd32c7474766969573dad8e5694">RSADecodingError</a>,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137a8099e324c0dcef5b2267427edc833bdb">RSAKeyFileError</a>,
<a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137ab7f420565c23868e81b73a4efd62f256">OtherError</a>
<br />
}<tr class="memdesc:a38fb8bcd101c339c7fd77b5de22df137"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a38fb8bcd101c339c7fd77b5de22df137"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa83657be57a2092cbf6a51a49b44e7c1"><td class="memItemLeft" align="right" valign="top"><a id="aa83657be57a2092cbf6a51a49b44e7c1"></a>
QOAUTH_EXPORT QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_q_o_auth.html#aa83657be57a2092cbf6a51a49b44e7c1">supportedOAuthVersion</a> ()</td></tr>
<tr class="memdesc:aa83657be57a2092cbf6a51a49b44e7c1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the supported OAuth protocol version. <br /></td></tr>
<tr class="separator:aa83657be57a2092cbf6a51a49b44e7c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84c62aa0297aa05562462798f3d7e910"><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">tokenParameterName</a> ()</td></tr>
<tr class="memdesc:a84c62aa0297aa05562462798f3d7e910"><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">More...</a><br /></td></tr>
<tr class="separator:a84c62aa0297aa05562462798f3d7e910"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1a36aa1528f69b04e74d5d3e6364393"><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">tokenSecretParameterName</a> ()</td></tr>
<tr class="memdesc:ae1a36aa1528f69b04e74d5d3e6364393"><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">More...</a><br /></td></tr>
<tr class="separator:ae1a36aa1528f69b04e74d5d3e6364393"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a38fb8bcd101c339c7fd77b5de22df137"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38fb8bcd101c339c7fd77b5de22df137">§ </a></span>ErrorCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137">QOAuth::ErrorCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This error codes collection contains both network-related errors and those that can occur when incorrect arguments are provided to any of the class's methods.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_q_o_auth_1_1_interface.html#a99c6f33258eccdb3d6ea28e4944f94e9" title="This property holds the error code. ">QOAuth::Interface::error</a> </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137acd78d96aa204e78fe3a3b3d9197b00e9"></a>NoError </td><td class="fielddoc"><p>No error occured (so far :-) ) </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137a03853d821a7cb2f8df693c031333d80a"></a>BadRequest </td><td class="fielddoc"><p>Represents HTTP status code <code>400</code> (Bad Request) </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137a03d29f6b9d0f2675d4ceea297f1df9fe"></a>Unauthorized </td><td class="fielddoc"><p>Represents HTTP status code <code>401</code> (Unauthorized) </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137afeedd3cb28fe0fef4831bc02fc9c9a4f"></a>Forbidden </td><td class="fielddoc"><p>Represents HTTP status code <code>403</code> (Forbidden) </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137a6ad252dcc734f5df5177cbadb7aa347b"></a>Timeout </td><td class="fielddoc"><p>Represents a request timeout error. </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137a68d83fbe8a9177a62055a0436acba730"></a>ConsumerKeyEmpty </td><td class="fielddoc"><p>Consumer key has not been provided. </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137ae2dd54170fbec86792f903d3783b56d2"></a>ConsumerSecretEmpty </td><td class="fielddoc"><p>Consumer secret has not been provided. </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137a834b1b12690f8cd7f97b8c4c576b4247"></a>UnsupportedHttpMethod </td><td class="fielddoc"><p>The HTTP method is not supported by the request. </p><dl class="section note"><dt>Note</dt><dd><a class="el" href="class_q_o_auth_1_1_interface.html#a6b7efa2ba4271451faf108ad4f3b6c48">QOAuth::Interface::requestToken()</a> and <a class="el" href="class_q_o_auth_1_1_interface.html#a5ed464673068dcef2fdf5182f9f7c966">QOAuth::Interface::accessToken()</a> accept only HTTP GET and POST requests. </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137a0fe52c1f836a69c7c9e0f0988f5a6d35"></a>RSAPrivateKeyEmpty </td><td class="fielddoc"><p>RSA private key has not been provided. </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137a7a547bd32c7474766969573dad8e5694"></a>RSADecodingError </td><td class="fielddoc"><p>There was a problem decoding the RSA private key (the key is invalid or the provided passphrase is incorrect) </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137a8099e324c0dcef5b2267427edc833bdb"></a>RSAKeyFileError </td><td class="fielddoc"><p>The provided key file either doesn't exist or is unreadable. </p>
</td></tr>
<tr><td class="fieldname"><a id="a38fb8bcd101c339c7fd77b5de22df137ab7f420565c23868e81b73a4efd62f256"></a>OtherError </td><td class="fielddoc"><p>A network-related error not specified above. </p>
</td></tr>
</table>
</div>
</div>
<a id="aa0e0bd4d8c1802873d3b3d2deb099319"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0e0bd4d8c1802873d3b3d2deb099319">§ </a></span>HttpMethod</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">QOAuth::HttpMethod</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The HTTP method has to be specified in <a class="el" href="namespace_q_o_auth.html" title="This namespace encapsulates all classes and definitions provided by libqoauth. ">QOAuth</a> class for two reasons: </p><ul>
<li>to know what type of request should be prepared and sent (<a class="el" href="class_q_o_auth_1_1_interface.html#a6b7efa2ba4271451faf108ad4f3b6c48">QOAuth::Interface::requestToken()</a> and <a class="el" href="class_q_o_auth_1_1_interface.html#a5ed464673068dcef2fdf5182f9f7c966">QOAuth::Interface::accessToken()</a>), </li>
<li>to prepare a correct signature, as the Signature Base String contains a parameter specifying the HTTP method used for request (<a class="el" href="class_q_o_auth_1_1_interface.html#a8800fd422be18c977a04db9679066938">QOAuth::Interface::createParametersString()</a>).</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>For <a class="el" href="class_q_o_auth_1_1_interface.html#a6b7efa2ba4271451faf108ad4f3b6c48">QOAuth::Interface::requestToken()</a> and <a class="el" href="class_q_o_auth_1_1_interface.html#a5ed464673068dcef2fdf5182f9f7c966">QOAuth::Interface::accessToken()</a> methods only <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319a7c85f104ca7dd13458329f66207f6be4">GET</a> and <a class="el" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319af8cfac32beb6ddefef094014cfa8d60b">POST</a> methods are allowed. </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa0e0bd4d8c1802873d3b3d2deb099319a7c85f104ca7dd13458329f66207f6be4"></a>GET </td><td class="fielddoc"><p>Sets the HTTP method to GET. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa0e0bd4d8c1802873d3b3d2deb099319af8cfac32beb6ddefef094014cfa8d60b"></a>POST </td><td class="fielddoc"><p>Sets the HTTP method to POST. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa0e0bd4d8c1802873d3b3d2deb099319a3e8ed32617cd0fbd51f10dd5f686ef57"></a>HEAD </td><td class="fielddoc"><p>Sets the HTTP method to HEAD. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa0e0bd4d8c1802873d3b3d2deb099319ac5c2b091a476fe2705ddf28dc32b13f7"></a>PUT </td><td class="fielddoc"><p>Sets the HTTP method to PUT. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa0e0bd4d8c1802873d3b3d2deb099319a093fd98d3154ee52c88f466f92035b3c"></a>DELETE </td><td class="fielddoc"><p>Sets the HTTP method to DELETE. </p>
</td></tr>
</table>
</div>
</div>
<a id="a442456118c9a45ac446554f17620def4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a442456118c9a45ac446554f17620def4">§ </a></span>ParsingMode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4">QOAuth::ParsingMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>When creating a parameters string for a custom request using <a class="el" href="class_q_o_auth_1_1_interface.html#a8800fd422be18c977a04db9679066938">QOAuth::Interface::createParametersString()</a> the parsing mode must be defined in order to prepare the string correctly.</p>
<p>According to what is stated in <a href="http://oauth.net/core/1.0/#consumer_req_param">OAuth 1.0 Core specification</a>, parameters can be passed in a request to the Service Provider in 3 different ways. When using <a class="el" href="class_q_o_auth_1_1_interface.html#a8800fd422be18c977a04db9679066938">QOAuth::Interface::createParametersString()</a>, choose the one that suits you by setting <em>ParsingMode</em> appropriatelly.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_q_o_auth_1_1_interface.html#a8800fd422be18c977a04db9679066938">QOAuth::Interface::createParametersString()</a> </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a442456118c9a45ac446554f17620def4ad28f70298ea8c4c1bec8c9c27b0aeaf5"></a>ParseForRequestContent </td><td class="fielddoc"><p>Inline query format (<code>foo=bar&bar=baz&baz=foo ...</code>), suitable for POST requests. </p>
</td></tr>
<tr><td class="fieldname"><a id="a442456118c9a45ac446554f17620def4ad5e9093e69391cce3735734f909cf759"></a>ParseForInlineQuery </td><td class="fielddoc"><p>Same as ParseForRequestContent, but prepends the string with a question mark - suitable for GET requests (appending parameters to the request URL) </p>
</td></tr>
<tr><td class="fieldname"><a id="a442456118c9a45ac446554f17620def4a6c2747775846e2d5e7c96f7db6314d28"></a>ParseForHeaderArguments </td><td class="fielddoc"><p>HTTP request header format (parameters to be put inside a request header) </p>
</td></tr>
<tr><td class="fieldname"><a id="a442456118c9a45ac446554f17620def4ad12a3ed424be9e87704f138dc28804cf"></a>ParseForSignatureBaseString </td><td class="fielddoc"><p><a href="http://oauth.net/core/1.0/#anchor14">Signature Base String</a> format, meant for internal use. </p>
</td></tr>
</table>
</div>
</div>
<a id="a4cc48c641aa9025d289d7d7e013f766f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cc48c641aa9025d289d7d7e013f766f">§ </a></span>SignatureMethod</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">QOAuth::SignatureMethod</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>There are 3 different signature methods defined by the <a href="http://oauth.net/core/1.0/#signing_process">OAuth protocol</a>. This enum is used to specify the method used by a specific request. Hence, one of its values must be passed as a parameter in any of the <a class="el" href="class_q_o_auth_1_1_interface.html#a6b7efa2ba4271451faf108ad4f3b6c48">QOAuth::Interface::requestToken()</a>, <a class="el" href="class_q_o_auth_1_1_interface.html#a5ed464673068dcef2fdf5182f9f7c966">QOAuth::Interface::accessToken()</a> or <a class="el" href="class_q_o_auth_1_1_interface.html#a8800fd422be18c977a04db9679066938">QOAuth::Interface::createParametersString()</a> method. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4cc48c641aa9025d289d7d7e013f766fa74bc0d418aa61ebf3efc38282d6d22b0"></a>HMAC_SHA1 </td><td class="fielddoc"><p>Sets the signature method to HMAC-SHA1. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4cc48c641aa9025d289d7d7e013f766fad9558ec24221a8aaba51ac44d48c90f2"></a>RSA_SHA1 </td><td class="fielddoc"><p>Sets the signature method to RSA-SHA1 (not implemented yet) </p>
</td></tr>
<tr><td class="fieldname"><a id="a4cc48c641aa9025d289d7d7e013f766fad62af8a1d2ad0aa70d266917067e0cbd"></a>PLAINTEXT </td><td class="fielddoc"><p>Sets the signature method to PLAINTEXT (not implemented yet) </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a84c62aa0297aa05562462798f3d7e910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84c62aa0297aa05562462798f3d7e910">§ </a></span>tokenParameterName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QByteArray QOAuth::tokenParameterName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Useful when reading Service Provider's reply for <a class="el" href="class_q_o_auth_1_1_interface.html#a5ed464673068dcef2fdf5182f9f7c966">QOAuth::Interface::accessToken()</a> request, e.g: </p><div class="fragment"><div class="line"><a class="code" href="class_q_o_auth_1_1_interface.html">QOAuth::Interface</a> qoauth;</div><div class="line">QByteArray requestToken = <span class="stringliteral">"token"</span>;</div><div class="line">QByteArray requestTokenSecret = <span class="stringliteral">"secret"</span>;</div><div class="line"><a class="code" href="namespace_q_o_auth.html#a4a001535b7fdb06cc9d34cad1af27d2f">QOAuth::ParamMap</a> reply = qoauth.<a class="code" href="class_q_o_auth_1_1_interface.html#a5ed464673068dcef2fdf5182f9f7c966">accessToken</a>( <span class="stringliteral">"http://example.com/access_token"</span>, <a class="code" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319af8cfac32beb6ddefef094014cfa8d60b">QOAuth::POST</a>,</div><div class="line"> token, tokenSecret, <a class="code" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fa74bc0d418aa61ebf3efc38282d6d22b0">QOAuth::HMAC_SHA1</a> );</div><div class="line"></div><div class="line"><span class="keywordflow">if</span> ( qoauth.<a class="code" href="class_q_o_auth_1_1_interface.html#a99c6f33258eccdb3d6ea28e4944f94e9">error</a>() == <a class="code" href="namespace_q_o_auth.html#a38fb8bcd101c339c7fd77b5de22df137acd78d96aa204e78fe3a3b3d9197b00e9">QOAuth::NoError</a> ) {</div><div class="line"> token = reply.value( <a class="code" href="namespace_q_o_auth.html#a84c62aa0297aa05562462798f3d7e910">QOAuth::tokenParameterName</a>() );</div><div class="line"> tokenSecret = reply.value( <a class="code" href="namespace_q_o_auth.html#ae1a36aa1528f69b04e74d5d3e6364393">QOAuth::tokenSecretParameterName</a>() );</div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="ae1a36aa1528f69b04e74d5d3e6364393"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1a36aa1528f69b04e74d5d3e6364393">§ </a></span>tokenSecretParameterName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QByteArray QOAuth::tokenSecretParameterName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_q_o_auth.html#a84c62aa0297aa05562462798f3d7e910" title="Returns the name of the Access Token argument parameter (oauth_token in current implementation) ...">QOAuth::tokenParameterName()</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
