PageRenderTime 37ms CodeModel.GetById 11ms RepoModel.GetById 1ms app.codeStats 0ms

/yosdk/docs/html/classYahooApplication.html

http://github.com/petewarden/findbyemail
HTML | 158 lines | 147 code | 10 blank | 1 comment | 0 complexity | f5b421b74941a9da84182fa09946e1db MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
    3. 

  3. <title>Yahoo! OS SDK - PHP: YahooApplication Class Reference</title>
    4. 

  4. <link href="tabs.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="doxygen.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.5.8 -->
    8. 

  8. <div class="navigation" id="top">
    9. 

  9.   <div class="tabs">
    10. 

  10.     <ul>
    11. 

  11.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    12. 

  12.       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    13. 

  13.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    14. 

  14.     </ul>
    15. 

  15.   </div>
    16. 

  16.   <div class="tabs">
    17. 

  17.     <ul>
    18. 

  18.       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    19. 

  19.       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    20. 

  20.     </ul>
    21. 

  21.   </div>
    22. 

  22. </div>
    23. 

  23. <div class="contents">
    24. 

  24. <h1>YahooApplication Class Reference</h1><!-- doxytag: class="YahooApplication" -->Represents a Yahoo! application.  
    25. 

  25. <a href="#_details">More...</a>
    26. 

  26. <p>
    27. 

  27. 

  28. <p>
    29. 

  29. <a href="classYahooApplication-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
    30. 

  30. <tr><td></td></tr>
    31. 

  31. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
    32. 

  32. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#23916689357b866cd81e6234095b2cdf">YahooApplication</a> ($consumerKey, $consumerKeySecret)</td></tr>
    33. 

  33. 

  34. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#fbe6567acf8a84fcc8a282198923d5ba">setSmallView</a> ($guid, $content)</td></tr>
    35. 

  35. 

  36. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#883d44d58aa880d3c68e93405085f070">query</a> ($yql, $env=NULL)</td></tr>
    37. 

  37. 

  38. </table>
    39. 

  39. <hr><a name="_details"></a><h2>Detailed Description</h2>
    40. 

  40. Represents a Yahoo! application. <hr><h2>Member Function Documentation</h2>
    41. 

  41. <a class="anchor" name="883d44d58aa880d3c68e93405085f070"></a><!-- doxytag: member="YahooApplication::query" ref="883d44d58aa880d3c68e93405085f070" args="($yql, $env=NULL)" -->
    42. 

  42. <div class="memitem">
    43. 

  43. <div class="memproto">
    44. 

  44.       <table class="memname">
    45. 

  45.         <tr>
    46. 

  46.           <td class="memname">YahooApplication::query           </td>
    47. 

  47.           <td>(</td>
    48. 

  48.           <td class="paramtype">$&nbsp;</td>
    49. 

  49.           <td class="paramname"> <em>yql</em>, </td>
    50. 

  50.         </tr>
    51. 

  51.         <tr>
    52. 

  52.           <td class="paramkey"></td>
    53. 

  53.           <td></td>
    54. 

  54.           <td class="paramtype">$&nbsp;</td>
    55. 

  55.           <td class="paramname"> <em>env</em> = <code>NULL</code></td><td>&nbsp;</td>
    56. 

  56.         </tr>
    57. 

  57.         <tr>
    58. 

  58.           <td></td>
    59. 

  59.           <td>)</td>
    60. 

  60.           <td></td><td></td><td></td>
    61. 

  61.         </tr>
    62. 

  62.       </table>
    63. 

  63. </div>
    64. 

  64. <div class="memdoc">
    65. 

  65. 

  66. <p>
    67. 

  67. Executes the given YQL query.<p>
    68. 

  68. <dl compact><dt><b>Parameters:</b></dt><dd>
    69. 

  69.   <table border="0" cellspacing="2" cellpadding="0">
    70. 

  70.     <tr><td valign="top"></td><td valign="top"><em>$yql</em>&nbsp;</td><td>The query to execute. </td></tr>
    71. 

  71.     <tr><td valign="top"></td><td valign="top"><em>$env</em>&nbsp;</td><td>A URL to a YQL environment file. </td></tr>
    72. 

  72.   </table>
    73. 

  73. </dl>
    74. 

  74. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The response or NULL if the request fails.. </dd></dl>
    75. 

  75. 

  76. </div>
    77. 

  77. </div><p>
    78. 

  78. <a class="anchor" name="fbe6567acf8a84fcc8a282198923d5ba"></a><!-- doxytag: member="YahooApplication::setSmallView" ref="fbe6567acf8a84fcc8a282198923d5ba" args="($guid, $content)" -->
    79. 

  79. <div class="memitem">
    80. 

  80. <div class="memproto">
    81. 

  81.       <table class="memname">
    82. 

  82.         <tr>
    83. 

  83.           <td class="memname">YahooApplication::setSmallView           </td>
    84. 

  84.           <td>(</td>
    85. 

  85.           <td class="paramtype">$&nbsp;</td>
    86. 

  86.           <td class="paramname"> <em>guid</em>, </td>
    87. 

  87.         </tr>
    88. 

  88.         <tr>
    89. 

  89.           <td class="paramkey"></td>
    90. 

  90.           <td></td>
    91. 

  91.           <td class="paramtype">$&nbsp;</td>
    92. 

  92.           <td class="paramname"> <em>content</em></td><td>&nbsp;</td>
    93. 

  93.         </tr>
    94. 

  94.         <tr>
    95. 

  95.           <td></td>
    96. 

  96.           <td>)</td>
    97. 

  97.           <td></td><td></td><td></td>
    98. 

  98.         </tr>
    99. 

  99.       </table>
    100. 

  100. </div>
    101. 

  101. <div class="memdoc">
    102. 

  102. 

  103. <p>
    104. 

  104. Sets the small view for the user given by the GUID.<p>
    105. 

  105. <dl compact><dt><b>Parameters:</b></dt><dd>
    106. 

  106.   <table border="0" cellspacing="2" cellpadding="0">
    107. 

  107.     <tr><td valign="top"></td><td valign="top"><em>$guid</em>&nbsp;</td><td>The GUID of the user to set the small view for. </td></tr>
    108. 

  108.     <tr><td valign="top"></td><td valign="top"><em>$content</em>&nbsp;</td><td>The content to set the small view to. </td></tr>
    109. 

  109.   </table>
    110. 

  110. </dl>
    111. 

  111. <dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false otherwise. </dd></dl>
    112. 

  112. 

  113. </div>
    114. 

  114. </div><p>
    115. 

  115. <a class="anchor" name="23916689357b866cd81e6234095b2cdf"></a><!-- doxytag: member="YahooApplication::YahooApplication" ref="23916689357b866cd81e6234095b2cdf" args="($consumerKey, $consumerKeySecret)" -->
    116. 

  116. <div class="memitem">
    117. 

  117. <div class="memproto">
    118. 

  118.       <table class="memname">
    119. 

  119.         <tr>
    120. 

  120.           <td class="memname">YahooApplication::YahooApplication           </td>
    121. 

  121.           <td>(</td>
    122. 

  122.           <td class="paramtype">$&nbsp;</td>
    123. 

  123.           <td class="paramname"> <em>consumerKey</em>, </td>
    124. 

  124.         </tr>
    125. 

  125.         <tr>
    126. 

  126.           <td class="paramkey"></td>
    127. 

  127.           <td></td>
    128. 

  128.           <td class="paramtype">$&nbsp;</td>
    129. 

  129.           <td class="paramname"> <em>consumerKeySecret</em></td><td>&nbsp;</td>
    130. 

  130.         </tr>
    131. 

  131.         <tr>
    132. 

  132.           <td></td>
    133. 

  133.           <td>)</td>
    134. 

  134.           <td></td><td></td><td></td>
    135. 

  135.         </tr>
    136. 

  136.       </table>
    137. 

  137. </div>
    138. 

  138. <div class="memdoc">
    139. 

  139. 

  140. <p>
    141. 

  141. Constructs a new <a class="el" href="classYahooApplication.html" title="Represents a Yahoo! application.">YahooApplication</a> object.<p>
    142. 

  142. <dl compact><dt><b>Parameters:</b></dt><dd>
    143. 

  143.   <table border="0" cellspacing="2" cellpadding="0">
    144. 

  144.     <tr><td valign="top"></td><td valign="top"><em>$consumerKey</em>&nbsp;</td><td>The consumer key of the application. </td></tr>
    145. 

  145.     <tr><td valign="top"></td><td valign="top"><em>$consumerKeySecret</em>&nbsp;</td><td>The consumer key secret of the application. </td></tr>
    146. 

  146.   </table>
    147. 

  147. </dl>
    148. 

  148. 

  149. </div>
    150. 

  150. </div><p>
    151. 

  151. <hr>The documentation for this class was generated from the following file:<ul>
    152. 

  152. <li>lib/Yahoo.inc</ul>
    153. 

  153. </div>
    154. 

  154. <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 18 14:55:31 2009 for Yahoo! OS SDK - PHP by&nbsp;
    155. 

  155. <a href="http://www.doxygen.org/index.html">
    156. 

  156. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
    157. 

  157. </body>
    158. 

  158. </html>
    159. 

  159.