| {{+bindTo:partials.standard_nacl_api}} |
| <h1>pp::URLResponseInfo Class Reference</h1> |
| <div id="doxygen-ref"> |
| {{- dummy div to appease doxygen -}} |
| <div> |
| <!-- Generated by Doxygen 1.7.6.1 --> |
| |
| |
| |
| </div> |
| <!--header--> |
| <div class="contents"> |
| <!-- doxytag: class="pp::URLResponseInfo" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader"> |
| Inheritance diagram for pp::URLResponseInfo:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classpp_1_1_u_r_l_response_info__inherit__graph.png" border="0" usemap="#pp_1_1_u_r_l_response_info_inherit__map" alt="Inheritance graph" /></div> |
| <map name="pp_1_1_u_r_l_response_info_inherit__map" id="pp_1_1_u_r_l_response_info_inherit__map"> |
| <area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="29,5,133,32"></area></map> |
| <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
| <p><a href="classpp_1_1_u_r_l_response_info-members.html">List of all members.</a></p> |
| <h2> |
| Public Member Functions</h2><table class="memberdecls"> |
| |
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">URLResponseInfo</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a157bf323368bc4b7e63ce604ecc272c1">URLResponseInfo</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, PP_Resource resource)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#aa2fb382084c248e56dffb09e1191a6f1">URLResponseInfo</a> (const <a class="el" href="classpp_1_1_u_r_l_response_info.html">URLResponseInfo</a> &other)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#ac30d83aa38148e6d90f3c22ab01b10dc">GetProperty</a> (PP_URLResponseProperty property) const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_file_ref.html">FileRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a77debd316d7b575b6cae43cb1bb14cbc">GetBodyAsFileRef</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#ad53acecc41062e0b60167b78c268a0bb">GetURL</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a6c25ffe56f7d9da0817fd84346bbaf10">GetRedirectURL</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a3ae355f52b46a6d2e65fed19bfcec323">GetRedirectMethod</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#aa7d27c0d6af582dc374461c8d0f868b3">GetStatusCode</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#aa6b506dff751344d0b85f596ab1a41a8">GetStatusLine</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#ae1fbc3ec4025534fbbf7e152af8308c7">GetHeaders</a> () const </td></tr> |
| </table> |
| <hr /><a name="details" id="details"></a><h2>Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classpp_1_1_u_r_l_response_info.html" title="URLResponseInfo provides an API for examining URL responses.">URLResponseInfo</a> provides an API for examining URL responses. </p> |
| </div><hr /><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a239b1eb1076f2da6c75af416c8f02e6b"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="a239b1eb1076f2da6c75af416c8f02e6b" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Default constructor. </p> |
| <p>This constructor creates an <code>is_null</code> resource. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a157bf323368bc4b7e63ce604ecc272c1"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="a157bf323368bc4b7e63ce604ecc272c1" args="(PassRef, PP_Resource resource)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a> </td> |
| <td class="paramname">, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">PP_Resource </td> |
| <td class="paramname"><em>resource</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>A constructor used when you have received a <code>PP_Resource</code> as a return value that has already been reference counted. </p> |
| <dl class="params"><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a resource. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="aa2fb382084c248e56dffb09e1191a6f1"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="aa2fb382084c248e56dffb09e1191a6f1" args="(const URLResponseInfo &other)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classpp_1_1_u_r_l_response_info.html">URLResponseInfo</a> & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>The copy constructor for <code><a class="el" href="classpp_1_1_u_r_l_response_info.html" title="URLResponseInfo provides an API for examining URL responses.">URLResponseInfo</a></code>. </p> |
| </div> |
| </div> |
| <hr /><h2>Member Function Documentation</h2> |
| <a class="anchor" id="a77debd316d7b575b6cae43cb1bb14cbc"></a><!-- doxytag: member="pp::URLResponseInfo::GetBodyAsFileRef" ref="a77debd316d7b575b6cae43cb1bb14cbc" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_file_ref.html">FileRef</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#a77debd316d7b575b6cae43cb1bb14cbc">pp::URLResponseInfo::GetBodyAsFileRef</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function returns a <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> pointing to the file containing the response body. </p> |
| <p>This is only valid if <code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> was set on the <code><a class="el" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests.">URLRequestInfo</a></code> used to produce this response. This file remains valid until the <code><a class="el" href="classpp_1_1_u_r_l_loader.html" title="URLLoader provides an API for loading URLs.">URLLoader</a></code> associated with this <code><a class="el" href="classpp_1_1_u_r_l_response_info.html" title="URLResponseInfo provides an API for examining URL responses.">URLResponseInfo</a></code> is closed or destroyed.</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> corresponding to a <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> if successful, an <code>is_null</code> object if <code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> was not requested or if the <code><a class="el" href="classpp_1_1_u_r_l_loader.html" title="URLLoader provides an API for loading URLs.">URLLoader</a></code> has not been opened yet. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="ae1fbc3ec4025534fbbf7e152af8308c7"></a><!-- doxytag: member="pp::URLResponseInfo::GetHeaders" ref="ae1fbc3ec4025534fbbf7e152af8308c7" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#ae1fbc3ec4025534fbbf7e152af8308c7">pp::URLResponseInfo::GetHeaders</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function gets the <code>PP_URLRESPONSEPROPERTY_HEADERS</code> property for the response. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="ac30d83aa38148e6d90f3c22ab01b10dc"></a><!-- doxytag: member="pp::URLResponseInfo::GetProperty" ref="ac30d83aa38148e6d90f3c22ab01b10dc" args="(PP_URLResponseProperty property) const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#ac30d83aa38148e6d90f3c22ab01b10dc">pp::URLResponseInfo::GetProperty</a> </td> |
| <td>(</td> |
| <td class="paramtype">PP_URLResponseProperty </td> |
| <td class="paramname"><em>property</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function gets a response property. </p> |
| <dl class="params"><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>A <code>PP_URLResponseProperty</code> identifying the type of property in the response.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a3ae355f52b46a6d2e65fed19bfcec323"></a><!-- doxytag: member="pp::URLResponseInfo::GetRedirectMethod" ref="a3ae355f52b46a6d2e65fed19bfcec323" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#a3ae355f52b46a6d2e65fed19bfcec323">pp::URLResponseInfo::GetRedirectMethod</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function gets the <code>PP_URLRESPONSEPROPERTY_REDIRECTMETHOD</code> property for the response. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a6c25ffe56f7d9da0817fd84346bbaf10"></a><!-- doxytag: member="pp::URLResponseInfo::GetRedirectURL" ref="a6c25ffe56f7d9da0817fd84346bbaf10" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#a6c25ffe56f7d9da0817fd84346bbaf10">pp::URLResponseInfo::GetRedirectURL</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function gets the <code>PP_URLRESPONSEPROPERTY_REDIRECTURL</code> property for the response. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="aa7d27c0d6af582dc374461c8d0f868b3"></a><!-- doxytag: member="pp::URLResponseInfo::GetStatusCode" ref="aa7d27c0d6af582dc374461c8d0f868b3" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t <a class="el" href="classpp_1_1_u_r_l_response_info.html#aa7d27c0d6af582dc374461c8d0f868b3">pp::URLResponseInfo::GetStatusCode</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function gets the <code>PP_URLRESPONSEPROPERTY_STATUSCODE</code> property for the response. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>A int32_t containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="aa6b506dff751344d0b85f596ab1a41a8"></a><!-- doxytag: member="pp::URLResponseInfo::GetStatusLine" ref="aa6b506dff751344d0b85f596ab1a41a8" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#aa6b506dff751344d0b85f596ab1a41a8">pp::URLResponseInfo::GetStatusLine</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function gets the <code>PP_URLRESPONSEPROPERTY_STATUSLINE</code> property for the response. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="ad53acecc41062e0b60167b78c268a0bb"></a><!-- doxytag: member="pp::URLResponseInfo::GetURL" ref="ad53acecc41062e0b60167b78c268a0bb" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#ad53acecc41062e0b60167b78c268a0bb">pp::URLResponseInfo::GetURL</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function gets the <code>PP_URLRESPONSEPROPERTY_URL</code> property for the response. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl> |
| </div> |
| </div> |
| <hr />The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="url__response__info_8h.html">url_response_info.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div> |
| {{/partials.standard_nacl_api}} |
