/yosdk/docs/html/classYahooApplication.html
HTML | 158 lines | 147 code | 10 blank | 1 comment | 0 complexity | f5b421b74941a9da84182fa09946e1db MD5 | raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
- <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
- <title>Yahoo! OS SDK - PHP: YahooApplication Class 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.5.8 -->
- <div class="navigation" id="top">
- <div class="tabs">
- <ul>
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- </ul>
- </div>
- <div class="tabs">
- <ul>
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- </div>
- <div class="contents">
- <h1>YahooApplication Class Reference</h1><!-- doxytag: class="YahooApplication" -->Represents a Yahoo! application.
- <a href="#_details">More...</a>
- <p>
- <p>
- <a href="classYahooApplication-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
- <tr><td></td></tr>
- <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#23916689357b866cd81e6234095b2cdf">YahooApplication</a> ($consumerKey, $consumerKeySecret)</td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#fbe6567acf8a84fcc8a282198923d5ba">setSmallView</a> ($guid, $content)</td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#883d44d58aa880d3c68e93405085f070">query</a> ($yql, $env=NULL)</td></tr>
- </table>
- <hr><a name="_details"></a><h2>Detailed Description</h2>
- Represents a Yahoo! application. <hr><h2>Member Function Documentation</h2>
- <a class="anchor" name="883d44d58aa880d3c68e93405085f070"></a><!-- doxytag: member="YahooApplication::query" ref="883d44d58aa880d3c68e93405085f070" args="($yql, $env=NULL)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">YahooApplication::query </td>
- <td>(</td>
- <td class="paramtype">$ </td>
- <td class="paramname"> <em>yql</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">$ </td>
- <td class="paramname"> <em>env</em> = <code>NULL</code></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>
- Executes the given YQL query.<p>
- <dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"></td><td valign="top"><em>$yql</em> </td><td>The query to execute. </td></tr>
- <tr><td valign="top"></td><td valign="top"><em>$env</em> </td><td>A URL to a YQL environment file. </td></tr>
- </table>
- </dl>
- <dl class="return" compact><dt><b>Returns:</b></dt><dd>The response or NULL if the request fails.. </dd></dl>
- </div>
- </div><p>
- <a class="anchor" name="fbe6567acf8a84fcc8a282198923d5ba"></a><!-- doxytag: member="YahooApplication::setSmallView" ref="fbe6567acf8a84fcc8a282198923d5ba" args="($guid, $content)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">YahooApplication::setSmallView </td>
- <td>(</td>
- <td class="paramtype">$ </td>
- <td class="paramname"> <em>guid</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">$ </td>
- <td class="paramname"> <em>content</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>
- Sets the small view for the user given by the GUID.<p>
- <dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"></td><td valign="top"><em>$guid</em> </td><td>The GUID of the user to set the small view for. </td></tr>
- <tr><td valign="top"></td><td valign="top"><em>$content</em> </td><td>The content to set the small view to. </td></tr>
- </table>
- </dl>
- <dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false otherwise. </dd></dl>
- </div>
- </div><p>
- <a class="anchor" name="23916689357b866cd81e6234095b2cdf"></a><!-- doxytag: member="YahooApplication::YahooApplication" ref="23916689357b866cd81e6234095b2cdf" args="($consumerKey, $consumerKeySecret)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">YahooApplication::YahooApplication </td>
- <td>(</td>
- <td class="paramtype">$ </td>
- <td class="paramname"> <em>consumerKey</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">$ </td>
- <td class="paramname"> <em>consumerKeySecret</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>
- Constructs a new <a class="el" href="classYahooApplication.html" title="Represents a Yahoo! application.">YahooApplication</a> object.<p>
- <dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"></td><td valign="top"><em>$consumerKey</em> </td><td>The consumer key of the application. </td></tr>
- <tr><td valign="top"></td><td valign="top"><em>$consumerKeySecret</em> </td><td>The consumer key secret of the application. </td></tr>
- </table>
- </dl>
- </div>
- </div><p>
- <hr>The documentation for this class was generated from the following file:<ul>
- <li>lib/Yahoo.inc</ul>
- </div>
- <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 18 14:55:31 2009 for Yahoo! OS SDK - PHP by
- <a href="http://www.doxygen.org/index.html">
- <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
- </body>
- </html>