<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.oauth.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'oauth.constants.php',
    1 => 'Predefined Constants',
    2 => 'Predefined Constants',
  ),
  'up' => 
  array (
    0 => 'book.oauth.php',
    1 => 'OAuth',
  ),
  'prev' => 
  array (
    0 => 'oauth.installation.php',
    1 => 'Installation',
  ),
  'next' => 
  array (
    0 => 'oauth.examples.php',
    1 => 'Examples',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/oauth/constants.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="oauth.constants" class="appendix">
 <h1 class="title">Predefined Constants</h1>

 <p class="simpara">
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</p>
 <p class="simpara">
  Most of these constants involve problems, which are also described within the official
  OAuth <a href="http://wiki.oauth.net/ProblemReporting" class="link external">&raquo;&nbsp;Problem Reporting</a>
  documentation. Note however, that these constant names are specific to PHP, although
  the naming scheme is similar.
 </p>
 <dl>
  
  
   <dt id="constant.oauth-sig-method-rsasha1">
    <strong><code><a href="oauth.constants.php#constant.oauth-sig-method-rsasha1">OAUTH_SIG_METHOD_RSASHA1</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     OAuth <em>RSA-SHA1</em> signature method.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-sig-method-hmacsha1">
    <strong><code><a href="oauth.constants.php#constant.oauth-sig-method-hmacsha1">OAUTH_SIG_METHOD_HMACSHA1</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     OAuth <em>HMAC-SHA1</em> signature method.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-sig-method-hmacsha256">
    <strong><code><a href="oauth.constants.php#constant.oauth-sig-method-hmacsha256">OAUTH_SIG_METHOD_HMACSHA256</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     OAuth <em>HMAC-SHA256</em> signature method.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-auth-type-authorization">
    <strong><code><a href="oauth.constants.php#constant.oauth-auth-type-authorization">OAUTH_AUTH_TYPE_AUTHORIZATION</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     This constant represents putting OAuth parameters in the
     <code class="literal">Authorization</code> header.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-auth-type-none">
    <strong><code><a href="oauth.constants.php#constant.oauth-auth-type-none">OAUTH_AUTH_TYPE_NONE</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     This constant indicates a NoAuth OAuth request.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-auth-type-uri">
    <strong><code><a href="oauth.constants.php#constant.oauth-auth-type-uri">OAUTH_AUTH_TYPE_URI</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     This constant represents putting OAuth parameters in the request
     <abbr title="Uniform Resource Identifier">URI</abbr>.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-auth-type-form">
    <strong><code><a href="oauth.constants.php#constant.oauth-auth-type-form">OAUTH_AUTH_TYPE_FORM</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     This constant represents putting OAuth parameters as part of the
     HTTP POST body.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-http-method-get">
    <strong><code><a href="oauth.constants.php#constant.oauth-http-method-get">OAUTH_HTTP_METHOD_GET</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Use the <em>GET</em> method for the OAuth request.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-http-method-post">
    <strong><code><a href="oauth.constants.php#constant.oauth-http-method-post">OAUTH_HTTP_METHOD_POST</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Use the <em>POST</em> method for the OAuth request.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-http-method-put">
    <strong><code><a href="oauth.constants.php#constant.oauth-http-method-put">OAUTH_HTTP_METHOD_PUT</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Use the <em>PUT</em> method for the OAuth request.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-http-method-head">
    <strong><code><a href="oauth.constants.php#constant.oauth-http-method-head">OAUTH_HTTP_METHOD_HEAD</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Use the <em>HEAD</em> method for the OAuth request.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-http-method-delete">
    <strong><code><a href="oauth.constants.php#constant.oauth-http-method-delete">OAUTH_HTTP_METHOD_DELETE</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Use the <em>DELETE</em> method for the OAuth request.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-reqengine-streams">
    <strong><code><a href="oauth.constants.php#constant.oauth-reqengine-streams">OAUTH_REQENGINE_STREAMS</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Used by <span class="methodname"><a href="oauth.setrequestengine.php" class="methodname">OAuth::setRequestEngine()</a></span> to set the engine to
     <a href="book.stream.php" class="link">PHP streams</a>,
     as opposed to <strong><code><a href="oauth.constants.php#constant.oauth-reqengine-curl">OAUTH_REQENGINE_CURL</a></code></strong> for
     <a href="book.curl.php" class="link">Curl</a>.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-reqengine-curl">
    <strong><code><a href="oauth.constants.php#constant.oauth-reqengine-curl">OAUTH_REQENGINE_CURL</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Used by <span class="methodname"><a href="oauth.setrequestengine.php" class="methodname">OAuth::setRequestEngine()</a></span> to set the engine to
     <a href="book.curl.php" class="link">Curl</a>, as opposed to
     <strong><code><a href="oauth.constants.php#constant.oauth-reqengine-streams">OAUTH_REQENGINE_STREAMS</a></code></strong> for <a href="book.stream.php" class="link">PHP streams</a>.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-ok">
    <strong><code><a href="oauth.constants.php#constant.oauth-ok">OAUTH_OK</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Life is good.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-bad-nonce">
    <strong><code><a href="oauth.constants.php#constant.oauth-bad-nonce">OAUTH_BAD_NONCE</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
      The <em>oauth_nonce</em> value was used in a previous request,
      therefore it cannot be used now.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-bad-timestamp">
    <strong><code><a href="oauth.constants.php#constant.oauth-bad-timestamp">OAUTH_BAD_TIMESTAMP</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
      The <em>oauth_timestamp</em> value was not accepted by the service provider. In
      this case, the response should also contain the <em>oauth_acceptable_timestamps</em>
      parameter.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-consumer-key-unknown">
    <strong><code><a href="oauth.constants.php#constant.oauth-consumer-key-unknown">OAUTH_CONSUMER_KEY_UNKNOWN</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     The <em>oauth_consumer_key</em> is temporarily unacceptable to the service provider.
     For example, the service provider may be throttling the consumer.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-consumer-key-refused">
    <strong><code><a href="oauth.constants.php#constant.oauth-consumer-key-refused">OAUTH_CONSUMER_KEY_REFUSED</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     The consumer key was refused.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-invalid-signature">
    <strong><code><a href="oauth.constants.php#constant.oauth-invalid-signature">OAUTH_INVALID_SIGNATURE</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
      The <em>oauth_signature</em> is invalid, as it does not match the
      signature computed by the service provider.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-token-used">
    <strong><code><a href="oauth.constants.php#constant.oauth-token-used">OAUTH_TOKEN_USED</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     The <em>oauth_token</em> has been consumed. It can no longer be
     used because it has already been used in the previous request(s).
    </span>
   </dd>
  
  
   <dt id="constant.oauth-token-expired">
    <strong><code><a href="oauth.constants.php#constant.oauth-token-expired">OAUTH_TOKEN_EXPIRED</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     The <em>oauth_token</em> has expired.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-token-revoked">
    <strong><code><a href="oauth.constants.php#constant.oauth-token-revoked">OAUTH_TOKEN_REVOKED</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     The <em>oauth_token</em> has been revoked, and will never be accepted.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-token-rejected">
    <strong><code><a href="oauth.constants.php#constant.oauth-token-rejected">OAUTH_TOKEN_REJECTED</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     The <em>oauth_token</em> was not accepted by the service provider.
     The reason is not known, but it might be because the token was never issued,
     already consumed, expired, and/or forgotten by the service provider.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-verifier-invalid">
    <strong><code><a href="oauth.constants.php#constant.oauth-verifier-invalid">OAUTH_VERIFIER_INVALID</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     The <em>oauth_verifier</em> is incorrect.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-parameter-absent">
    <strong><code><a href="oauth.constants.php#constant.oauth-parameter-absent">OAUTH_PARAMETER_ABSENT</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     A required parameter was not received. In this case, the response should also
     contain the <em>oauth_parameters_absent</em> parameter.
    </span>
   </dd>
  
  
   <dt id="constant.oauth-signature-method-rejected">
    <strong><code><a href="oauth.constants.php#constant.oauth-signature-method-rejected">OAUTH_SIGNATURE_METHOD_REJECTED</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     The <em>oauth_signature_method</em> was not accepted by service provider.
    </span>
   </dd>
  
 </dl>
</div>
<?php manual_footer($setup); ?>