PageRenderTime 65ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/twitter.html

https://code.google.com/p/python-twitter/
HTML | 2026 lines | 1808 code | 218 blank | 0 comment | 0 complexity | 18efb984b94b1834ef5c0d1b27eb7127 MD5 | raw file
Possible License(s): Apache-2.0
  1. <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: module twitter</title>
  3. </head><body bgcolor="#f0f0f8">
  4. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
  5. <tr bgcolor="#7799ee">
  6. <td valign=bottom>&nbsp;<br>
  7. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>twitter</strong></big></big> (version 0.8)</font></td
  8. ><td align=right valign=bottom
  9. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="twitter.py">twitter.py</a></font></td></tr></table>
  10. <p><tt>A&nbsp;library&nbsp;that&nbsp;provides&nbsp;a&nbsp;Python&nbsp;interface&nbsp;to&nbsp;the&nbsp;Twitter&nbsp;API</tt></p>
  11. <p>
  12. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  13. <tr bgcolor="#aa55cc">
  14. <td colspan=3 valign=bottom>&nbsp;<br>
  15. <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  16. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  17. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="StringIO.html">StringIO</a><br>
  18. <a href="base64.html">base64</a><br>
  19. <a href="calendar.html">calendar</a><br>
  20. <a href="datetime.html">datetime</a><br>
  21. <a href="gzip.html">gzip</a><br>
  22. </td><td width="25%" valign=top><a href="httplib.html">httplib</a><br>
  23. <a href="oauth2.html">oauth2</a><br>
  24. <a href="os.html">os</a><br>
  25. <a href="rfc822.html">rfc822</a><br>
  26. <a href="json.html">json</a><br>
  27. </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
  28. <a href="tempfile.html">tempfile</a><br>
  29. <a href="textwrap.html">textwrap</a><br>
  30. <a href="time.html">time</a><br>
  31. <a href="urllib.html">urllib</a><br>
  32. </td><td width="25%" valign=top><a href="urllib2.html">urllib2</a><br>
  33. <a href="urlparse.html">urlparse</a><br>
  34. </td></tr></table></td></tr></table><p>
  35. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  36. <tr bgcolor="#ee77aa">
  37. <td colspan=3 valign=bottom>&nbsp;<br>
  38. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  39. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  40. <td width="100%"><dl>
  41. <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
  42. </font></dt><dd>
  43. <dl>
  44. <dt><font face="helvetica, arial"><a href="twitter.html#Api">Api</a>
  45. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#DirectMessage">DirectMessage</a>
  46. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Hashtag">Hashtag</a>
  47. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#List">List</a>
  48. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Status">Status</a>
  49. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Trend">Trend</a>
  50. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Url">Url</a>
  51. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#User">User</a>
  52. </font></dt></dl>
  53. </dd>
  54. <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
  55. </font></dt><dd>
  56. <dl>
  57. <dt><font face="helvetica, arial"><a href="twitter.html#TwitterError">TwitterError</a>
  58. </font></dt></dl>
  59. </dd>
  60. </dl>
  61. <p>
  62. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  63. <tr bgcolor="#ffc8d8">
  64. <td colspan=3 valign=bottom>&nbsp;<br>
  65. <font color="#000000" face="helvetica, arial"><a name="Api">class <strong>Api</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  66. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  67. <td colspan=2><tt>A&nbsp;python&nbsp;interface&nbsp;into&nbsp;the&nbsp;Twitter&nbsp;API<br>
  68. &nbsp;<br>
  69. By&nbsp;default,&nbsp;the&nbsp;<a href="#Api">Api</a>&nbsp;caches&nbsp;results&nbsp;for&nbsp;1&nbsp;minute.<br>
  70. &nbsp;<br>
  71. Example&nbsp;usage:<br>
  72. &nbsp;<br>
  73. &nbsp;&nbsp;To&nbsp;create&nbsp;an&nbsp;instance&nbsp;of&nbsp;the&nbsp;twitter.<a href="#Api">Api</a>&nbsp;class,&nbsp;with&nbsp;no&nbsp;authentication:<br>
  74. &nbsp;<br>
  75. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;import&nbsp;twitter<br>
  76. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api&nbsp;=&nbsp;twitter.<a href="#Api">Api</a>()<br>
  77. &nbsp;<br>
  78. &nbsp;&nbsp;To&nbsp;fetch&nbsp;the&nbsp;most&nbsp;recently&nbsp;posted&nbsp;public&nbsp;twitter&nbsp;status&nbsp;messages:<br>
  79. &nbsp;<br>
  80. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;statuses&nbsp;=&nbsp;api.<a href="#Api-GetPublicTimeline">GetPublicTimeline</a>()<br>
  81. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;print&nbsp;[s.user.name&nbsp;for&nbsp;s&nbsp;in&nbsp;statuses]<br>
  82. &nbsp;&nbsp;&nbsp;&nbsp;[u'DeWitt',&nbsp;u'Kesuke&nbsp;Miyagi',&nbsp;u'ev',&nbsp;u'Buzz&nbsp;Andersen',&nbsp;u'Biz&nbsp;Stone']&nbsp;#...<br>
  83. &nbsp;<br>
  84. &nbsp;&nbsp;To&nbsp;fetch&nbsp;a&nbsp;single&nbsp;user's&nbsp;public&nbsp;status&nbsp;messages,&nbsp;where&nbsp;"user"&nbsp;is&nbsp;either<br>
  85. &nbsp;&nbsp;a&nbsp;Twitter&nbsp;"short&nbsp;name"&nbsp;or&nbsp;their&nbsp;user&nbsp;id.<br>
  86. &nbsp;<br>
  87. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;statuses&nbsp;=&nbsp;api.<a href="#Api-GetUserTimeline">GetUserTimeline</a>(user)<br>
  88. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;print&nbsp;[s.text&nbsp;for&nbsp;s&nbsp;in&nbsp;statuses]<br>
  89. &nbsp;<br>
  90. &nbsp;&nbsp;To&nbsp;use&nbsp;authentication,&nbsp;instantiate&nbsp;the&nbsp;twitter.<a href="#Api">Api</a>&nbsp;class&nbsp;with&nbsp;a<br>
  91. &nbsp;&nbsp;consumer&nbsp;key&nbsp;and&nbsp;secret;&nbsp;and&nbsp;the&nbsp;oAuth&nbsp;key&nbsp;and&nbsp;secret:<br>
  92. &nbsp;<br>
  93. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api&nbsp;=&nbsp;twitter.<a href="#Api">Api</a>(consumer_key='twitter&nbsp;consumer&nbsp;key',<br>
  94. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;consumer_secret='twitter&nbsp;consumer&nbsp;secret',<br>
  95. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;access_token_key='the_key_given',<br>
  96. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;access_token_secret='the_key_secret')<br>
  97. &nbsp;<br>
  98. &nbsp;&nbsp;To&nbsp;fetch&nbsp;your&nbsp;friends&nbsp;(after&nbsp;being&nbsp;authenticated):<br>
  99. &nbsp;<br>
  100. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;users&nbsp;=&nbsp;api.<a href="#Api-GetFriends">GetFriends</a>()<br>
  101. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;print&nbsp;[u.name&nbsp;for&nbsp;u&nbsp;in&nbsp;users]<br>
  102. &nbsp;<br>
  103. &nbsp;&nbsp;To&nbsp;post&nbsp;a&nbsp;twitter&nbsp;status&nbsp;message&nbsp;(after&nbsp;being&nbsp;authenticated):<br>
  104. &nbsp;<br>
  105. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;status&nbsp;=&nbsp;api.<a href="#Api-PostUpdate">PostUpdate</a>('I&nbsp;love&nbsp;python-twitter!')<br>
  106. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;print&nbsp;status.text<br>
  107. &nbsp;&nbsp;&nbsp;&nbsp;I&nbsp;love&nbsp;python-twitter!<br>
  108. &nbsp;<br>
  109. &nbsp;&nbsp;There&nbsp;are&nbsp;many&nbsp;other&nbsp;methods,&nbsp;including:<br>
  110. &nbsp;<br>
  111. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-PostUpdates">PostUpdates</a>(status)<br>
  112. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-PostDirectMessage">PostDirectMessage</a>(user,&nbsp;text)<br>
  113. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetUser">GetUser</a>(user)<br>
  114. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetReplies">GetReplies</a>()<br>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetUserTimeline">GetUserTimeline</a>(user)<br>
  116. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetStatus">GetStatus</a>(id)<br>
  117. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-DestroyStatus">DestroyStatus</a>(id)<br>
  118. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetFriendsTimeline">GetFriendsTimeline</a>(user)<br>
  119. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetFriends">GetFriends</a>(user)<br>
  120. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetFollowers">GetFollowers</a>()<br>
  121. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetFeatured">GetFeatured</a>()<br>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetDirectMessages">GetDirectMessages</a>()<br>
  123. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-PostDirectMessage">PostDirectMessage</a>(user,&nbsp;text)<br>
  124. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-DestroyDirectMessage">DestroyDirectMessage</a>(id)<br>
  125. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-DestroyFriendship">DestroyFriendship</a>(user)<br>
  126. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-CreateFriendship">CreateFriendship</a>(user)<br>
  127. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetUserByEmail">GetUserByEmail</a>(email)<br>
  128. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-VerifyCredentials">VerifyCredentials</a>()<br>&nbsp;</tt></td></tr>
  129. <tr><td>&nbsp;</td>
  130. <td width="100%">Methods defined here:<br>
  131. <dl><dt><a name="Api-ClearCredentials"><strong>ClearCredentials</strong></a>(self)</dt><dd><tt>Clear&nbsp;the&nbsp;any&nbsp;credentials&nbsp;for&nbsp;this&nbsp;instance</tt></dd></dl>
  132. <dl><dt><a name="Api-CreateFavorite"><strong>CreateFavorite</strong></a>(self, status)</dt><dd><tt>Favorites&nbsp;the&nbsp;status&nbsp;specified&nbsp;in&nbsp;the&nbsp;status&nbsp;parameter&nbsp;as&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  133. Returns&nbsp;the&nbsp;favorite&nbsp;status&nbsp;when&nbsp;successful.<br>
  134. &nbsp;<br>
  135. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  136. &nbsp;<br>
  137. Args:<br>
  138. &nbsp;&nbsp;The&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;to&nbsp;mark&nbsp;as&nbsp;a&nbsp;favorite.<br>
  139. Returns:<br>
  140. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;newly-marked&nbsp;favorite.</tt></dd></dl>
  141. <dl><dt><a name="Api-CreateFriendship"><strong>CreateFriendship</strong></a>(self, user)</dt><dd><tt>Befriends&nbsp;the&nbsp;user&nbsp;specified&nbsp;in&nbsp;the&nbsp;user&nbsp;parameter&nbsp;as&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  142. &nbsp;<br>
  143. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  144. &nbsp;<br>
  145. Args:<br>
  146. &nbsp;&nbsp;The&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;befriend.<br>
  147. Returns:<br>
  148. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;befriended&nbsp;user.</tt></dd></dl>
  149. <dl><dt><a name="Api-CreateList"><strong>CreateList</strong></a>(self, user, name, mode<font color="#909090">=None</font>, description<font color="#909090">=None</font>)</dt><dd><tt>Creates&nbsp;a&nbsp;new&nbsp;list&nbsp;with&nbsp;the&nbsp;give&nbsp;name<br>
  150. &nbsp;<br>
  151. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  152. &nbsp;<br>
  153. Args:<br>
  154. &nbsp;&nbsp;user:<br>
  155. &nbsp;&nbsp;&nbsp;&nbsp;Twitter&nbsp;name&nbsp;to&nbsp;create&nbsp;the&nbsp;list&nbsp;for<br>
  156. &nbsp;&nbsp;name:<br>
  157. &nbsp;&nbsp;&nbsp;&nbsp;New&nbsp;name&nbsp;for&nbsp;the&nbsp;list<br>
  158. &nbsp;&nbsp;mode:<br>
  159. &nbsp;&nbsp;&nbsp;&nbsp;'public'&nbsp;or&nbsp;'private'.<br>
  160. &nbsp;&nbsp;&nbsp;&nbsp;Defaults&nbsp;to&nbsp;'public'.&nbsp;[Optional]<br>
  161. &nbsp;&nbsp;description:<br>
  162. &nbsp;&nbsp;&nbsp;&nbsp;Description&nbsp;of&nbsp;the&nbsp;list.&nbsp;[Optional]<br>
  163. &nbsp;<br>
  164. Returns:<br>
  165. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;new&nbsp;list</tt></dd></dl>
  166. <dl><dt><a name="Api-CreateSubscription"><strong>CreateSubscription</strong></a>(self, owner, list)</dt><dd><tt>Creates&nbsp;a&nbsp;subscription&nbsp;to&nbsp;a&nbsp;list&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user<br>
  167. &nbsp;<br>
  168. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  169. &nbsp;<br>
  170. Args:<br>
  171. &nbsp;&nbsp;owner:<br>
  172. &nbsp;&nbsp;&nbsp;&nbsp;<a href="#User">User</a>&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;owner&nbsp;of&nbsp;the&nbsp;list&nbsp;being&nbsp;subscribed&nbsp;to.<br>
  173. &nbsp;&nbsp;list:<br>
  174. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;slug&nbsp;or&nbsp;list&nbsp;id&nbsp;to&nbsp;subscribe&nbsp;the&nbsp;user&nbsp;to<br>
  175. &nbsp;<br>
  176. Returns:<br>
  177. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;list&nbsp;subscribed&nbsp;to</tt></dd></dl>
  178. <dl><dt><a name="Api-DestroyDirectMessage"><strong>DestroyDirectMessage</strong></a>(self, id)</dt><dd><tt>Destroys&nbsp;the&nbsp;direct&nbsp;message&nbsp;specified&nbsp;in&nbsp;the&nbsp;required&nbsp;ID&nbsp;parameter.<br>
  179. &nbsp;<br>
  180. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated,&nbsp;and&nbsp;the<br>
  181. authenticating&nbsp;user&nbsp;must&nbsp;be&nbsp;the&nbsp;recipient&nbsp;of&nbsp;the&nbsp;specified&nbsp;direct<br>
  182. message.<br>
  183. &nbsp;<br>
  184. Args:<br>
  185. &nbsp;&nbsp;id:&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;direct&nbsp;message&nbsp;to&nbsp;be&nbsp;destroyed<br>
  186. &nbsp;<br>
  187. Returns:<br>
  188. &nbsp;&nbsp;A&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;message&nbsp;destroyed</tt></dd></dl>
  189. <dl><dt><a name="Api-DestroyFavorite"><strong>DestroyFavorite</strong></a>(self, status)</dt><dd><tt>Un-favorites&nbsp;the&nbsp;status&nbsp;specified&nbsp;in&nbsp;the&nbsp;ID&nbsp;parameter&nbsp;as&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  190. Returns&nbsp;the&nbsp;un-favorited&nbsp;status&nbsp;in&nbsp;the&nbsp;requested&nbsp;format&nbsp;when&nbsp;successful.<br>
  191. &nbsp;<br>
  192. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  193. &nbsp;<br>
  194. Args:<br>
  195. &nbsp;&nbsp;The&nbsp;twitter.<a href="#Status">Status</a>&nbsp;to&nbsp;unmark&nbsp;as&nbsp;a&nbsp;favorite.<br>
  196. Returns:<br>
  197. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;newly-unmarked&nbsp;favorite.</tt></dd></dl>
  198. <dl><dt><a name="Api-DestroyFriendship"><strong>DestroyFriendship</strong></a>(self, user)</dt><dd><tt>Discontinues&nbsp;friendship&nbsp;with&nbsp;the&nbsp;user&nbsp;specified&nbsp;in&nbsp;the&nbsp;user&nbsp;parameter.<br>
  199. &nbsp;<br>
  200. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  201. &nbsp;<br>
  202. Args:<br>
  203. &nbsp;&nbsp;The&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;&nbsp;with&nbsp;whom&nbsp;to&nbsp;discontinue&nbsp;friendship.<br>
  204. Returns:<br>
  205. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;discontinued&nbsp;friend.</tt></dd></dl>
  206. <dl><dt><a name="Api-DestroyList"><strong>DestroyList</strong></a>(self, user, id)</dt><dd><tt>Destroys&nbsp;the&nbsp;list&nbsp;from&nbsp;the&nbsp;given&nbsp;user<br>
  207. &nbsp;<br>
  208. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  209. &nbsp;<br>
  210. Args:<br>
  211. &nbsp;&nbsp;user:<br>
  212. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;user&nbsp;to&nbsp;remove&nbsp;the&nbsp;list&nbsp;from.<br>
  213. &nbsp;&nbsp;id:<br>
  214. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;slug&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;list&nbsp;to&nbsp;remove.<br>
  215. Returns:<br>
  216. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;removed&nbsp;list.</tt></dd></dl>
  217. <dl><dt><a name="Api-DestroyStatus"><strong>DestroyStatus</strong></a>(self, id)</dt><dd><tt>Destroys&nbsp;the&nbsp;status&nbsp;specified&nbsp;by&nbsp;the&nbsp;required&nbsp;ID&nbsp;parameter.<br>
  218. &nbsp;<br>
  219. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated&nbsp;and&nbsp;the<br>
  220. authenticating&nbsp;user&nbsp;must&nbsp;be&nbsp;the&nbsp;author&nbsp;of&nbsp;the&nbsp;specified&nbsp;status.<br>
  221. &nbsp;<br>
  222. Args:<br>
  223. &nbsp;&nbsp;id:<br>
  224. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;numerical&nbsp;ID&nbsp;of&nbsp;the&nbsp;status&nbsp;you're&nbsp;trying&nbsp;to&nbsp;destroy.<br>
  225. &nbsp;<br>
  226. Returns:<br>
  227. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;destroyed&nbsp;status&nbsp;message</tt></dd></dl>
  228. <dl><dt><a name="Api-DestroySubscription"><strong>DestroySubscription</strong></a>(self, owner, list)</dt><dd><tt>Destroys&nbsp;the&nbsp;subscription&nbsp;to&nbsp;a&nbsp;list&nbsp;for&nbsp;the&nbsp;authenticated&nbsp;user<br>
  229. &nbsp;<br>
  230. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  231. &nbsp;<br>
  232. Args:<br>
  233. &nbsp;&nbsp;owner:<br>
  234. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;user&nbsp;id&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;that&nbsp;owns&nbsp;the<br>
  235. &nbsp;&nbsp;&nbsp;&nbsp;list&nbsp;that&nbsp;is&nbsp;to&nbsp;be&nbsp;unsubscribed&nbsp;from<br>
  236. &nbsp;&nbsp;list:<br>
  237. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;slug&nbsp;or&nbsp;list&nbsp;id&nbsp;of&nbsp;the&nbsp;list&nbsp;to&nbsp;unsubscribe&nbsp;from<br>
  238. &nbsp;<br>
  239. Returns:<br>
  240. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;removed&nbsp;list.</tt></dd></dl>
  241. <dl><dt><a name="Api-FilterPublicTimeline"><strong>FilterPublicTimeline</strong></a>(self, term, since_id<font color="#909090">=None</font>)</dt><dd><tt>Filter&nbsp;the&nbsp;public&nbsp;twitter&nbsp;timeline&nbsp;by&nbsp;a&nbsp;given&nbsp;search&nbsp;term&nbsp;on<br>
  242. the&nbsp;local&nbsp;machine.<br>
  243. &nbsp;<br>
  244. Args:<br>
  245. &nbsp;&nbsp;term:<br>
  246. &nbsp;&nbsp;&nbsp;&nbsp;term&nbsp;to&nbsp;search&nbsp;by.<br>
  247. &nbsp;&nbsp;since_id:<br>
  248. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  249. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  250. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  251. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  252. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  253. &nbsp;<br>
  254. Returns:<br>
  255. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message<br>
  256. &nbsp;&nbsp;containing&nbsp;the&nbsp;term</tt></dd></dl>
  257. <dl><dt><a name="Api-GetDirectMessages"><strong>GetDirectMessages</strong></a>(self, since<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, page<font color="#909090">=None</font>)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;the&nbsp;direct&nbsp;messages&nbsp;sent&nbsp;to&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  258. &nbsp;<br>
  259. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  260. &nbsp;<br>
  261. Args:<br>
  262. &nbsp;&nbsp;since:<br>
  263. &nbsp;&nbsp;&nbsp;&nbsp;Narrows&nbsp;the&nbsp;returned&nbsp;results&nbsp;to&nbsp;just&nbsp;those&nbsp;statuses&nbsp;created<br>
  264. &nbsp;&nbsp;&nbsp;&nbsp;after&nbsp;the&nbsp;specified&nbsp;HTTP-formatted&nbsp;date.&nbsp;[Optional]<br>
  265. &nbsp;&nbsp;since_id:<br>
  266. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  267. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  268. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  269. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  270. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  271. &nbsp;&nbsp;page:<br>
  272. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  273. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  274. &nbsp;<br>
  275. Returns:<br>
  276. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instances</tt></dd></dl>
  277. <dl><dt><a name="Api-GetFavorites"><strong>GetFavorites</strong></a>(self, user<font color="#909090">=None</font>, page<font color="#909090">=None</font>)</dt><dd><tt>Return&nbsp;a&nbsp;list&nbsp;of&nbsp;<a href="#Status">Status</a>&nbsp;objects&nbsp;representing&nbsp;favorited&nbsp;tweets.<br>
  278. By&nbsp;default,&nbsp;returns&nbsp;the&nbsp;(up&nbsp;to)&nbsp;20&nbsp;most&nbsp;recent&nbsp;tweets&nbsp;for&nbsp;the<br>
  279. authenticated&nbsp;user.<br>
  280. &nbsp;<br>
  281. Args:<br>
  282. &nbsp;&nbsp;user:<br>
  283. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;favorites&nbsp;you&nbsp;are&nbsp;fetching.<br>
  284. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;not&nbsp;specified,&nbsp;defaults&nbsp;to&nbsp;the&nbsp;authenticated&nbsp;user.&nbsp;[Optional]<br>
  285. &nbsp;&nbsp;page:<br>
  286. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  287. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]</tt></dd></dl>
  288. <dl><dt><a name="Api-GetFeatured"><strong>GetFeatured</strong></a>(self)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances&nbsp;featured&nbsp;on&nbsp;twitter.com<br>
  289. &nbsp;<br>
  290. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  291. &nbsp;<br>
  292. Returns:<br>
  293. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances</tt></dd></dl>
  294. <dl><dt><a name="Api-GetFollowerIDs"><strong>GetFollowerIDs</strong></a>(self, userid<font color="#909090">=None</font>, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;follower<br>
  295. &nbsp;<br>
  296. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  297. &nbsp;<br>
  298. Returns:<br>
  299. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;follower</tt></dd></dl>
  300. <dl><dt><a name="Api-GetFollowers"><strong>GetFollowers</strong></a>(self, page<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;follower<br>
  301. &nbsp;<br>
  302. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  303. &nbsp;<br>
  304. Args:<br>
  305. &nbsp;&nbsp;page:<br>
  306. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  307. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  308. &nbsp;<br>
  309. Returns:<br>
  310. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;follower</tt></dd></dl>
  311. <dl><dt><a name="Api-GetFriendIDs"><strong>GetFriendIDs</strong></a>(self, user<font color="#909090">=None</font>, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;twitter&nbsp;user&nbsp;id's&nbsp;for&nbsp;every&nbsp;person<br>
  312. the&nbsp;specified&nbsp;user&nbsp;is&nbsp;following.<br>
  313. &nbsp;<br>
  314. Args:<br>
  315. &nbsp;&nbsp;user:<br>
  316. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;id&nbsp;or&nbsp;screen_name&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;retrieve&nbsp;the&nbsp;id&nbsp;list&nbsp;for<br>
  317. &nbsp;&nbsp;&nbsp;&nbsp;[Optional]<br>
  318. &nbsp;<br>
  319. Returns:<br>
  320. &nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;integers,&nbsp;one&nbsp;for&nbsp;each&nbsp;user&nbsp;id.</tt></dd></dl>
  321. <dl><dt><a name="Api-GetFriends"><strong>GetFriends</strong></a>(self, user<font color="#909090">=None</font>, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;friend.<br>
  322. &nbsp;<br>
  323. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  324. &nbsp;<br>
  325. Args:<br>
  326. &nbsp;&nbsp;user:<br>
  327. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;friends&nbsp;you&nbsp;are&nbsp;fetching.<br>
  328. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;not&nbsp;specified,&nbsp;defaults&nbsp;to&nbsp;the&nbsp;authenticated&nbsp;user.&nbsp;[Optional]<br>
  329. &nbsp;<br>
  330. Returns:<br>
  331. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;friend</tt></dd></dl>
  332. <dl><dt><a name="Api-GetFriendsTimeline"><strong>GetFriendsTimeline</strong></a>(self, user<font color="#909090">=None</font>, count<font color="#909090">=None</font>, page<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, retweets<font color="#909090">=None</font>, include_entities<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;messages&nbsp;for&nbsp;a&nbsp;user's&nbsp;friends<br>
  333. &nbsp;<br>
  334. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated&nbsp;if&nbsp;the&nbsp;user&nbsp;is&nbsp;private.<br>
  335. &nbsp;<br>
  336. Args:<br>
  337. &nbsp;&nbsp;user:<br>
  338. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;return<br>
  339. &nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;friends_timeline.&nbsp;&nbsp;If&nbsp;not&nbsp;specified&nbsp;then&nbsp;the&nbsp;authenticated<br>
  340. &nbsp;&nbsp;&nbsp;&nbsp;user&nbsp;set&nbsp;in&nbsp;the&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;will&nbsp;be&nbsp;used.&nbsp;&nbsp;[Optional]<br>
  341. &nbsp;&nbsp;count:<br>
  342. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;number&nbsp;of&nbsp;statuses&nbsp;to&nbsp;retrieve.&nbsp;May&nbsp;not&nbsp;be<br>
  343. &nbsp;&nbsp;&nbsp;&nbsp;greater&nbsp;than&nbsp;100.&nbsp;[Optional]<br>
  344. &nbsp;&nbsp;page:<br>
  345. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  346. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  347. &nbsp;&nbsp;since_id:<br>
  348. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  349. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  350. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  351. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  352. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  353. &nbsp;&nbsp;retweets:<br>
  354. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;the&nbsp;timeline&nbsp;will&nbsp;contain&nbsp;native&nbsp;retweets.&nbsp;[Optional]<br>
  355. &nbsp;&nbsp;include_entities:<br>
  356. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;each&nbsp;tweet&nbsp;will&nbsp;include&nbsp;a&nbsp;node&nbsp;called&nbsp;"entities,".<br>
  357. &nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;node&nbsp;offers&nbsp;a&nbsp;variety&nbsp;of&nbsp;metadata&nbsp;about&nbsp;the&nbsp;tweet&nbsp;in&nbsp;a<br>
  358. &nbsp;&nbsp;&nbsp;&nbsp;discreet&nbsp;structure,&nbsp;including:&nbsp;user_mentions,&nbsp;urls,&nbsp;and<br>
  359. &nbsp;&nbsp;&nbsp;&nbsp;hashtags.&nbsp;[Optional]<br>
  360. &nbsp;<br>
  361. Returns:<br>
  362. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message</tt></dd></dl>
  363. <dl><dt><a name="Api-GetLists"><strong>GetLists</strong></a>(self, user, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;lists&nbsp;for&nbsp;a&nbsp;user.<br>
  364. &nbsp;<br>
  365. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  366. &nbsp;<br>
  367. Args:<br>
  368. &nbsp;&nbsp;user:<br>
  369. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;friends&nbsp;you&nbsp;are&nbsp;fetching.<br>
  370. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;the&nbsp;passed&nbsp;in&nbsp;user&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;the&nbsp;authenticated&nbsp;user<br>
  371. &nbsp;&nbsp;&nbsp;&nbsp;then&nbsp;you&nbsp;will&nbsp;also&nbsp;receive&nbsp;private&nbsp;list&nbsp;data.<br>
  372. &nbsp;&nbsp;cursor:<br>
  373. &nbsp;&nbsp;&nbsp;&nbsp;"page"&nbsp;value&nbsp;that&nbsp;Twitter&nbsp;will&nbsp;use&nbsp;to&nbsp;start&nbsp;building&nbsp;the<br>
  374. &nbsp;&nbsp;&nbsp;&nbsp;list&nbsp;sequence&nbsp;from.&nbsp;&nbsp;-1&nbsp;to&nbsp;start&nbsp;at&nbsp;the&nbsp;beginning.<br>
  375. &nbsp;&nbsp;&nbsp;&nbsp;Twitter&nbsp;will&nbsp;return&nbsp;in&nbsp;the&nbsp;result&nbsp;the&nbsp;values&nbsp;for&nbsp;next_cursor<br>
  376. &nbsp;&nbsp;&nbsp;&nbsp;and&nbsp;previous_cursor.&nbsp;[Optional]<br>
  377. &nbsp;<br>
  378. Returns:<br>
  379. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#List">List</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;list</tt></dd></dl>
  380. <dl><dt><a name="Api-GetMentions"><strong>GetMentions</strong></a>(self, since_id<font color="#909090">=None</font>, max_id<font color="#909090">=None</font>, page<font color="#909090">=None</font>)</dt><dd><tt>Returns&nbsp;the&nbsp;20&nbsp;most&nbsp;recent&nbsp;mentions&nbsp;(status&nbsp;containing&nbsp;@twitterID)<br>
  381. for&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  382. &nbsp;<br>
  383. Args:<br>
  384. &nbsp;&nbsp;since_id:<br>
  385. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  386. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  387. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  388. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  389. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  390. &nbsp;&nbsp;max_id:<br>
  391. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;only&nbsp;statuses&nbsp;with&nbsp;an&nbsp;ID&nbsp;less&nbsp;than<br>
  392. &nbsp;&nbsp;&nbsp;&nbsp;(that&nbsp;is,&nbsp;older&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;&nbsp;[Optional]<br>
  393. &nbsp;&nbsp;page:<br>
  394. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  395. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  396. &nbsp;<br>
  397. Returns:<br>
  398. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;mention&nbsp;of&nbsp;the&nbsp;user.</tt></dd></dl>
  399. <dl><dt><a name="Api-GetPublicTimeline"><strong>GetPublicTimeline</strong></a>(self, since_id<font color="#909090">=None</font>, include_rts<font color="#909090">=None</font>, include_entities<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;public&nbsp;twitter.<a href="#Status">Status</a>&nbsp;message&nbsp;for&nbsp;all&nbsp;users.<br>
  400. &nbsp;<br>
  401. Args:<br>
  402. &nbsp;&nbsp;since_id:<br>
  403. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  404. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  405. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  406. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  407. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  408. &nbsp;&nbsp;include_rts:<br>
  409. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;the&nbsp;timeline&nbsp;will&nbsp;contain&nbsp;native&nbsp;retweets&nbsp;(if&nbsp;they<br>
  410. &nbsp;&nbsp;&nbsp;&nbsp;exist)&nbsp;in&nbsp;addition&nbsp;to&nbsp;the&nbsp;standard&nbsp;stream&nbsp;of&nbsp;tweets.&nbsp;[Optional]<br>
  411. &nbsp;&nbsp;include_entities:<br>
  412. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;each&nbsp;tweet&nbsp;will&nbsp;include&nbsp;a&nbsp;node&nbsp;called&nbsp;"entities,".<br>
  413. &nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;node&nbsp;offers&nbsp;a&nbsp;variety&nbsp;of&nbsp;metadata&nbsp;about&nbsp;the&nbsp;tweet&nbsp;in&nbsp;a<br>
  414. &nbsp;&nbsp;&nbsp;&nbsp;discreet&nbsp;structure,&nbsp;including:&nbsp;user_mentions,&nbsp;urls,&nbsp;and<br>
  415. &nbsp;&nbsp;&nbsp;&nbsp;hashtags.&nbsp;[Optional]<br>
  416. &nbsp;<br>
  417. Returns:<br>
  418. &nbsp;&nbsp;An&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message</tt></dd></dl>
  419. <dl><dt><a name="Api-GetRateLimitStatus"><strong>GetRateLimitStatus</strong></a>(self)</dt><dd><tt>Fetch&nbsp;the&nbsp;rate&nbsp;limit&nbsp;status&nbsp;for&nbsp;the&nbsp;currently&nbsp;authorized&nbsp;user.<br>
  420. &nbsp;<br>
  421. Returns:<br>
  422. &nbsp;&nbsp;A&nbsp;dictionary&nbsp;containing&nbsp;the&nbsp;time&nbsp;the&nbsp;limit&nbsp;will&nbsp;reset&nbsp;(reset_time),<br>
  423. &nbsp;&nbsp;the&nbsp;number&nbsp;of&nbsp;remaining&nbsp;hits&nbsp;allowed&nbsp;before&nbsp;the&nbsp;reset&nbsp;(remaining_hits),<br>
  424. &nbsp;&nbsp;the&nbsp;number&nbsp;of&nbsp;hits&nbsp;allowed&nbsp;in&nbsp;a&nbsp;60-minute&nbsp;period&nbsp;(hourly_limit),&nbsp;and<br>
  425. &nbsp;&nbsp;the&nbsp;time&nbsp;of&nbsp;the&nbsp;reset&nbsp;in&nbsp;seconds&nbsp;since&nbsp;The&nbsp;Epoch&nbsp;(reset_time_in_seconds).</tt></dd></dl>
  426. <dl><dt><a name="Api-GetReplies"><strong>GetReplies</strong></a>(self, since<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, page<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;a&nbsp;sequence&nbsp;of&nbsp;status&nbsp;messages&nbsp;representing&nbsp;the&nbsp;20&nbsp;most<br>
  427. recent&nbsp;replies&nbsp;(status&nbsp;updates&nbsp;prefixed&nbsp;with&nbsp;@twitterID)&nbsp;to&nbsp;the<br>
  428. authenticating&nbsp;user.<br>
  429. &nbsp;<br>
  430. Args:<br>
  431. &nbsp;&nbsp;since_id:<br>
  432. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  433. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  434. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  435. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  436. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  437. &nbsp;&nbsp;page:<br>
  438. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  439. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  440. &nbsp;&nbsp;since:<br>
  441. &nbsp;<br>
  442. Returns:<br>
  443. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;reply&nbsp;to&nbsp;the&nbsp;user.</tt></dd></dl>
  444. <dl><dt><a name="Api-GetRetweets"><strong>GetRetweets</strong></a>(self, statusid)</dt><dd><tt>Returns&nbsp;up&nbsp;to&nbsp;100&nbsp;of&nbsp;the&nbsp;first&nbsp;retweets&nbsp;of&nbsp;the&nbsp;tweet&nbsp;identified<br>
  445. by&nbsp;statusid<br>
  446. &nbsp;<br>
  447. Args:<br>
  448. &nbsp;&nbsp;statusid:<br>
  449. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;tweet&nbsp;for&nbsp;which&nbsp;retweets&nbsp;should&nbsp;be&nbsp;searched&nbsp;for<br>
  450. &nbsp;<br>
  451. Returns:<br>
  452. &nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;which&nbsp;are&nbsp;retweets&nbsp;of&nbsp;statusid</tt></dd></dl>
  453. <dl><dt><a name="Api-GetSearch"><strong>GetSearch</strong></a>(self, term, geocode<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, per_page<font color="#909090">=15</font>, page<font color="#909090">=1</font>, lang<font color="#909090">='en'</font>, show_user<font color="#909090">='true'</font>, query_users<font color="#909090">=False</font>)</dt><dd><tt>Return&nbsp;twitter&nbsp;search&nbsp;results&nbsp;for&nbsp;a&nbsp;given&nbsp;term.<br>
  454. &nbsp;<br>
  455. Args:<br>
  456. &nbsp;&nbsp;term:<br>
  457. &nbsp;&nbsp;&nbsp;&nbsp;term&nbsp;to&nbsp;search&nbsp;by.<br>
  458. &nbsp;&nbsp;since_id:<br>
  459. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  460. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  461. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  462. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  463. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  464. &nbsp;&nbsp;geocode:<br>
  465. &nbsp;&nbsp;&nbsp;&nbsp;geolocation&nbsp;information&nbsp;in&nbsp;the&nbsp;form&nbsp;(latitude,&nbsp;longitude,&nbsp;radius)<br>
  466. &nbsp;&nbsp;&nbsp;&nbsp;[Optional]<br>
  467. &nbsp;&nbsp;per_page:<br>
  468. &nbsp;&nbsp;&nbsp;&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.&nbsp;&nbsp;Default&nbsp;is&nbsp;15&nbsp;[Optional]<br>
  469. &nbsp;&nbsp;page:<br>
  470. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  471. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  472. &nbsp;&nbsp;lang:<br>
  473. &nbsp;&nbsp;&nbsp;&nbsp;language&nbsp;for&nbsp;results.&nbsp;&nbsp;Default&nbsp;is&nbsp;English&nbsp;[Optional]<br>
  474. &nbsp;&nbsp;show_user:<br>
  475. &nbsp;&nbsp;&nbsp;&nbsp;prefixes&nbsp;screen&nbsp;name&nbsp;in&nbsp;status<br>
  476. &nbsp;&nbsp;query_users:<br>
  477. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;set&nbsp;to&nbsp;False,&nbsp;then&nbsp;all&nbsp;users&nbsp;only&nbsp;have&nbsp;screen_name&nbsp;and<br>
  478. &nbsp;&nbsp;&nbsp;&nbsp;profile_image_url&nbsp;available.<br>
  479. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;set&nbsp;to&nbsp;True,&nbsp;all&nbsp;information&nbsp;of&nbsp;users&nbsp;are&nbsp;available,<br>
  480. &nbsp;&nbsp;&nbsp;&nbsp;but&nbsp;it&nbsp;uses&nbsp;lots&nbsp;of&nbsp;request&nbsp;quota,&nbsp;one&nbsp;per&nbsp;status.<br>
  481. &nbsp;<br>
  482. Returns:<br>
  483. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message&nbsp;containing<br>
  484. &nbsp;&nbsp;the&nbsp;term</tt></dd></dl>
  485. <dl><dt><a name="Api-GetStatus"><strong>GetStatus</strong></a>(self, id)</dt><dd><tt>Returns&nbsp;a&nbsp;single&nbsp;status&nbsp;message.<br>
  486. &nbsp;<br>
  487. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated&nbsp;if&nbsp;the<br>
  488. status&nbsp;message&nbsp;is&nbsp;private.<br>
  489. &nbsp;<br>
  490. Args:<br>
  491. &nbsp;&nbsp;id:<br>
  492. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;numeric&nbsp;ID&nbsp;of&nbsp;the&nbsp;status&nbsp;you&nbsp;are&nbsp;trying&nbsp;to&nbsp;retrieve.<br>
  493. &nbsp;<br>
  494. Returns:<br>
  495. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;that&nbsp;status&nbsp;message</tt></dd></dl>
  496. <dl><dt><a name="Api-GetSubscriptions"><strong>GetSubscriptions</strong></a>(self, user, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;Lists&nbsp;that&nbsp;the&nbsp;given&nbsp;user&nbsp;is&nbsp;subscribed&nbsp;to<br>
  497. &nbsp;<br>
  498. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  499. &nbsp;<br>
  500. Args:<br>
  501. &nbsp;&nbsp;user:<br>
  502. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user<br>
  503. &nbsp;&nbsp;cursor:<br>
  504. &nbsp;&nbsp;&nbsp;&nbsp;"page"&nbsp;value&nbsp;that&nbsp;Twitter&nbsp;will&nbsp;use&nbsp;to&nbsp;start&nbsp;building&nbsp;the<br>
  505. &nbsp;&nbsp;&nbsp;&nbsp;list&nbsp;sequence&nbsp;from.&nbsp;&nbsp;-1&nbsp;to&nbsp;start&nbsp;at&nbsp;the&nbsp;beginning.<br>
  506. &nbsp;&nbsp;&nbsp;&nbsp;Twitter&nbsp;will&nbsp;return&nbsp;in&nbsp;the&nbsp;result&nbsp;the&nbsp;values&nbsp;for&nbsp;next_cursor<br>
  507. &nbsp;&nbsp;&nbsp;&nbsp;and&nbsp;previous_cursor.&nbsp;[Optional]<br>
  508. &nbsp;<br>
  509. Returns:<br>
  510. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#List">List</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;list</tt></dd></dl>
  511. <dl><dt><a name="Api-GetTrendsCurrent"><strong>GetTrendsCurrent</strong></a>(self, exclude<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;current&nbsp;top&nbsp;trending&nbsp;topics<br>
  512. &nbsp;<br>
  513. Args:<br>
  514. &nbsp;&nbsp;exclude:<br>
  515. &nbsp;&nbsp;&nbsp;&nbsp;Appends&nbsp;the&nbsp;exclude&nbsp;parameter&nbsp;as&nbsp;a&nbsp;request&nbsp;parameter.<br>
  516. &nbsp;&nbsp;&nbsp;&nbsp;Currently&nbsp;only&nbsp;exclude=hashtags&nbsp;is&nbsp;supported.&nbsp;[Optional]<br>
  517. &nbsp;<br>
  518. Returns:<br>
  519. &nbsp;&nbsp;A&nbsp;list&nbsp;with&nbsp;10&nbsp;entries.&nbsp;Each&nbsp;entry&nbsp;contains&nbsp;the&nbsp;twitter.</tt></dd></dl>
  520. <dl><dt><a name="Api-GetTrendsDaily"><strong>GetTrendsDaily</strong></a>(self, exclude<font color="#909090">=None</font>, startdate<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;current&nbsp;top&nbsp;trending&nbsp;topics&nbsp;for&nbsp;each&nbsp;hour&nbsp;in&nbsp;a&nbsp;given&nbsp;day<br>
  521. &nbsp;<br>
  522. Args:<br>
  523. &nbsp;&nbsp;startdate:<br>
  524. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;start&nbsp;date&nbsp;for&nbsp;the&nbsp;report.<br>
  525. &nbsp;&nbsp;&nbsp;&nbsp;Should&nbsp;be&nbsp;in&nbsp;the&nbsp;format&nbsp;YYYY-MM-DD.&nbsp;[Optional]<br>
  526. &nbsp;&nbsp;exclude:<br>
  527. &nbsp;&nbsp;&nbsp;&nbsp;Appends&nbsp;the&nbsp;exclude&nbsp;parameter&nbsp;as&nbsp;a&nbsp;request&nbsp;parameter.<br>
  528. &nbsp;&nbsp;&nbsp;&nbsp;Currently&nbsp;only&nbsp;exclude=hashtags&nbsp;is&nbsp;supported.&nbsp;[Optional]<br>
  529. &nbsp;<br>
  530. Returns:<br>
  531. &nbsp;&nbsp;A&nbsp;list&nbsp;with&nbsp;24&nbsp;entries.&nbsp;Each&nbsp;entry&nbsp;contains&nbsp;the&nbsp;twitter.<br>
  532. &nbsp;&nbsp;<a href="#Trend">Trend</a>&nbsp;elements&nbsp;that&nbsp;were&nbsp;trending&nbsp;at&nbsp;the&nbsp;corresponding&nbsp;hour&nbsp;of&nbsp;the&nbsp;day.</tt></dd></dl>
  533. <dl><dt><a name="Api-GetTrendsWeekly"><strong>GetTrendsWeekly</strong></a>(self, exclude<font color="#909090">=None</font>, startdate<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;top&nbsp;30&nbsp;trending&nbsp;topics&nbsp;for&nbsp;each&nbsp;day&nbsp;in&nbsp;a&nbsp;given&nbsp;week.<br>
  534. &nbsp;<br>
  535. Args:<br>
  536. &nbsp;&nbsp;startdate:<br>
  537. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;start&nbsp;date&nbsp;for&nbsp;the&nbsp;report.<br>
  538. &nbsp;&nbsp;&nbsp;&nbsp;Should&nbsp;be&nbsp;in&nbsp;the&nbsp;format&nbsp;YYYY-MM-DD.&nbsp;[Optional]<br>
  539. &nbsp;&nbsp;exclude:<br>
  540. &nbsp;&nbsp;&nbsp;&nbsp;Appends&nbsp;the&nbsp;exclude&nbsp;parameter&nbsp;as&nbsp;a&nbsp;request&nbsp;parameter.<br>
  541. &nbsp;&nbsp;&nbsp;&nbsp;Currently&nbsp;only&nbsp;exclude=hashtags&nbsp;is&nbsp;supported.&nbsp;[Optional]<br>
  542. Returns:<br>
  543. &nbsp;&nbsp;A&nbsp;list&nbsp;with&nbsp;each&nbsp;entry&nbsp;contains&nbsp;the&nbsp;twitter.<br>
  544. &nbsp;&nbsp;<a href="#Trend">Trend</a>&nbsp;elements&nbsp;of&nbsp;trending&nbsp;topics&nbsp;for&nbsp;the&nbsp;corrsponding&nbsp;day&nbsp;of&nbsp;the&nbsp;week</tt></dd></dl>
  545. <dl><dt><a name="Api-GetUser"><strong>GetUser</strong></a>(self, user)</dt><dd><tt>Returns&nbsp;a&nbsp;single&nbsp;user.<br>
  546. &nbsp;<br>
  547. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  548. &nbsp;<br>
  549. Args:<br>
  550. &nbsp;&nbsp;user:&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;retrieve.<br>
  551. &nbsp;<br>
  552. Returns:<br>
  553. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;that&nbsp;user</tt></dd></dl>
  554. <dl><dt><a name="Api-GetUserByEmail"><strong>GetUserByEmail</strong></a>(self, email)</dt><dd><tt>Returns&nbsp;a&nbsp;single&nbsp;user&nbsp;by&nbsp;email&nbsp;address.<br>
  555. &nbsp;<br>
  556. Args:<br>
  557. &nbsp;&nbsp;email:<br>
  558. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;email&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;retrieve.<br>
  559. &nbsp;<br>
  560. Returns:<br>
  561. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;that&nbsp;user</tt></dd></dl>
  562. <dl><dt><a name="Api-GetUserRetweets"><strong>GetUserRetweets</strong></a>(self, count<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, max_id<font color="#909090">=None</font>, include_entities<font color="#909090">=False</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;retweets&nbsp;made&nbsp;by&nbsp;a&nbsp;single&nbsp;user.<br>
  563. &nbsp;<br>
  564. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  565. &nbsp;<br>
  566. Args:<br>
  567. &nbsp;&nbsp;count:<br>
  568. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;status&nbsp;messages&nbsp;to&nbsp;retrieve.&nbsp;[Optional]<br>
  569. &nbsp;&nbsp;since_id:<br>
  570. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  571. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  572. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  573. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  574. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  575. &nbsp;&nbsp;max_id:<br>
  576. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;less&nbsp;than&nbsp;(that&nbsp;is,&nbsp;older&nbsp;than)&nbsp;or<br>
  577. &nbsp;&nbsp;&nbsp;&nbsp;equal&nbsp;to&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;[Optional]<br>
  578. &nbsp;&nbsp;include_entities:<br>
  579. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;each&nbsp;tweet&nbsp;will&nbsp;include&nbsp;a&nbsp;node&nbsp;called&nbsp;"entities,".<br>
  580. &nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;node&nbsp;offers&nbsp;a&nbsp;variety&nbsp;of&nbsp;metadata&nbsp;about&nbsp;the&nbsp;tweet&nbsp;in&nbsp;a<br>
  581. &nbsp;&nbsp;&nbsp;&nbsp;discreet&nbsp;structure,&nbsp;including:&nbsp;user_mentions,&nbsp;urls,&nbsp;and<br>
  582. &nbsp;&nbsp;&nbsp;&nbsp;hashtags.&nbsp;[Optional]<br>
  583. &nbsp;<br>
  584. Returns:<br>
  585. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message&nbsp;up&nbsp;to&nbsp;count</tt></dd></dl>
  586. <dl><dt><a name="Api-GetUserTimeline"><strong>GetUserTimeline</strong></a>(self, id<font color="#909090">=None</font>, user_id<font color="#909090">=None</font>, screen_name<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, max_id<font color="#909090">=None</font>, count<font color="#909090">=None</font>, page<font color="#909090">=None</font>, include_rts<font color="#909090">=None</font>, include_entities<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;public&nbsp;<a href="#Status">Status</a>&nbsp;messages&nbsp;for&nbsp;a&nbsp;single&nbsp;user.<br>
  587. &nbsp;<br>
  588. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated&nbsp;if&nbsp;the&nbsp;user&nbsp;is&nbsp;private.<br>
  589. &nbsp;<br>
  590. Args:<br>
  591. &nbsp;&nbsp;id:<br>
  592. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;return<br>
  593. &nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;user_timeline.&nbsp;[Optional]<br>
  594. &nbsp;&nbsp;user_id:<br>
  595. &nbsp;&nbsp;&nbsp;&nbsp;Specfies&nbsp;the&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;return&nbsp;the<br>
  596. &nbsp;&nbsp;&nbsp;&nbsp;user_timeline.&nbsp;Helpful&nbsp;for&nbsp;disambiguating&nbsp;when&nbsp;a&nbsp;valid&nbsp;user&nbsp;ID<br>
  597. &nbsp;&nbsp;&nbsp;&nbsp;is&nbsp;also&nbsp;a&nbsp;valid&nbsp;screen&nbsp;name.&nbsp;[Optional]<br>
  598. &nbsp;&nbsp;screen_name:<br>
  599. &nbsp;&nbsp;&nbsp;&nbsp;Specfies&nbsp;the&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;return&nbsp;the<br>
  600. &nbsp;&nbsp;&nbsp;&nbsp;user_timeline.&nbsp;Helpful&nbsp;for&nbsp;disambiguating&nbsp;when&nbsp;a&nbsp;valid&nbsp;screen<br>
  601. &nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;is&nbsp;also&nbsp;a&nbsp;user&nbsp;ID.&nbsp;[Optional]<br>
  602. &nbsp;&nbsp;since_id:<br>
  603. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  604. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  605. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  606. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  607. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  608. &nbsp;&nbsp;max_id:<br>
  609. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;only&nbsp;statuses&nbsp;with&nbsp;an&nbsp;ID&nbsp;less&nbsp;than&nbsp;(that&nbsp;is,&nbsp;older<br>
  610. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;or&nbsp;equal&nbsp;to&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;[Optional]<br>
  611. &nbsp;&nbsp;count:<br>
  612. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;number&nbsp;of&nbsp;statuses&nbsp;to&nbsp;retrieve.&nbsp;May&nbsp;not&nbsp;be<br>
  613. &nbsp;&nbsp;&nbsp;&nbsp;greater&nbsp;than&nbsp;200.&nbsp;&nbsp;[Optional]<br>
  614. &nbsp;&nbsp;page:<br>
  615. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  616. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  617. &nbsp;&nbsp;include_rts:<br>
  618. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;the&nbsp;timeline&nbsp;will&nbsp;contain&nbsp;native&nbsp;retweets&nbsp;(if&nbsp;they<br>
  619. &nbsp;&nbsp;&nbsp;&nbsp;exist)&nbsp;in&nbsp;addition&nbsp;to&nbsp;the&nbsp;standard&nbsp;stream&nbsp;of&nbsp;tweets.&nbsp;[Optional]<br>
  620. &nbsp;&nbsp;include_entities:<br>
  621. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;each&nbsp;tweet&nbsp;will&nbsp;include&nbsp;a&nbsp;node&nbsp;called&nbsp;"entities,".<br>
  622. &nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;node&nbsp;offers&nbsp;a&nbsp;variety&nbsp;of&nbsp;metadata&nbsp;about&nbsp;the&nbsp;tweet&nbsp;in&nbsp;a<br>
  623. &nbsp;&nbsp;&nbsp;&nbsp;discreet&nbsp;structure,&nbsp;including:&nbsp;user_mentions,&nbsp;urls,&nbsp;and<br>
  624. &nbsp;&nbsp;&nbsp;&nbsp;hashtags.&nbsp;[Optional]<br>
  625. &nbsp;<br>
  626. Returns:<br>
  627. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message&nbsp;up&nbsp;to&nbsp;count</tt></dd></dl>
  628. <dl><dt><a name="Api-MaximumHitFrequency"><strong>MaximumHitFrequency</strong></a>(self)</dt><dd><tt>Determines&nbsp;the&nbsp;minimum&nbsp;number&nbsp;of&nbsp;seconds&nbsp;that&nbsp;a&nbsp;program&nbsp;must&nbsp;wait<br>
  629. before&nbsp;hitting&nbsp;the&nbsp;server&nbsp;again&nbsp;without&nbsp;exceeding&nbsp;the&nbsp;rate_limit<br>
  630. imposed&nbsp;for&nbsp;the&nbsp;currently&nbsp;authenticated&nbsp;user.<br>
  631. &nbsp;<br>
  632. Returns:<br>
  633. &nbsp;&nbsp;The&nbsp;minimum&nbsp;second&nbsp;interval&nbsp;that&nbsp;a&nbsp;program&nbsp;must&nbsp;use&nbsp;so&nbsp;as&nbsp;to&nbsp;not<br>
  634. &nbsp;&nbsp;exceed&nbsp;the&nbsp;rate_limit&nbsp;imposed&nbsp;for&nbsp;the&nbsp;user.</tt></dd></dl>
  635. <dl><dt><a name="Api-PostDirectMessage"><strong>PostDirectMessage</strong></a>(self, user, text)</dt><dd><tt>Post&nbsp;a&nbsp;twitter&nbsp;direct&nbsp;message&nbsp;from&nbsp;the&nbsp;authenticated&nbsp;user<br>
  636. &nbsp;<br>
  637. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  638. &nbsp;<br>
  639. Args:<br>
  640. &nbsp;&nbsp;user:&nbsp;The&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;recipient&nbsp;user.<br>
  641. &nbsp;&nbsp;text:&nbsp;The&nbsp;message&nbsp;text&nbsp;to&nbsp;be&nbsp;posted.&nbsp;&nbsp;Must&nbsp;be&nbsp;less&nbsp;than&nbsp;140&nbsp;characters.<br>
  642. &nbsp;<br>
  643. Returns:<br>
  644. &nbsp;&nbsp;A&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;message&nbsp;posted</tt></dd></dl>
  645. <dl><dt><a name="Api-PostUpdate"><strong>PostUpdate</strong></a>(self, status, in_reply_to_status_id<font color="#909090">=None</font>)</dt><dd><tt>Post&nbsp;a&nbsp;twitter&nbsp;status&nbsp;message&nbsp;from&nbsp;the&nbsp;authenticated&nbsp;user.<br>
  646. &nbsp;<br>
  647. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  648. &nbsp;<br>
  649. Args:<br>
  650. &nbsp;&nbsp;status:<br>
  651. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;message&nbsp;text&nbsp;to&nbsp;be&nbsp;posted.<br>
  652. &nbsp;&nbsp;&nbsp;&nbsp;Must&nbsp;be&nbsp;less&nbsp;than&nbsp;or&nbsp;equal&nbsp;to&nbsp;140&nbsp;characters.<br>
  653. &nbsp;&nbsp;in_reply_to_status_id:<br>
  654. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;ID&nbsp;of&nbsp;an&nbsp;existing&nbsp;status&nbsp;that&nbsp;the&nbsp;status&nbsp;to&nbsp;be&nbsp;posted&nbsp;is<br>
  655. &nbsp;&nbsp;&nbsp;&nbsp;in&nbsp;reply&nbsp;to.&nbsp;&nbsp;This&nbsp;implicitly&nbsp;sets&nbsp;the&nbsp;in_reply_to_user_id<br>
  656. &nbsp;&nbsp;&nbsp;&nbsp;attribute&nbsp;of&nbsp;the&nbsp;resulting&nbsp;status&nbsp;to&nbsp;the&nbsp;user&nbsp;ID&nbsp;of&nbsp;the<br>
  657. &nbsp;&nbsp;&nbsp;&nbsp;message&nbsp;being&nbsp;replied&nbsp;to.&nbsp;&nbsp;Invalid/missing&nbsp;status&nbsp;IDs&nbsp;will&nbsp;be<br>
  658. &nbsp;&nbsp;&nbsp;&nbsp;ignored.&nbsp;[Optional]<br>
  659. Returns:<br>
  660. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;message&nbsp;posted.</tt></dd></dl>
  661. <dl><dt><a name="Api-PostUpdates"><strong>PostUpdates</strong></a>(self, status, continuation<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Post&nbsp;one&nbsp;or&nbsp;more&nbsp;twitter&nbsp;status&nbsp;messages&nbsp;from&nbsp;the&nbsp;authenticated&nbsp;user.<br>
  662. &nbsp;<br>
  663. Unlike&nbsp;api.PostUpdate,&nbsp;this&nbsp;method&nbsp;will&nbsp;post&nbsp;multiple&nbsp;status&nbsp;updates<br>
  664. if&nbsp;the&nbsp;message&nbsp;is&nbsp;longer&nbsp;than&nbsp;140&nbsp;characters.<br>
  665. &nbsp;<br>
  666. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  667. &nbsp;<br>
  668. Args:<br>
  669. &nbsp;&nbsp;status:<br>
  670. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;message&nbsp;text&nbsp;to&nbsp;be&nbsp;posted.<br>
  671. &nbsp;&nbsp;&nbsp;&nbsp;May&nbsp;be&nbsp;longer&nbsp;than&nbsp;140&nbsp;characters.<br>
  672. &nbsp;&nbsp;continuation:<br>
  673. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;character&nbsp;string,&nbsp;if&nbsp;any,&nbsp;to&nbsp;be&nbsp;appended&nbsp;to&nbsp;all&nbsp;but&nbsp;the<br>
  674. &nbsp;&nbsp;&nbsp;&nbsp;last&nbsp;message.&nbsp;&nbsp;Note&nbsp;that&nbsp;Twitter&nbsp;strips&nbsp;trailing&nbsp;'...'&nbsp;strings<br>
  675. &nbsp;&nbsp;&nbsp;&nbsp;from&nbsp;messages.&nbsp;&nbsp;Consider&nbsp;using&nbsp;the&nbsp;unicode&nbsp;\u2026&nbsp;character<br>
  676. &nbsp;&nbsp;&nbsp;&nbsp;(horizontal&nbsp;ellipsis)&nbsp;instead.&nbsp;[Defaults&nbsp;to&nbsp;None]<br>
  677. &nbsp;&nbsp;**kwargs:<br>
  678. &nbsp;&nbsp;&nbsp;&nbsp;See&nbsp;api.PostUpdate&nbsp;for&nbsp;a&nbsp;list&nbsp;of&nbsp;accepted&nbsp;parameters.<br>
  679. &nbsp;<br>
  680. Returns:<br>
  681. &nbsp;&nbsp;A&nbsp;of&nbsp;list&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;messages&nbsp;posted.</tt></dd></dl>
  682. <dl><dt><a name="Api-SetCache"><strong>SetCache</strong></a>(self, cache)</dt><dd><tt>Override&nbsp;the&nbsp;default&nbsp;cache.&nbsp;&nbsp;Set&nbsp;to&nbsp;None&nbsp;to&nbsp;prevent&nbsp;caching.<br>
  683. &nbsp;<br>
  684. Args:<br>
  685. &nbsp;&nbsp;cache:<br>
  686. &nbsp;&nbsp;&nbsp;&nbsp;An&nbsp;instance&nbsp;that&nbsp;supports&nbsp;the&nbsp;same&nbsp;API&nbsp;as&nbsp;the&nbsp;twitter._FileCache</tt></dd></dl>
  687. <dl><dt><a name="Api-SetCacheTimeout"><strong>SetCacheTimeout</strong></a>(self, cache_timeout)</dt><dd><tt>Override&nbsp;the&nbsp;default&nbsp;cache&nbsp;timeout.<br>
  688. &nbsp;<br>
  689. Args:<br>
  690. &nbsp;&nbsp;cache_timeout:<br>
  691. &nbsp;&nbsp;&nbsp;&nbsp;Time,&nbsp;in&nbsp;seconds,&nbsp;that&nbsp;responses&nbsp;should&nbsp;be&nbsp;reused.</tt></dd></dl>
  692. <dl><dt><a name="Api-SetCredentials"><strong>SetCredentials</strong></a>(self, consumer_key, consumer_secret, access_token_key<font color="#909090">=None</font>, access_token_secret<font color="#909090">=None</font>)</dt><dd><tt>Set&nbsp;the&nbsp;consumer_key&nbsp;and&nbsp;consumer_secret&nbsp;for&nbsp;this&nbsp;instance<br>
  693. &nbsp;<br>
  694. Args:<br>
  695. &nbsp;&nbsp;consumer_key:<br>
  696. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;consumer_key&nbsp;of&nbsp;the&nbsp;twitter&nbsp;account.<br>
  697. &nbsp;&nbsp;consumer_secret:<br>
  698. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;consumer_secret&nbsp;for&nbsp;the&nbsp;twitter&nbsp;account.<br>
  699. &nbsp;&nbsp;access_token_key:<br>
  700. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;oAuth&nbsp;access&nbsp;token&nbsp;key&nbsp;value&nbsp;you&nbsp;retrieved<br>
  701. &nbsp;&nbsp;&nbsp;&nbsp;from&nbsp;running&nbsp;get_access_token.py.<br>
  702. &nbsp;&nbsp;access_token_secret:<br>
  703. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;oAuth&nbsp;access&nbsp;token's&nbsp;secret,&nbsp;also&nbsp;retrieved<br>
  704. &nbsp;&nbsp;&nbsp;&nbsp;from&nbsp;the&nbsp;get_access_token.py&nbsp;run.</tt></dd></dl>
  705. <dl><dt><a name="Api-SetSource"><strong>SetSource</strong></a>(self, source)</dt><dd><tt>Suggest&nbsp;the&nbsp;"from&nbsp;source"&nbsp;value&nbsp;to&nbsp;be&nbsp;displayed&nbsp;on&nbsp;the&nbsp;Twitter&nbsp;web&nbsp;site.<br>
  706. &nbsp;<br>
  707. The&nbsp;value&nbsp;of&nbsp;the&nbsp;'source'&nbsp;parameter&nbsp;must&nbsp;be&nbsp;first&nbsp;recognized&nbsp;by<br>
  708. the&nbsp;Twitter&nbsp;server.&nbsp;&nbsp;New&nbsp;source&nbsp;values&nbsp;are&nbsp;authorized&nbsp;on&nbsp;a&nbsp;case&nbsp;by<br>
  709. case&nbsp;basis&nbsp;by&nbsp;the&nbsp;Twitter&nbsp;development&nbsp;team.<br>
  710. &nbsp;<br>
  711. Args:<br>
  712. &nbsp;&nbsp;source:<br>
  713. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;source&nbsp;name&nbsp;as&nbsp;a&nbsp;string.&nbsp;&nbsp;Will&nbsp;be&nbsp;sent&nbsp;to&nbsp;the&nbsp;server&nbsp;as<br>
  714. &nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;'source'&nbsp;parameter.</tt></dd></dl>
  715. <dl><dt><a name="Api-SetUrllib"><strong>SetUrllib</strong></a>(self, urllib)</dt><dd><tt>Override&nbsp;the&nbsp;default&nbsp;urllib&nbsp;implementation.<br>
  716. &nbsp;<br>
  717. Args:<br>
  718. &nbsp;&nbsp;urllib:<br>
  719. &nbsp;&nbsp;&nbsp;&nbsp;An&nbsp;instance&nbsp;that&nbsp;supports&nbsp;the&nbsp;same&nbsp;API&nbsp;as&nbsp;the&nbsp;urllib2&nbsp;module</tt></dd></dl>
  720. <dl><dt><a name="Api-SetUserAgent"><strong>SetUserAgent</strong></a>(self, user_agent)</dt><dd><tt>Override&nbsp;the&nbsp;default&nbsp;user&nbsp;agent<br>
  721. &nbsp;<br>
  722. Args:<br>
  723. &nbsp;&nbsp;user_agent:<br>
  724. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;string&nbsp;that&nbsp;should&nbsp;be&nbsp;send&nbsp;to&nbsp;the&nbsp;server&nbsp;as&nbsp;the&nbsp;<a href="#User">User</a>-agent</tt></dd></dl>
  725. <dl><dt><a name="Api-SetXTwitterHeaders"><strong>SetXTwitterHeaders</strong></a>(self, client, url, version)</dt><dd><tt>Set&nbsp;the&nbsp;X-Twitter&nbsp;HTTP&nbsp;headers&nbsp;that&nbsp;will&nbsp;be&nbsp;sent&nbsp;to&nbsp;the&nbsp;server.<br>
  726. &nbsp;<br>
  727. Args:<br>
  728. &nbsp;&nbsp;client:<br>
  729. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;client&nbsp;name&nbsp;as&nbsp;a&nbsp;string.&nbsp;&nbsp;Will&nbsp;be&nbsp;sent&nbsp;to&nbsp;the&nbsp;server&nbsp;as<br>
  730. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;'X-Twitter-Client'&nbsp;header.<br>
  731. &nbsp;&nbsp;url:<br>
  732. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;meta.xml&nbsp;as&nbsp;a&nbsp;string.&nbsp;&nbsp;Will&nbsp;be&nbsp;sent&nbsp;to&nbsp;the&nbsp;server<br>
  733. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;as&nbsp;the&nbsp;'X-Twitter-Client-URL'&nbsp;header.<br>
  734. &nbsp;&nbsp;version:<br>
  735. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;client&nbsp;version&nbsp;as&nbsp;a&nbsp;string.&nbsp;&nbsp;Will&nbsp;be&nbsp;sent&nbsp;to&nbsp;the&nbsp;server<br>
  736. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;as&nbsp;the&nbsp;'X-Twitter-Client-Version'&nbsp;header.</tt></dd></dl>
  737. <dl><dt><a name="Api-UsersLookup"><strong>UsersLookup</strong></a>(self, user_id<font color="#909090">=None</font>, screen_name<font color="#909090">=None</font>, users<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;extended&nbsp;information&nbsp;for&nbsp;the&nbsp;specified&nbsp;users.<br>
  738. &nbsp;<br>
  739. Users&nbsp;may&nbsp;be&nbsp;specified&nbsp;either&nbsp;as&nbsp;lists&nbsp;of&nbsp;either&nbsp;user_ids,<br>
  740. screen_names,&nbsp;or&nbsp;twitter.<a href="#User">User</a>&nbsp;objects.&nbsp;The&nbsp;list&nbsp;of&nbsp;users&nbsp;that<br>
  741. are&nbsp;queried&nbsp;is&nbsp;the&nbsp;union&nbsp;of&nbsp;all&nbsp;specified&nbsp;parameters.<br>
  742. &nbsp;<br>
  743. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  744. &nbsp;<br>
  745. Args:<br>
  746. &nbsp;&nbsp;user_id:<br>
  747. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;user_ids&nbsp;to&nbsp;retrieve&nbsp;extended&nbsp;information.<br>
  748. &nbsp;&nbsp;&nbsp;&nbsp;[Optional]<br>
  749. &nbsp;&nbsp;screen_name:<br>
  750. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;screen_names&nbsp;to&nbsp;retrieve&nbsp;extended&nbsp;information.<br>
  751. &nbsp;&nbsp;&nbsp;&nbsp;[Optional]<br>
  752. &nbsp;&nbsp;users:<br>
  753. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;objects&nbsp;to&nbsp;retrieve&nbsp;extended&nbsp;information.<br>
  754. &nbsp;&nbsp;&nbsp;&nbsp;[Optional]<br>
  755. &nbsp;<br>
  756. Returns:<br>
  757. &nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;objects&nbsp;for&nbsp;the&nbsp;requested&nbsp;users</tt></dd></dl>
  758. <dl><dt><a name="Api-VerifyCredentials"><strong>VerifyCredentials</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;if&nbsp;the&nbsp;authenticating&nbsp;user&nbsp;is&nbsp;valid.<br>
  759. &nbsp;<br>
  760. Returns:<br>
  761. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;that&nbsp;user&nbsp;if&nbsp;the<br>
  762. &nbsp;&nbsp;credentials&nbsp;are&nbsp;valid,&nbsp;None&nbsp;otherwise.</tt></dd></dl>
  763. <dl><dt><a name="Api-__init__"><strong>__init__</strong></a>(self, consumer_key<font color="#909090">=None</font>, consumer_secret<font color="#909090">=None</font>, access_token_key<font color="#909090">=None</font>, access_token_secret<font color="#909090">=None</font>, input_encoding<font color="#909090">=None</font>, request_headers<font color="#909090">=None</font>, cache<font color="#909090">=&lt;object object at 0x1001da0a0&gt;</font>, shortner<font color="#909090">=None</font>, base_url<font color="#909090">=None</font>, use_gzip_compression<font color="#909090">=False</font>, debugHTTP<font color="#909090">=False</font>)</dt><dd><tt>Instantiate&nbsp;a&nbsp;new&nbsp;twitter.<a href="#Api">Api</a>&nbsp;<a href="__builtin__.html#object">object</a>.<br>
  764. &nbsp;<br>
  765. Args:<br>
  766. &nbsp;&nbsp;consumer_key:<br>
  767. &nbsp;&nbsp;&nbsp;&nbsp;Your&nbsp;Twitter&nbsp;user's&nbsp;consumer_key.<br>
  768. &nbsp;&nbsp;consumer_secret:<br>
  769. &nbsp;&nbsp;&nbsp;&nbsp;Your&nbsp;Twitter&nbsp;user's&nbsp;consumer_secret.<br>
  770. &nbsp;&nbsp;access_token_key:<br>
  771. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;oAuth&nbsp;access&nbsp;token&nbsp;key&nbsp;value&nbsp;you&nbsp;retrieved<br>
  772. &nbsp;&nbsp;&nbsp;&nbsp;from&nbsp;running&nbsp;get_access_token.py.<br>
  773. &nbsp;&nbsp;access_token_secret:<br>
  774. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;oAuth&nbsp;access&nbsp;token's&nbsp;secret,&nbsp;also&nbsp;retrieved<br>
  775. &nbsp;&nbsp;&nbsp;&nbsp;from&nbsp;the&nbsp;get_access_token.py&nbsp;run.<br>
  776. &nbsp;&nbsp;input_encoding:<br>
  777. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;encoding&nbsp;used&nbsp;to&nbsp;encode&nbsp;input&nbsp;strings.&nbsp;[Optional]<br>
  778. &nbsp;&nbsp;request_header:<br>
  779. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;dictionary&nbsp;of&nbsp;additional&nbsp;HTTP&nbsp;request&nbsp;headers.&nbsp;[Optional]<br>
  780. &nbsp;&nbsp;cache:<br>
  781. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;cache&nbsp;instance&nbsp;to&nbsp;use.&nbsp;Defaults&nbsp;to&nbsp;DEFAULT_CACHE.<br>
  782. &nbsp;&nbsp;&nbsp;&nbsp;Use&nbsp;None&nbsp;to&nbsp;disable&nbsp;caching.&nbsp;[Optional]<br>
  783. &nbsp;&nbsp;shortner:<br>
  784. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;shortner&nbsp;instance&nbsp;to&nbsp;use.&nbsp;&nbsp;Defaults&nbsp;to&nbsp;None.<br>
  785. &nbsp;&nbsp;&nbsp;&nbsp;See&nbsp;shorten_url.py&nbsp;for&nbsp;an&nbsp;example&nbsp;shortner.&nbsp;[Optional]<br>
  786. &nbsp;&nbsp;base_url:<br>
  787. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;base&nbsp;URL&nbsp;to&nbsp;use&nbsp;to&nbsp;contact&nbsp;the&nbsp;Twitter&nbsp;API.<br>
  788. &nbsp;&nbsp;&nbsp;&nbsp;Defaults&nbsp;to&nbsp;https://twitter.com.&nbsp;[Optional]<br>
  789. &nbsp;&nbsp;use_gzip_compression:<br>
  790. &nbsp;&nbsp;&nbsp;&nbsp;Set&nbsp;to&nbsp;True&nbsp;to&nbsp;tell&nbsp;enable&nbsp;gzip&nbsp;compression&nbsp;for&nbsp;any&nbsp;call<br>
  791. &nbsp;&nbsp;&nbsp;&nbsp;made&nbsp;to&nbsp;Twitter.&nbsp;&nbsp;Defaults&nbsp;to&nbsp;False.&nbsp;[Optional]<br>
  792. &nbsp;&nbsp;debugHTTP:<br>
  793. &nbsp;&nbsp;&nbsp;&nbsp;Set&nbsp;to&nbsp;True&nbsp;to&nbsp;enable&nbsp;debug&nbsp;output&nbsp;from&nbsp;urllib2&nbsp;when&nbsp;performing<br>
  794. &nbsp;&nbsp;&nbsp;&nbsp;any&nbsp;HTTP&nbsp;requests.&nbsp;&nbsp;Defaults&nbsp;to&nbsp;False.&nbsp;[Optional]</tt></dd></dl>
  795. <hr>
  796. Data descriptors defined here:<br>
  797. <dl><dt><strong>__dict__</strong></dt>
  798. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  799. </dl>
  800. <dl><dt><strong>__weakref__</strong></dt>
  801. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  802. </dl>
  803. <hr>
  804. Data and other attributes defined here:<br>
  805. <dl><dt><strong>DEFAULT_CACHE_TIMEOUT</strong> = 60</dl>
  806. </td></tr></table> <p>
  807. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  808. <tr bgcolor="#ffc8d8">
  809. <td colspan=3 valign=bottom>&nbsp;<br>
  810. <font color="#000000" face="helvetica, arial"><a name="DirectMessage">class <strong>DirectMessage</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  811. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  812. <td colspan=2><tt>A&nbsp;class&nbsp;representing&nbsp;the&nbsp;<a href="#DirectMessage">DirectMessage</a>&nbsp;structure&nbsp;used&nbsp;by&nbsp;the&nbsp;twitter&nbsp;API.<br>
  813. &nbsp;<br>
  814. The&nbsp;<a href="#DirectMessage">DirectMessage</a>&nbsp;structure&nbsp;exposes&nbsp;the&nbsp;following&nbsp;properties:<br>
  815. &nbsp;<br>
  816. &nbsp;&nbsp;direct_message.id<br>
  817. &nbsp;&nbsp;direct_message.created_at<br>
  818. &nbsp;&nbsp;direct_message.created_at_in_seconds&nbsp;#&nbsp;read&nbsp;only<br>
  819. &nbsp;&nbsp;direct_message.sender_id<br>
  820. &nbsp;&nbsp;direct_message.sender_screen_name<br>
  821. &nbsp;&nbsp;direct_message.recipient_id<br>
  822. &nbsp;&nbsp;direct_message.recipient_screen_name<br>
  823. &nbsp;&nbsp;direct_message.text<br>&nbsp;</tt></td></tr>
  824. <tr><td>&nbsp;</td>
  825. <td width="100%">Methods defined here:<br>
  826. <dl><dt><a name="DirectMessage-AsDict"><strong>AsDict</strong></a>(self)</dt><dd><tt>A&nbsp;dict&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance.<br>
  827. &nbsp;<br>
  828. The&nbsp;return&nbsp;value&nbsp;uses&nbsp;the&nbsp;same&nbsp;key&nbsp;names&nbsp;as&nbsp;the&nbsp;JSON&nbsp;representation.<br>
  829. &nbsp;<br>
  830. Return:<br>
  831. &nbsp;&nbsp;A&nbsp;dict&nbsp;representing&nbsp;this&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance</tt></dd></dl>
  832. <dl><dt><a name="DirectMessage-AsJsonString"><strong>AsJsonString</strong></a>(self)</dt><dd><tt>A&nbsp;JSON&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance.<br>
  833. &nbsp;<br>
  834. Returns:<br>
  835. &nbsp;&nbsp;A&nbsp;JSON&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance</tt></dd></dl>
  836. <dl><dt><a name="DirectMessage-GetCreatedAt"><strong>GetCreatedAt</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;posted.<br>
  837. &nbsp;<br>
  838. Returns:<br>
  839. &nbsp;&nbsp;The&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;posted</tt></dd></dl>
  840. <dl><dt><a name="DirectMessage-GetCreatedAtInSeconds"><strong>GetCreatedAtInSeconds</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;posted,&nbsp;in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.<br>
  841. &nbsp;<br>
  842. Returns:<br>
  843. &nbsp;&nbsp;The&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;posted,&nbsp;in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.</tt></dd></dl>
  844. <dl><dt><a name="DirectMessage-GetId"><strong>GetId</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  845. &nbsp;<br>
  846. Returns:<br>
  847. &nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  848. <dl><dt><a name="DirectMessage-GetRecipientId"><strong>GetRecipientId</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;unique&nbsp;recipient&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  849. &nbsp;<br>
  850. Returns:<br>
  851. &nbsp;&nbsp;The&nbsp;unique&nbsp;recipient&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  852. <dl><dt><a name="DirectMessage-GetRecipientScreenName"><strong>GetRecipientScreenName</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;unique&nbsp;recipient&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  853. &nbsp;<br>
  854. Returns:<br>
  855. &nbsp;&nbsp;The&nbsp;unique&nbsp;recipient&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  856. <dl><dt><a name="DirectMessage-GetSenderId"><strong>GetSenderId</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;unique&nbsp;sender&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  857. &nbsp;<br>
  858. Returns:<br>
  859. &nbsp;&nbsp;The&nbsp;unique&nbsp;sender&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  860. <dl><dt><a name="DirectMessage-GetSenderScreenName"><strong>GetSenderScreenName</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;unique&nbsp;sender&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  861. &nbsp;<br>
  862. Returns:<br>
  863. &nbsp;&nbsp;The&nbsp;unique&nbsp;sender&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  864. <dl><dt><a name="DirectMessage-GetText"><strong>GetText</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;text&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  865. &nbsp;<br>
  866. Returns:<br>
  867. &nbsp;&nbsp;The&nbsp;text&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.</tt></dd></dl>
  868. <dl><dt><a name="DirectMessage-SetCreatedAt"><strong>SetCreatedAt</strong></a>(self, created_at)</dt><dd><tt>Set&nbsp;the&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;posted.<br>
  869. &nbsp;<br>
  870. Args:<br>
  871. &nbsp;&nbsp;created_at:<br>
  872. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;created</tt></dd></dl>
  873. <dl><dt><a name="DirectMessage-SetId"><strong>SetId</strong></a>(self, id)</dt><dd><tt>Set&nbsp;the&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  874. &nbsp;<br>
  875. Args:<br>
  876. &nbsp;&nbsp;id:<br>
  877. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  878. <dl><dt><a name="DirectMessage-SetRecipientId"><strong>SetRecipientId</strong></a>(self, recipient_id)</dt><dd><tt>Set&nbsp;the&nbsp;unique&nbsp;recipient&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  879. &nbsp;<br>
  880. Args:<br>
  881. &nbsp;&nbsp;recipient_id:<br>
  882. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;recipient&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  883. <dl><dt><a name="DirectMessage-SetRecipientScreenName"><strong>SetRecipientScreenName</strong></a>(self, recipient_screen_name)</dt><dd><tt>Set&nbsp;the&nbsp;unique&nbsp;recipient&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  884. &nbsp;<br>
  885. Args:<br>
  886. &nbsp;&nbsp;recipient_screen_name:<br>
  887. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;recipient&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  888. <dl><dt><a name="DirectMessage-SetSenderId"><strong>SetSenderId</strong></a>(self, sender_id)</dt><dd><tt>Set&nbsp;the&nbsp;unique&nbsp;sender&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  889. &nbsp;<br>
  890. Args:<br>
  891. &nbsp;&nbsp;sender_id:<br>
  892. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;sender&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  893. <dl><dt><a name="DirectMessage-SetSenderScreenName"><strong>SetSenderScreenName</strong></a>(self, sender_screen_name)</dt><dd><tt>Set&nbsp;the&nbsp;unique&nbsp;sender&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  894. &nbsp;<br>
  895. Args:<br>
  896. &nbsp;&nbsp;sender_screen_name:<br>
  897. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;sender&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  898. <dl><dt><a name="DirectMessage-SetText"><strong>SetText</strong></a>(self, text)</dt><dd><tt>Set&nbsp;the&nbsp;text&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.<br>
  899. &nbsp;<br>
  900. Args:<br>
  901. &nbsp;&nbsp;text:<br>
  902. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;text&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd></dl>
  903. <dl><dt><a name="DirectMessage-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl>
  904. <dl><dt><a name="DirectMessage-__init__"><strong>__init__</strong></a>(self, id<font color="#909090">=None</font>, created_at<font color="#909090">=None</font>, sender_id<font color="#909090">=None</font>, sender_screen_name<font color="#909090">=None</font>, recipient_id<font color="#909090">=None</font>, recipient_screen_name<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt><dd><tt>An&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;to&nbsp;hold&nbsp;a&nbsp;Twitter&nbsp;direct&nbsp;message.<br>
  905. &nbsp;<br>
  906. This&nbsp;class&nbsp;is&nbsp;normally&nbsp;instantiated&nbsp;by&nbsp;the&nbsp;twitter.<a href="#Api">Api</a>&nbsp;class&nbsp;and<br>
  907. returned&nbsp;in&nbsp;a&nbsp;sequence.<br>
  908. &nbsp;<br>
  909. Note:&nbsp;Dates&nbsp;are&nbsp;posted&nbsp;in&nbsp;the&nbsp;form&nbsp;"Sat&nbsp;Jan&nbsp;27&nbsp;04:17:38&nbsp;+0000&nbsp;2007"<br>
  910. &nbsp;<br>
  911. Args:<br>
  912. &nbsp;&nbsp;id:<br>
  913. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.&nbsp;[Optional]<br>
  914. &nbsp;&nbsp;created_at:<br>
  915. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;posted.&nbsp;[Optional]<br>
  916. &nbsp;&nbsp;sender_id:<br>
  917. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;twitter&nbsp;user&nbsp;that&nbsp;sent&nbsp;this&nbsp;message.&nbsp;[Optional]<br>
  918. &nbsp;&nbsp;sender_screen_name:<br>
  919. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;twitter&nbsp;user&nbsp;that&nbsp;sent&nbsp;this&nbsp;message.&nbsp;[Optional]<br>
  920. &nbsp;&nbsp;recipient_id:<br>
  921. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;twitter&nbsp;that&nbsp;received&nbsp;this&nbsp;message.&nbsp;[Optional]<br>
  922. &nbsp;&nbsp;recipient_screen_name:<br>
  923. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;twitter&nbsp;that&nbsp;received&nbsp;this&nbsp;message.&nbsp;[Optional]<br>
  924. &nbsp;&nbsp;text:<br>
  925. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;text&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.&nbsp;[Optional]</tt></dd></dl>
  926. <dl><dt><a name="DirectMessage-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl>
  927. <dl><dt><a name="DirectMessage-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>A&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance.<br>
  928. &nbsp;<br>
  929. The&nbsp;return&nbsp;value&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;the&nbsp;JSON&nbsp;string&nbsp;representation.<br>
  930. &nbsp;<br>
  931. Returns:<br>
  932. &nbsp;&nbsp;A&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance.</tt></dd></dl>
  933. <hr>
  934. Static methods defined here:<br>
  935. <dl><dt><a name="DirectMessage-NewFromJsonDict"><strong>NewFromJsonDict</strong></a>(data)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;instance&nbsp;based&nbsp;on&nbsp;a&nbsp;JSON&nbsp;dict.<br>
  936. &nbsp;<br>
  937. Args:<br>
  938. &nbsp;&nbsp;data:<br>
  939. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;JSON&nbsp;dict,&nbsp;as&nbsp;converted&nbsp;from&nbsp;the&nbsp;JSON&nbsp;in&nbsp;the&nbsp;twitter&nbsp;API<br>
  940. &nbsp;<br>
  941. Returns:<br>
  942. &nbsp;&nbsp;A&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance</tt></dd></dl>
  943. <hr>
  944. Data descriptors defined here:<br>
  945. <dl><dt><strong>__dict__</strong></dt>
  946. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  947. </dl>
  948. <dl><dt><strong>__weakref__</strong></dt>
  949. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  950. </dl>
  951. <dl><dt><strong>created_at</strong></dt>
  952. <dd><tt>The&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;posted.</tt></dd>
  953. </dl>
  954. <dl><dt><strong>created_at_in_seconds</strong></dt>
  955. <dd><tt>The&nbsp;time&nbsp;this&nbsp;direct&nbsp;message&nbsp;was&nbsp;posted,&nbsp;in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch</tt></dd>
  956. </dl>
  957. <dl><dt><strong>id</strong></dt>
  958. <dd><tt>The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.</tt></dd>
  959. </dl>
  960. <dl><dt><strong>recipient_id</strong></dt>
  961. <dd><tt>The&nbsp;unique&nbsp;recipient&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.</tt></dd>
  962. </dl>
  963. <dl><dt><strong>recipient_screen_name</strong></dt>
  964. <dd><tt>The&nbsp;unique&nbsp;recipient&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.</tt></dd>
  965. </dl>
  966. <dl><dt><strong>sender_id</strong></dt>
  967. <dd><tt>The&nbsp;unique&nbsp;sender&nbsp;id&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.</tt></dd>
  968. </dl>
  969. <dl><dt><strong>sender_screen_name</strong></dt>
  970. <dd><tt>The&nbsp;unique&nbsp;sender&nbsp;screen&nbsp;name&nbsp;of&nbsp;this&nbsp;direct&nbsp;message.</tt></dd>
  971. </dl>
  972. <dl><dt><strong>text</strong></dt>
  973. <dd><tt>The&nbsp;text&nbsp;of&nbsp;this&nbsp;direct&nbsp;message</tt></dd>
  974. </dl>
  975. </td></tr></table> <p>
  976. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  977. <tr bgcolor="#ffc8d8">
  978. <td colspan=3 valign=bottom>&nbsp;<br>
  979. <font color="#000000" face="helvetica, arial"><a name="Hashtag">class <strong>Hashtag</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  980. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  981. <td colspan=2><tt>A&nbsp;class&nbsp;represeinting&nbsp;a&nbsp;twitter&nbsp;hashtag<br>&nbsp;</tt></td></tr>
  982. <tr><td>&nbsp;</td>
  983. <td width="100%">Methods defined here:<br>
  984. <dl><dt><a name="Hashtag-__init__"><strong>__init__</strong></a>(self, text<font color="#909090">=None</font>)</dt></dl>
  985. <hr>
  986. Static methods defined here:<br>
  987. <dl><dt><a name="Hashtag-NewFromJsonDict"><strong>NewFromJsonDict</strong></a>(data)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;instance&nbsp;based&nbsp;on&nbsp;a&nbsp;JSON&nbsp;dict.<br>
  988. &nbsp;<br>
  989. Args:<br>
  990. &nbsp;&nbsp;data:<br>
  991. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;JSON&nbsp;dict,&nbsp;as&nbsp;converted&nbsp;from&nbsp;the&nbsp;JSON&nbsp;in&nbsp;the&nbsp;twitter&nbsp;API<br>
  992. &nbsp;<br>
  993. Returns:<br>
  994. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Hashtag">Hashtag</a>&nbsp;instance</tt></dd></dl>
  995. <hr>
  996. Data descriptors defined here:<br>
  997. <dl><dt><strong>__dict__</strong></dt>
  998. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  999. </dl>
  1000. <dl><dt><strong>__weakref__</strong></dt>
  1001. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  1002. </dl>
  1003. </td></tr></table> <p>
  1004. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1005. <tr bgcolor="#ffc8d8">
  1006. <td colspan=3 valign=bottom>&nbsp;<br>
  1007. <font color="#000000" face="helvetica, arial"><a name="List">class <strong>List</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  1008. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  1009. <td colspan=2><tt>A&nbsp;class&nbsp;representing&nbsp;the&nbsp;<a href="#List">List</a>&nbsp;structure&nbsp;used&nbsp;by&nbsp;the&nbsp;twitter&nbsp;API.<br>
  1010. &nbsp;<br>
  1011. The&nbsp;<a href="#List">List</a>&nbsp;structure&nbsp;exposes&nbsp;the&nbsp;following&nbsp;properties:<br>
  1012. &nbsp;<br>
  1013. &nbsp;&nbsp;list.id<br>
  1014. &nbsp;&nbsp;list.name<br>
  1015. &nbsp;&nbsp;list.slug<br>
  1016. &nbsp;&nbsp;list.description<br>
  1017. &nbsp;&nbsp;list.full_name<br>
  1018. &nbsp;&nbsp;list.mode<br>
  1019. &nbsp;&nbsp;list.uri<br>
  1020. &nbsp;&nbsp;list.member_count<br>
  1021. &nbsp;&nbsp;list.subscriber_count<br>
  1022. &nbsp;&nbsp;list.following<br>&nbsp;</tt></td></tr>
  1023. <tr><td>&nbsp;</td>
  1024. <td width="100%">Methods defined here:<br>
  1025. <dl><dt><a name="List-AsDict"><strong>AsDict</strong></a>(self)</dt><dd><tt>A&nbsp;dict&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#List">List</a>&nbsp;instance.<br>
  1026. &nbsp;<br>
  1027. The&nbsp;return&nbsp;value&nbsp;uses&nbsp;the&nbsp;same&nbsp;key&nbsp;names&nbsp;as&nbsp;the&nbsp;JSON&nbsp;representation.<br>
  1028. &nbsp;<br>
  1029. Return:<br>
  1030. &nbsp;&nbsp;A&nbsp;dict&nbsp;representing&nbsp;this&nbsp;twitter.<a href="#List">List</a>&nbsp;instance</tt></dd></dl>
  1031. <dl><dt><a name="List-AsJsonString"><strong>AsJsonString</strong></a>(self)</dt><dd><tt>A&nbsp;JSON&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#List">List</a>&nbsp;instance.<br>
  1032. &nbsp;<br>
  1033. Returns:<br>
  1034. &nbsp;&nbsp;A&nbsp;JSON&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#List">List</a>&nbsp;instance</tt></dd></dl>
  1035. <dl><dt><a name="List-GetDescription"><strong>GetDescription</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;description&nbsp;of&nbsp;this&nbsp;list.<br>
  1036. &nbsp;<br>
  1037. Returns:<br>
  1038. &nbsp;&nbsp;The&nbsp;description&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1039. <dl><dt><a name="List-GetFollowing"><strong>GetFollowing</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;following&nbsp;status&nbsp;of&nbsp;this&nbsp;list.<br>
  1040. &nbsp;<br>
  1041. Returns:<br>
  1042. &nbsp;&nbsp;The&nbsp;following&nbsp;status&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1043. <dl><dt><a name="List-GetFull_name"><strong>GetFull_name</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;full_name&nbsp;of&nbsp;this&nbsp;list.<br>
  1044. &nbsp;<br>
  1045. Returns:<br>
  1046. &nbsp;&nbsp;The&nbsp;full_name&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1047. <dl><dt><a name="List-GetId"><strong>GetId</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;list.<br>
  1048. &nbsp;<br>
  1049. Returns:<br>
  1050. &nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1051. <dl><dt><a name="List-GetMember_count"><strong>GetMember_count</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;member_count&nbsp;of&nbsp;this&nbsp;list.<br>
  1052. &nbsp;<br>
  1053. Returns:<br>
  1054. &nbsp;&nbsp;The&nbsp;member_count&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1055. <dl><dt><a name="List-GetMode"><strong>GetMode</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;mode&nbsp;of&nbsp;this&nbsp;list.<br>
  1056. &nbsp;<br>
  1057. Returns:<br>
  1058. &nbsp;&nbsp;The&nbsp;mode&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1059. <dl><dt><a name="List-GetName"><strong>GetName</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;list.<br>
  1060. &nbsp;<br>
  1061. Returns:<br>
  1062. &nbsp;&nbsp;The&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1063. <dl><dt><a name="List-GetSlug"><strong>GetSlug</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;slug&nbsp;of&nbsp;this&nbsp;list.<br>
  1064. &nbsp;<br>
  1065. Returns:<br>
  1066. &nbsp;&nbsp;The&nbsp;slug&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1067. <dl><dt><a name="List-GetSubscriber_count"><strong>GetSubscriber_count</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;subscriber_count&nbsp;of&nbsp;this&nbsp;list.<br>
  1068. &nbsp;<br>
  1069. Returns:<br>
  1070. &nbsp;&nbsp;The&nbsp;subscriber_count&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1071. <dl><dt><a name="List-GetUri"><strong>GetUri</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;uri&nbsp;of&nbsp;this&nbsp;list.<br>
  1072. &nbsp;<br>
  1073. Returns:<br>
  1074. &nbsp;&nbsp;The&nbsp;uri&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1075. <dl><dt><a name="List-GetUser"><strong>GetUser</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;user&nbsp;of&nbsp;this&nbsp;list.<br>
  1076. &nbsp;<br>
  1077. Returns:<br>
  1078. &nbsp;&nbsp;The&nbsp;owner&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1079. <dl><dt><a name="List-SetDescription"><strong>SetDescription</strong></a>(self, description)</dt><dd><tt>Set&nbsp;the&nbsp;description&nbsp;of&nbsp;this&nbsp;list.<br>
  1080. &nbsp;<br>
  1081. Args:<br>
  1082. &nbsp;&nbsp;description:<br>
  1083. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;description&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1084. <dl><dt><a name="List-SetFollowing"><strong>SetFollowing</strong></a>(self, following)</dt><dd><tt>Set&nbsp;the&nbsp;following&nbsp;status&nbsp;of&nbsp;this&nbsp;list.<br>
  1085. &nbsp;<br>
  1086. Args:<br>
  1087. &nbsp;&nbsp;following:<br>
  1088. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;following&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1089. <dl><dt><a name="List-SetFull_name"><strong>SetFull_name</strong></a>(self, full_name)</dt><dd><tt>Set&nbsp;the&nbsp;full_name&nbsp;of&nbsp;this&nbsp;list.<br>
  1090. &nbsp;<br>
  1091. Args:<br>
  1092. &nbsp;&nbsp;full_name:<br>
  1093. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;full_name&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1094. <dl><dt><a name="List-SetId"><strong>SetId</strong></a>(self, id)</dt><dd><tt>Set&nbsp;the&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;list.<br>
  1095. &nbsp;<br>
  1096. Args:<br>
  1097. &nbsp;&nbsp;id:<br>
  1098. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1099. <dl><dt><a name="List-SetMember_count"><strong>SetMember_count</strong></a>(self, member_count)</dt><dd><tt>Set&nbsp;the&nbsp;member_count&nbsp;of&nbsp;this&nbsp;list.<br>
  1100. &nbsp;<br>
  1101. Args:<br>
  1102. &nbsp;&nbsp;member_count:<br>
  1103. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;member_count&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1104. <dl><dt><a name="List-SetMode"><strong>SetMode</strong></a>(self, mode)</dt><dd><tt>Set&nbsp;the&nbsp;mode&nbsp;of&nbsp;this&nbsp;list.<br>
  1105. &nbsp;<br>
  1106. Args:<br>
  1107. &nbsp;&nbsp;mode:<br>
  1108. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;mode&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1109. <dl><dt><a name="List-SetName"><strong>SetName</strong></a>(self, name)</dt><dd><tt>Set&nbsp;the&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;list.<br>
  1110. &nbsp;<br>
  1111. Args:<br>
  1112. &nbsp;&nbsp;name:<br>
  1113. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;list</tt></dd></dl>
  1114. <dl><dt><a name="List-SetSlug"><strong>SetSlug</strong></a>(self, slug)</dt><dd><tt>Set&nbsp;the&nbsp;slug&nbsp;of&nbsp;this&nbsp;list.<br>
  1115. &nbsp;<br>
  1116. Args:<br>
  1117. &nbsp;&nbsp;slug:<br>
  1118. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;slug&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1119. <dl><dt><a name="List-SetSubscriber_count"><strong>SetSubscriber_count</strong></a>(self, subscriber_count)</dt><dd><tt>Set&nbsp;the&nbsp;subscriber_count&nbsp;of&nbsp;this&nbsp;list.<br>
  1120. &nbsp;<br>
  1121. Args:<br>
  1122. &nbsp;&nbsp;subscriber_count:<br>
  1123. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;subscriber_count&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1124. <dl><dt><a name="List-SetUri"><strong>SetUri</strong></a>(self, uri)</dt><dd><tt>Set&nbsp;the&nbsp;uri&nbsp;of&nbsp;this&nbsp;list.<br>
  1125. &nbsp;<br>
  1126. Args:<br>
  1127. &nbsp;&nbsp;uri:<br>
  1128. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;uri&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1129. <dl><dt><a name="List-SetUser"><strong>SetUser</strong></a>(self, user)</dt><dd><tt>Set&nbsp;the&nbsp;user&nbsp;of&nbsp;this&nbsp;list.<br>
  1130. &nbsp;<br>
  1131. Args:<br>
  1132. &nbsp;&nbsp;user:<br>
  1133. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;owner&nbsp;of&nbsp;this&nbsp;list.</tt></dd></dl>
  1134. <dl><dt><a name="List-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl>
  1135. <dl><dt><a name="List-__init__"><strong>__init__</strong></a>(self, id<font color="#909090">=None</font>, name<font color="#909090">=None</font>, slug<font color="#909090">=None</font>, description<font color="#909090">=None</font>, full_name<font color="#909090">=None</font>, mode<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, member_count<font color="#909090">=None</font>, subscriber_count<font color="#909090">=None</font>, following<font color="#909090">=None</font>, user<font color="#909090">=None</font>)</dt></dl>
  1136. <dl><dt><a name="List-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl>
  1137. <dl><dt><a name="List-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>A&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#List">List</a>&nbsp;instance.<br>
  1138. &nbsp;<br>
  1139. The&nbsp;return&nbsp;value&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;the&nbsp;JSON&nbsp;string&nbsp;representation.<br>
  1140. &nbsp;<br>
  1141. Returns:<br>
  1142. &nbsp;&nbsp;A&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#List">List</a>&nbsp;instance.</tt></dd></dl>
  1143. <hr>
  1144. Static methods defined here:<br>
  1145. <dl><dt><a name="List-NewFromJsonDict"><strong>NewFromJsonDict</strong></a>(data)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;instance&nbsp;based&nbsp;on&nbsp;a&nbsp;JSON&nbsp;dict.<br>
  1146. &nbsp;<br>
  1147. Args:<br>
  1148. &nbsp;&nbsp;data:<br>
  1149. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;JSON&nbsp;dict,&nbsp;as&nbsp;converted&nbsp;from&nbsp;the&nbsp;JSON&nbsp;in&nbsp;the&nbsp;twitter&nbsp;API<br>
  1150. &nbsp;<br>
  1151. Returns:<br>
  1152. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance</tt></dd></dl>
  1153. <hr>
  1154. Data descriptors defined here:<br>
  1155. <dl><dt><strong>__dict__</strong></dt>
  1156. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  1157. </dl>
  1158. <dl><dt><strong>__weakref__</strong></dt>
  1159. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  1160. </dl>
  1161. <dl><dt><strong>description</strong></dt>
  1162. <dd><tt>The&nbsp;description&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1163. </dl>
  1164. <dl><dt><strong>following</strong></dt>
  1165. <dd><tt>The&nbsp;following&nbsp;status&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1166. </dl>
  1167. <dl><dt><strong>full_name</strong></dt>
  1168. <dd><tt>The&nbsp;full_name&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1169. </dl>
  1170. <dl><dt><strong>id</strong></dt>
  1171. <dd><tt>The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1172. </dl>
  1173. <dl><dt><strong>member_count</strong></dt>
  1174. <dd><tt>The&nbsp;member_count&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1175. </dl>
  1176. <dl><dt><strong>mode</strong></dt>
  1177. <dd><tt>The&nbsp;mode&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1178. </dl>
  1179. <dl><dt><strong>name</strong></dt>
  1180. <dd><tt>The&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1181. </dl>
  1182. <dl><dt><strong>slug</strong></dt>
  1183. <dd><tt>The&nbsp;slug&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1184. </dl>
  1185. <dl><dt><strong>subscriber_count</strong></dt>
  1186. <dd><tt>The&nbsp;subscriber_count&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1187. </dl>
  1188. <dl><dt><strong>uri</strong></dt>
  1189. <dd><tt>The&nbsp;uri&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1190. </dl>
  1191. <dl><dt><strong>user</strong></dt>
  1192. <dd><tt>The&nbsp;owner&nbsp;of&nbsp;this&nbsp;list.</tt></dd>
  1193. </dl>
  1194. </td></tr></table> <p>
  1195. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1196. <tr bgcolor="#ffc8d8">
  1197. <td colspan=3 valign=bottom>&nbsp;<br>
  1198. <font color="#000000" face="helvetica, arial"><a name="Status">class <strong>Status</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  1199. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  1200. <td colspan=2><tt>A&nbsp;class&nbsp;representing&nbsp;the&nbsp;<a href="#Status">Status</a>&nbsp;structure&nbsp;used&nbsp;by&nbsp;the&nbsp;twitter&nbsp;API.<br>
  1201. &nbsp;<br>
  1202. The&nbsp;<a href="#Status">Status</a>&nbsp;structure&nbsp;exposes&nbsp;the&nbsp;following&nbsp;properties:<br>
  1203. &nbsp;<br>
  1204. &nbsp;&nbsp;status.created_at<br>
  1205. &nbsp;&nbsp;status.created_at_in_seconds&nbsp;#&nbsp;read&nbsp;only<br>
  1206. &nbsp;&nbsp;status.favorited<br>
  1207. &nbsp;&nbsp;status.in_reply_to_screen_name<br>
  1208. &nbsp;&nbsp;status.in_reply_to_user_id<br>
  1209. &nbsp;&nbsp;status.in_reply_to_status_id<br>
  1210. &nbsp;&nbsp;status.truncated<br>
  1211. &nbsp;&nbsp;status.source<br>
  1212. &nbsp;&nbsp;status.id<br>
  1213. &nbsp;&nbsp;status.text<br>
  1214. &nbsp;&nbsp;status.location<br>
  1215. &nbsp;&nbsp;status.relative_created_at&nbsp;#&nbsp;read&nbsp;only<br>
  1216. &nbsp;&nbsp;status.user<br>
  1217. &nbsp;&nbsp;status.urls<br>
  1218. &nbsp;&nbsp;status.user_mentions<br>
  1219. &nbsp;&nbsp;status.hashtags<br>&nbsp;</tt></td></tr>
  1220. <tr><td>&nbsp;</td>
  1221. <td width="100%">Methods defined here:<br>
  1222. <dl><dt><a name="Status-AsDict"><strong>AsDict</strong></a>(self)</dt><dd><tt>A&nbsp;dict&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance.<br>
  1223. &nbsp;<br>
  1224. The&nbsp;return&nbsp;value&nbsp;uses&nbsp;the&nbsp;same&nbsp;key&nbsp;names&nbsp;as&nbsp;the&nbsp;JSON&nbsp;representation.<br>
  1225. &nbsp;<br>
  1226. Return:<br>
  1227. &nbsp;&nbsp;A&nbsp;dict&nbsp;representing&nbsp;this&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance</tt></dd></dl>
  1228. <dl><dt><a name="Status-AsJsonString"><strong>AsJsonString</strong></a>(self)</dt><dd><tt>A&nbsp;JSON&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance.<br>
  1229. &nbsp;<br>
  1230. Returns:<br>
  1231. &nbsp;&nbsp;A&nbsp;JSON&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance</tt></dd></dl>
  1232. <dl><dt><a name="Status-GetCreatedAt"><strong>GetCreatedAt</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;posted.<br>
  1233. &nbsp;<br>
  1234. Returns:<br>
  1235. &nbsp;&nbsp;The&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;posted</tt></dd></dl>
  1236. <dl><dt><a name="Status-GetCreatedAtInSeconds"><strong>GetCreatedAtInSeconds</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;posted,&nbsp;in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.<br>
  1237. &nbsp;<br>
  1238. Returns:<br>
  1239. &nbsp;&nbsp;The&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;posted,&nbsp;in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.</tt></dd></dl>
  1240. <dl><dt><a name="Status-GetFavorited"><strong>GetFavorited</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;favorited&nbsp;setting&nbsp;of&nbsp;this&nbsp;status&nbsp;message.<br>
  1241. &nbsp;<br>
  1242. Returns:<br>
  1243. &nbsp;&nbsp;True&nbsp;if&nbsp;this&nbsp;status&nbsp;message&nbsp;is&nbsp;favorited;&nbsp;False&nbsp;otherwise</tt></dd></dl>
  1244. <dl><dt><a name="Status-GetId"><strong>GetId</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;status&nbsp;message.<br>
  1245. &nbsp;<br>
  1246. Returns:<br>
  1247. &nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;status&nbsp;message</tt></dd></dl>
  1248. <dl><dt><a name="Status-GetInReplyToScreenName"><strong>GetInReplyToScreenName</strong></a>(self)</dt></dl>
  1249. <dl><dt><a name="Status-GetInReplyToStatusId"><strong>GetInReplyToStatusId</strong></a>(self)</dt></dl>
  1250. <dl><dt><a name="Status-GetInReplyToUserId"><strong>GetInReplyToUserId</strong></a>(self)</dt></dl>
  1251. <dl><dt><a name="Status-GetLocation"><strong>GetLocation</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;geolocation&nbsp;associated&nbsp;with&nbsp;this&nbsp;status&nbsp;message<br>
  1252. &nbsp;<br>
  1253. Returns:<br>
  1254. &nbsp;&nbsp;The&nbsp;geolocation&nbsp;string&nbsp;of&nbsp;this&nbsp;status&nbsp;message.</tt></dd></dl>
  1255. <dl><dt><a name="Status-GetNow"><strong>GetNow</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;wallclock&nbsp;time&nbsp;for&nbsp;this&nbsp;status&nbsp;message.<br>
  1256. &nbsp;<br>
  1257. Used&nbsp;to&nbsp;calculate&nbsp;relative_created_at.&nbsp;&nbsp;Defaults&nbsp;to&nbsp;the&nbsp;time<br>
  1258. the&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;was&nbsp;instantiated.<br>
  1259. &nbsp;<br>
  1260. Returns:<br>
  1261. &nbsp;&nbsp;Whatever&nbsp;the&nbsp;status&nbsp;instance&nbsp;believes&nbsp;the&nbsp;current&nbsp;time&nbsp;to&nbsp;be,<br>
  1262. &nbsp;&nbsp;in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.</tt></dd></dl>
  1263. <dl><dt><a name="Status-GetRelativeCreatedAt"><strong>GetRelativeCreatedAt</strong></a>(self)</dt><dd><tt>Get&nbsp;a&nbsp;human&nbsp;redable&nbsp;string&nbsp;representing&nbsp;the&nbsp;posting&nbsp;time<br>
  1264. &nbsp;<br>
  1265. Returns:<br>
  1266. &nbsp;&nbsp;A&nbsp;human&nbsp;readable&nbsp;string&nbsp;representing&nbsp;the&nbsp;posting&nbsp;time</tt></dd></dl>
  1267. <dl><dt><a name="Status-GetSource"><strong>GetSource</strong></a>(self)</dt></dl>
  1268. <dl><dt><a name="Status-GetText"><strong>GetText</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;text&nbsp;of&nbsp;this&nbsp;status&nbsp;message.<br>
  1269. &nbsp;<br>
  1270. Returns:<br>
  1271. &nbsp;&nbsp;The&nbsp;text&nbsp;of&nbsp;this&nbsp;status&nbsp;message.</tt></dd></dl>
  1272. <dl><dt><a name="Status-GetTruncated"><strong>GetTruncated</strong></a>(self)</dt></dl>
  1273. <dl><dt><a name="Status-GetUser"><strong>GetUser</strong></a>(self)</dt><dd><tt>Get&nbsp;a&nbsp;twitter.<a href="#User">User</a>&nbsp;reprenting&nbsp;the&nbsp;entity&nbsp;posting&nbsp;this&nbsp;status&nbsp;message.<br>
  1274. &nbsp;<br>
  1275. Returns:<br>
  1276. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;reprenting&nbsp;the&nbsp;entity&nbsp;posting&nbsp;this&nbsp;status&nbsp;message</tt></dd></dl>
  1277. <dl><dt><a name="Status-SetCreatedAt"><strong>SetCreatedAt</strong></a>(self, created_at)</dt><dd><tt>Set&nbsp;the&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;posted.<br>
  1278. &nbsp;<br>
  1279. Args:<br>
  1280. &nbsp;&nbsp;created_at:<br>
  1281. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;created</tt></dd></dl>
  1282. <dl><dt><a name="Status-SetFavorited"><strong>SetFavorited</strong></a>(self, favorited)</dt><dd><tt>Set&nbsp;the&nbsp;favorited&nbsp;state&nbsp;of&nbsp;this&nbsp;status&nbsp;message.<br>
  1283. &nbsp;<br>
  1284. Args:<br>
  1285. &nbsp;&nbsp;favorited:<br>
  1286. &nbsp;&nbsp;&nbsp;&nbsp;boolean&nbsp;True/False&nbsp;favorited&nbsp;state&nbsp;of&nbsp;this&nbsp;status&nbsp;message</tt></dd></dl>
  1287. <dl><dt><a name="Status-SetId"><strong>SetId</strong></a>(self, id)</dt><dd><tt>Set&nbsp;the&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;status&nbsp;message.<br>
  1288. &nbsp;<br>
  1289. Args:<br>
  1290. &nbsp;&nbsp;id:<br>
  1291. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;status&nbsp;message</tt></dd></dl>
  1292. <dl><dt><a name="Status-SetInReplyToScreenName"><strong>SetInReplyToScreenName</strong></a>(self, in_reply_to_screen_name)</dt></dl>
  1293. <dl><dt><a name="Status-SetInReplyToStatusId"><strong>SetInReplyToStatusId</strong></a>(self, in_reply_to_status_id)</dt></dl>
  1294. <dl><dt><a name="Status-SetInReplyToUserId"><strong>SetInReplyToUserId</strong></a>(self, in_reply_to_user_id)</dt></dl>
  1295. <dl><dt><a name="Status-SetLocation"><strong>SetLocation</strong></a>(self, location)</dt><dd><tt>Set&nbsp;the&nbsp;geolocation&nbsp;associated&nbsp;with&nbsp;this&nbsp;status&nbsp;message<br>
  1296. &nbsp;<br>
  1297. Args:<br>
  1298. &nbsp;&nbsp;location:<br>
  1299. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;geolocation&nbsp;string&nbsp;of&nbsp;this&nbsp;status&nbsp;message</tt></dd></dl>
  1300. <dl><dt><a name="Status-SetNow"><strong>SetNow</strong></a>(self, now)</dt><dd><tt>Set&nbsp;the&nbsp;wallclock&nbsp;time&nbsp;for&nbsp;this&nbsp;status&nbsp;message.<br>
  1301. &nbsp;<br>
  1302. Used&nbsp;to&nbsp;calculate&nbsp;relative_created_at.&nbsp;&nbsp;Defaults&nbsp;to&nbsp;the&nbsp;time<br>
  1303. the&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;was&nbsp;instantiated.<br>
  1304. &nbsp;<br>
  1305. Args:<br>
  1306. &nbsp;&nbsp;now:<br>
  1307. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;wallclock&nbsp;time&nbsp;for&nbsp;this&nbsp;instance.</tt></dd></dl>
  1308. <dl><dt><a name="Status-SetSource"><strong>SetSource</strong></a>(self, source)</dt></dl>
  1309. <dl><dt><a name="Status-SetText"><strong>SetText</strong></a>(self, text)</dt><dd><tt>Set&nbsp;the&nbsp;text&nbsp;of&nbsp;this&nbsp;status&nbsp;message.<br>
  1310. &nbsp;<br>
  1311. Args:<br>
  1312. &nbsp;&nbsp;text:<br>
  1313. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;text&nbsp;of&nbsp;this&nbsp;status&nbsp;message</tt></dd></dl>
  1314. <dl><dt><a name="Status-SetTruncated"><strong>SetTruncated</strong></a>(self, truncated)</dt></dl>
  1315. <dl><dt><a name="Status-SetUser"><strong>SetUser</strong></a>(self, user)</dt><dd><tt>Set&nbsp;a&nbsp;twitter.<a href="#User">User</a>&nbsp;reprenting&nbsp;the&nbsp;entity&nbsp;posting&nbsp;this&nbsp;status&nbsp;message.<br>
  1316. &nbsp;<br>
  1317. Args:<br>
  1318. &nbsp;&nbsp;user:<br>
  1319. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;reprenting&nbsp;the&nbsp;entity&nbsp;posting&nbsp;this&nbsp;status&nbsp;message</tt></dd></dl>
  1320. <dl><dt><a name="Status-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl>
  1321. <dl><dt><a name="Status-__init__"><strong>__init__</strong></a>(self, created_at<font color="#909090">=None</font>, favorited<font color="#909090">=None</font>, id<font color="#909090">=None</font>, text<font color="#909090">=None</font>, location<font color="#909090">=None</font>, user<font color="#909090">=None</font>, in_reply_to_screen_name<font color="#909090">=None</font>, in_reply_to_user_id<font color="#909090">=None</font>, in_reply_to_status_id<font color="#909090">=None</font>, truncated<font color="#909090">=None</font>, source<font color="#909090">=None</font>, now<font color="#909090">=None</font>, urls<font color="#909090">=None</font>, user_mentions<font color="#909090">=None</font>, hashtags<font color="#909090">=None</font>)</dt><dd><tt>An&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;to&nbsp;hold&nbsp;a&nbsp;Twitter&nbsp;status&nbsp;message.<br>
  1322. &nbsp;<br>
  1323. This&nbsp;class&nbsp;is&nbsp;normally&nbsp;instantiated&nbsp;by&nbsp;the&nbsp;twitter.<a href="#Api">Api</a>&nbsp;class&nbsp;and<br>
  1324. returned&nbsp;in&nbsp;a&nbsp;sequence.<br>
  1325. &nbsp;<br>
  1326. Note:&nbsp;Dates&nbsp;are&nbsp;posted&nbsp;in&nbsp;the&nbsp;form&nbsp;"Sat&nbsp;Jan&nbsp;27&nbsp;04:17:38&nbsp;+0000&nbsp;2007"<br>
  1327. &nbsp;<br>
  1328. Args:<br>
  1329. &nbsp;&nbsp;created_at:<br>
  1330. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;posted.&nbsp;[Optiona]<br>
  1331. &nbsp;&nbsp;favorited:<br>
  1332. &nbsp;&nbsp;&nbsp;&nbsp;Whether&nbsp;this&nbsp;is&nbsp;a&nbsp;favorite&nbsp;of&nbsp;the&nbsp;authenticated&nbsp;user.&nbsp;[Optiona]<br>
  1333. &nbsp;&nbsp;id:<br>
  1334. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;status&nbsp;message.&nbsp;[Optiona]<br>
  1335. &nbsp;&nbsp;text:<br>
  1336. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;text&nbsp;of&nbsp;this&nbsp;status&nbsp;message.&nbsp;[Optiona]<br>
  1337. &nbsp;&nbsp;location:<br>
  1338. &nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;geolocation&nbsp;string&nbsp;associated&nbsp;with&nbsp;this&nbsp;message.&nbsp;[Optiona]<br>
  1339. &nbsp;&nbsp;relative_created_at:<br>
  1340. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;human&nbsp;readable&nbsp;string&nbsp;representing&nbsp;the&nbsp;posting&nbsp;time.&nbsp;[Optiona]<br>
  1341. &nbsp;&nbsp;user:<br>
  1342. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;person&nbsp;posting&nbsp;the<br>
  1343. &nbsp;&nbsp;&nbsp;&nbsp;message.&nbsp;[Optiona]<br>
  1344. &nbsp;&nbsp;now:<br>
  1345. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;current&nbsp;time,&nbsp;if&nbsp;the&nbsp;client&nbsp;choses&nbsp;to&nbsp;set&nbsp;it.<br>
  1346. &nbsp;&nbsp;&nbsp;&nbsp;Defaults&nbsp;to&nbsp;the&nbsp;wall&nbsp;clock&nbsp;time.&nbsp;[Optiona]</tt></dd></dl>
  1347. <dl><dt><a name="Status-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl>
  1348. <dl><dt><a name="Status-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>A&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance.<br>
  1349. &nbsp;<br>
  1350. The&nbsp;return&nbsp;value&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;the&nbsp;JSON&nbsp;string&nbsp;representation.<br>
  1351. &nbsp;<br>
  1352. Returns:<br>
  1353. &nbsp;&nbsp;A&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance.</tt></dd></dl>
  1354. <hr>
  1355. Static methods defined here:<br>
  1356. <dl><dt><a name="Status-NewFromJsonDict"><strong>NewFromJsonDict</strong></a>(data)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;instance&nbsp;based&nbsp;on&nbsp;a&nbsp;JSON&nbsp;dict.<br>
  1357. &nbsp;<br>
  1358. Args:<br>
  1359. &nbsp;&nbsp;data:&nbsp;A&nbsp;JSON&nbsp;dict,&nbsp;as&nbsp;converted&nbsp;from&nbsp;the&nbsp;JSON&nbsp;in&nbsp;the&nbsp;twitter&nbsp;API<br>
  1360. Returns:<br>
  1361. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance</tt></dd></dl>
  1362. <hr>
  1363. Data descriptors defined here:<br>
  1364. <dl><dt><strong>__dict__</strong></dt>
  1365. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  1366. </dl>
  1367. <dl><dt><strong>__weakref__</strong></dt>
  1368. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  1369. </dl>
  1370. <dl><dt><strong>created_at</strong></dt>
  1371. <dd><tt>The&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;posted.</tt></dd>
  1372. </dl>
  1373. <dl><dt><strong>created_at_in_seconds</strong></dt>
  1374. <dd><tt>The&nbsp;time&nbsp;this&nbsp;status&nbsp;message&nbsp;was&nbsp;posted,&nbsp;in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch</tt></dd>
  1375. </dl>
  1376. <dl><dt><strong>favorited</strong></dt>
  1377. <dd><tt>The&nbsp;favorited&nbsp;state&nbsp;of&nbsp;this&nbsp;status&nbsp;message.</tt></dd>
  1378. </dl>
  1379. <dl><dt><strong>id</strong></dt>
  1380. <dd><tt>The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;status&nbsp;message.</tt></dd>
  1381. </dl>
  1382. <dl><dt><strong>in_reply_to_screen_name</strong></dt>
  1383. <dd><tt></tt></dd>
  1384. </dl>
  1385. <dl><dt><strong>in_reply_to_status_id</strong></dt>
  1386. <dd><tt></tt></dd>
  1387. </dl>
  1388. <dl><dt><strong>in_reply_to_user_id</strong></dt>
  1389. <dd><tt></tt></dd>
  1390. </dl>
  1391. <dl><dt><strong>location</strong></dt>
  1392. <dd><tt>The&nbsp;geolocation&nbsp;string&nbsp;of&nbsp;this&nbsp;status&nbsp;message</tt></dd>
  1393. </dl>
  1394. <dl><dt><strong>now</strong></dt>
  1395. <dd><tt>The&nbsp;wallclock&nbsp;time&nbsp;for&nbsp;this&nbsp;status&nbsp;instance.</tt></dd>
  1396. </dl>
  1397. <dl><dt><strong>relative_created_at</strong></dt>
  1398. <dd><tt>Get&nbsp;a&nbsp;human&nbsp;readable&nbsp;string&nbsp;representing&nbsp;the&nbsp;posting&nbsp;time</tt></dd>
  1399. </dl>
  1400. <dl><dt><strong>source</strong></dt>
  1401. <dd><tt></tt></dd>
  1402. </dl>
  1403. <dl><dt><strong>text</strong></dt>
  1404. <dd><tt>The&nbsp;text&nbsp;of&nbsp;this&nbsp;status&nbsp;message</tt></dd>
  1405. </dl>
  1406. <dl><dt><strong>truncated</strong></dt>
  1407. <dd><tt></tt></dd>
  1408. </dl>
  1409. <dl><dt><strong>user</strong></dt>
  1410. <dd><tt>A&nbsp;twitter.User&nbsp;reprenting&nbsp;the&nbsp;entity&nbsp;posting&nbsp;this&nbsp;status&nbsp;message</tt></dd>
  1411. </dl>
  1412. </td></tr></table> <p>
  1413. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1414. <tr bgcolor="#ffc8d8">
  1415. <td colspan=3 valign=bottom>&nbsp;<br>
  1416. <font color="#000000" face="helvetica, arial"><a name="Trend">class <strong>Trend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  1417. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  1418. <td colspan=2><tt>A&nbsp;class&nbsp;representing&nbsp;a&nbsp;trending&nbsp;topic<br>&nbsp;</tt></td></tr>
  1419. <tr><td>&nbsp;</td>
  1420. <td width="100%">Methods defined here:<br>
  1421. <dl><dt><a name="Trend-__init__"><strong>__init__</strong></a>(self, name<font color="#909090">=None</font>, query<font color="#909090">=None</font>, timestamp<font color="#909090">=None</font>)</dt></dl>
  1422. <dl><dt><a name="Trend-__str__"><strong>__str__</strong></a>(self)</dt></dl>
  1423. <hr>
  1424. Static methods defined here:<br>
  1425. <dl><dt><a name="Trend-NewFromJsonDict"><strong>NewFromJsonDict</strong></a>(data, timestamp<font color="#909090">=None</font>)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;instance&nbsp;based&nbsp;on&nbsp;a&nbsp;JSON&nbsp;dict<br>
  1426. &nbsp;<br>
  1427. Args:<br>
  1428. &nbsp;&nbsp;data:<br>
  1429. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;JSON&nbsp;dict<br>
  1430. &nbsp;&nbsp;timestamp:<br>
  1431. &nbsp;&nbsp;&nbsp;&nbsp;Gets&nbsp;set&nbsp;as&nbsp;the&nbsp;timestamp&nbsp;property&nbsp;of&nbsp;the&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a><br>
  1432. &nbsp;<br>
  1433. Returns:<br>
  1434. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Trend">Trend</a>&nbsp;<a href="__builtin__.html#object">object</a></tt></dd></dl>
  1435. <hr>
  1436. Data descriptors defined here:<br>
  1437. <dl><dt><strong>__dict__</strong></dt>
  1438. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  1439. </dl>
  1440. <dl><dt><strong>__weakref__</strong></dt>
  1441. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  1442. </dl>
  1443. </td></tr></table> <p>
  1444. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1445. <tr bgcolor="#ffc8d8">
  1446. <td colspan=3 valign=bottom>&nbsp;<br>
  1447. <font color="#000000" face="helvetica, arial"><a name="TwitterError">class <strong>TwitterError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
  1448. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  1449. <td colspan=2><tt>Base&nbsp;class&nbsp;for&nbsp;Twitter&nbsp;errors<br>&nbsp;</tt></td></tr>
  1450. <tr><td>&nbsp;</td>
  1451. <td width="100%"><dl><dt>Method resolution order:</dt>
  1452. <dd><a href="twitter.html#TwitterError">TwitterError</a></dd>
  1453. <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  1454. <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  1455. <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  1456. </dl>
  1457. <hr>
  1458. Data descriptors defined here:<br>
  1459. <dl><dt><strong>__weakref__</strong></dt>
  1460. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  1461. </dl>
  1462. <dl><dt><strong>message</strong></dt>
  1463. <dd><tt>Returns&nbsp;the&nbsp;first&nbsp;argument&nbsp;used&nbsp;to&nbsp;construct&nbsp;this&nbsp;error.</tt></dd>
  1464. </dl>
  1465. <hr>
  1466. Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  1467. <dl><dt><a name="TwitterError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#TwitterError-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
  1468. <hr>
  1469. Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  1470. <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object at 0x100119f80&gt;<dd><tt>T.<a href="#TwitterError-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  1471. <hr>
  1472. Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  1473. <dl><dt><a name="TwitterError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TwitterError-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  1474. <dl><dt><a name="TwitterError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#TwitterError-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  1475. <dl><dt><a name="TwitterError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#TwitterError-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  1476. <dl><dt><a name="TwitterError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#TwitterError-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  1477. &nbsp;<br>
  1478. Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  1479. <dl><dt><a name="TwitterError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  1480. <dl><dt><a name="TwitterError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#TwitterError-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  1481. <dl><dt><a name="TwitterError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TwitterError-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  1482. <dl><dt><a name="TwitterError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  1483. <dl><dt><a name="TwitterError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#TwitterError-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
  1484. <dl><dt><a name="TwitterError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
  1485. <hr>
  1486. Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  1487. <dl><dt><strong>__dict__</strong></dt>
  1488. </dl>
  1489. <dl><dt><strong>args</strong></dt>
  1490. </dl>
  1491. </td></tr></table> <p>
  1492. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1493. <tr bgcolor="#ffc8d8">
  1494. <td colspan=3 valign=bottom>&nbsp;<br>
  1495. <font color="#000000" face="helvetica, arial"><a name="Url">class <strong>Url</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  1496. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  1497. <td colspan=2><tt>A&nbsp;class&nbsp;representing&nbsp;an&nbsp;URL&nbsp;contained&nbsp;in&nbsp;a&nbsp;tweet<br>&nbsp;</tt></td></tr>
  1498. <tr><td>&nbsp;</td>
  1499. <td width="100%">Methods defined here:<br>
  1500. <dl><dt><a name="Url-__init__"><strong>__init__</strong></a>(self, url<font color="#909090">=None</font>, expanded_url<font color="#909090">=None</font>)</dt></dl>
  1501. <hr>
  1502. Static methods defined here:<br>
  1503. <dl><dt><a name="Url-NewFromJsonDict"><strong>NewFromJsonDict</strong></a>(data)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;instance&nbsp;based&nbsp;on&nbsp;a&nbsp;JSON&nbsp;dict.<br>
  1504. &nbsp;<br>
  1505. Args:<br>
  1506. &nbsp;&nbsp;data:<br>
  1507. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;JSON&nbsp;dict,&nbsp;as&nbsp;converted&nbsp;from&nbsp;the&nbsp;JSON&nbsp;in&nbsp;the&nbsp;twitter&nbsp;API<br>
  1508. &nbsp;<br>
  1509. Returns:<br>
  1510. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Url">Url</a>&nbsp;instance</tt></dd></dl>
  1511. <hr>
  1512. Data descriptors defined here:<br>
  1513. <dl><dt><strong>__dict__</strong></dt>
  1514. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  1515. </dl>
  1516. <dl><dt><strong>__weakref__</strong></dt>
  1517. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  1518. </dl>
  1519. </td></tr></table> <p>
  1520. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1521. <tr bgcolor="#ffc8d8">
  1522. <td colspan=3 valign=bottom>&nbsp;<br>
  1523. <font color="#000000" face="helvetica, arial"><a name="User">class <strong>User</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  1524. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  1525. <td colspan=2><tt>A&nbsp;class&nbsp;representing&nbsp;the&nbsp;<a href="#User">User</a>&nbsp;structure&nbsp;used&nbsp;by&nbsp;the&nbsp;twitter&nbsp;API.<br>
  1526. &nbsp;<br>
  1527. The&nbsp;<a href="#User">User</a>&nbsp;structure&nbsp;exposes&nbsp;the&nbsp;following&nbsp;properties:<br>
  1528. &nbsp;<br>
  1529. &nbsp;&nbsp;user.id<br>
  1530. &nbsp;&nbsp;user.name<br>
  1531. &nbsp;&nbsp;user.screen_name<br>
  1532. &nbsp;&nbsp;user.location<br>
  1533. &nbsp;&nbsp;user.description<br>
  1534. &nbsp;&nbsp;user.profile_image_url<br>
  1535. &nbsp;&nbsp;user.profile_background_tile<br>
  1536. &nbsp;&nbsp;user.profile_background_image_url<br>
  1537. &nbsp;&nbsp;user.profile_sidebar_fill_color<br>
  1538. &nbsp;&nbsp;user.profile_background_color<br>
  1539. &nbsp;&nbsp;user.profile_link_color<br>
  1540. &nbsp;&nbsp;user.profile_text_color<br>
  1541. &nbsp;&nbsp;user.protected<br>
  1542. &nbsp;&nbsp;user.utc_offset<br>
  1543. &nbsp;&nbsp;user.time_zone<br>
  1544. &nbsp;&nbsp;user.url<br>
  1545. &nbsp;&nbsp;user.status<br>
  1546. &nbsp;&nbsp;user.statuses_count<br>
  1547. &nbsp;&nbsp;user.followers_count<br>
  1548. &nbsp;&nbsp;user.friends_count<br>
  1549. &nbsp;&nbsp;user.favourites_count<br>&nbsp;</tt></td></tr>
  1550. <tr><td>&nbsp;</td>
  1551. <td width="100%">Methods defined here:<br>
  1552. <dl><dt><a name="User-AsDict"><strong>AsDict</strong></a>(self)</dt><dd><tt>A&nbsp;dict&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#User">User</a>&nbsp;instance.<br>
  1553. &nbsp;<br>
  1554. The&nbsp;return&nbsp;value&nbsp;uses&nbsp;the&nbsp;same&nbsp;key&nbsp;names&nbsp;as&nbsp;the&nbsp;JSON&nbsp;representation.<br>
  1555. &nbsp;<br>
  1556. Return:<br>
  1557. &nbsp;&nbsp;A&nbsp;dict&nbsp;representing&nbsp;this&nbsp;twitter.<a href="#User">User</a>&nbsp;instance</tt></dd></dl>
  1558. <dl><dt><a name="User-AsJsonString"><strong>AsJsonString</strong></a>(self)</dt><dd><tt>A&nbsp;JSON&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#User">User</a>&nbsp;instance.<br>
  1559. &nbsp;<br>
  1560. Returns:<br>
  1561. &nbsp;&nbsp;A&nbsp;JSON&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#User">User</a>&nbsp;instance</tt></dd></dl>
  1562. <dl><dt><a name="User-GetDescription"><strong>GetDescription</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;short&nbsp;text&nbsp;description&nbsp;of&nbsp;this&nbsp;user.<br>
  1563. &nbsp;<br>
  1564. Returns:<br>
  1565. &nbsp;&nbsp;The&nbsp;short&nbsp;text&nbsp;description&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1566. <dl><dt><a name="User-GetFavouritesCount"><strong>GetFavouritesCount</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;number&nbsp;of&nbsp;favourites&nbsp;for&nbsp;this&nbsp;user.<br>
  1567. &nbsp;<br>
  1568. Returns:<br>
  1569. &nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;favourites&nbsp;for&nbsp;this&nbsp;user.</tt></dd></dl>
  1570. <dl><dt><a name="User-GetFollowersCount"><strong>GetFollowersCount</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;follower&nbsp;count&nbsp;for&nbsp;this&nbsp;user.<br>
  1571. &nbsp;<br>
  1572. Returns:<br>
  1573. &nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;users&nbsp;following&nbsp;this&nbsp;user.</tt></dd></dl>
  1574. <dl><dt><a name="User-GetFriendsCount"><strong>GetFriendsCount</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;friend&nbsp;count&nbsp;for&nbsp;this&nbsp;user.<br>
  1575. &nbsp;<br>
  1576. Returns:<br>
  1577. &nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;users&nbsp;this&nbsp;user&nbsp;has&nbsp;befriended.</tt></dd></dl>
  1578. <dl><dt><a name="User-GetId"><strong>GetId</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;user.<br>
  1579. &nbsp;<br>
  1580. Returns:<br>
  1581. &nbsp;&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1582. <dl><dt><a name="User-GetLocation"><strong>GetLocation</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;geographic&nbsp;location&nbsp;of&nbsp;this&nbsp;user.<br>
  1583. &nbsp;<br>
  1584. Returns:<br>
  1585. &nbsp;&nbsp;The&nbsp;geographic&nbsp;location&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1586. <dl><dt><a name="User-GetName"><strong>GetName</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;user.<br>
  1587. &nbsp;<br>
  1588. Returns:<br>
  1589. &nbsp;&nbsp;The&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1590. <dl><dt><a name="User-GetProfileBackgroundColor"><strong>GetProfileBackgroundColor</strong></a>(self)</dt></dl>
  1591. <dl><dt><a name="User-GetProfileBackgroundImageUrl"><strong>GetProfileBackgroundImageUrl</strong></a>(self)</dt></dl>
  1592. <dl><dt><a name="User-GetProfileBackgroundTile"><strong>GetProfileBackgroundTile</strong></a>(self)</dt><dd><tt>Boolean&nbsp;for&nbsp;whether&nbsp;to&nbsp;tile&nbsp;the&nbsp;profile&nbsp;background&nbsp;image.<br>
  1593. &nbsp;<br>
  1594. Returns:<br>
  1595. &nbsp;&nbsp;True&nbsp;if&nbsp;the&nbsp;background&nbsp;is&nbsp;to&nbsp;be&nbsp;tiled,&nbsp;False&nbsp;if&nbsp;not,&nbsp;None&nbsp;if&nbsp;unset.</tt></dd></dl>
  1596. <dl><dt><a name="User-GetProfileImageUrl"><strong>GetProfileImageUrl</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;url&nbsp;of&nbsp;the&nbsp;thumbnail&nbsp;of&nbsp;this&nbsp;user.<br>
  1597. &nbsp;<br>
  1598. Returns:<br>
  1599. &nbsp;&nbsp;The&nbsp;url&nbsp;of&nbsp;the&nbsp;thumbnail&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1600. <dl><dt><a name="User-GetProfileLinkColor"><strong>GetProfileLinkColor</strong></a>(self)</dt></dl>
  1601. <dl><dt><a name="User-GetProfileSidebarFillColor"><strong>GetProfileSidebarFillColor</strong></a>(self)</dt></dl>
  1602. <dl><dt><a name="User-GetProfileTextColor"><strong>GetProfileTextColor</strong></a>(self)</dt></dl>
  1603. <dl><dt><a name="User-GetProtected"><strong>GetProtected</strong></a>(self)</dt></dl>
  1604. <dl><dt><a name="User-GetScreenName"><strong>GetScreenName</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;short&nbsp;twitter&nbsp;name&nbsp;of&nbsp;this&nbsp;user.<br>
  1605. &nbsp;<br>
  1606. Returns:<br>
  1607. &nbsp;&nbsp;The&nbsp;short&nbsp;twitter&nbsp;name&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1608. <dl><dt><a name="User-GetStatus"><strong>GetStatus</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;latest&nbsp;twitter.<a href="#Status">Status</a>&nbsp;of&nbsp;this&nbsp;user.<br>
  1609. &nbsp;<br>
  1610. Returns:<br>
  1611. &nbsp;&nbsp;The&nbsp;latest&nbsp;twitter.<a href="#Status">Status</a>&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1612. <dl><dt><a name="User-GetStatusesCount"><strong>GetStatusesCount</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;number&nbsp;of&nbsp;status&nbsp;updates&nbsp;for&nbsp;this&nbsp;user.<br>
  1613. &nbsp;<br>
  1614. Returns:<br>
  1615. &nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;status&nbsp;updates&nbsp;for&nbsp;this&nbsp;user.</tt></dd></dl>
  1616. <dl><dt><a name="User-GetTimeZone"><strong>GetTimeZone</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;current&nbsp;time&nbsp;zone&nbsp;string&nbsp;for&nbsp;the&nbsp;user.<br>
  1617. &nbsp;<br>
  1618. Returns:<br>
  1619. &nbsp;&nbsp;The&nbsp;descriptive&nbsp;time&nbsp;zone&nbsp;string&nbsp;for&nbsp;the&nbsp;user.</tt></dd></dl>
  1620. <dl><dt><a name="User-GetUrl"><strong>GetUrl</strong></a>(self)</dt><dd><tt>Get&nbsp;the&nbsp;homepage&nbsp;url&nbsp;of&nbsp;this&nbsp;user.<br>
  1621. &nbsp;<br>
  1622. Returns:<br>
  1623. &nbsp;&nbsp;The&nbsp;homepage&nbsp;url&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1624. <dl><dt><a name="User-GetUtcOffset"><strong>GetUtcOffset</strong></a>(self)</dt></dl>
  1625. <dl><dt><a name="User-SetDescription"><strong>SetDescription</strong></a>(self, description)</dt><dd><tt>Set&nbsp;the&nbsp;short&nbsp;text&nbsp;description&nbsp;of&nbsp;this&nbsp;user.<br>
  1626. &nbsp;<br>
  1627. Args:<br>
  1628. &nbsp;&nbsp;description:&nbsp;The&nbsp;short&nbsp;text&nbsp;description&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1629. <dl><dt><a name="User-SetFavouritesCount"><strong>SetFavouritesCount</strong></a>(self, count)</dt><dd><tt>Set&nbsp;the&nbsp;favourite&nbsp;count&nbsp;for&nbsp;this&nbsp;user.<br>
  1630. &nbsp;<br>
  1631. Args:<br>
  1632. &nbsp;&nbsp;count:<br>
  1633. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;favourites&nbsp;for&nbsp;this&nbsp;user.</tt></dd></dl>
  1634. <dl><dt><a name="User-SetFollowersCount"><strong>SetFollowersCount</strong></a>(self, count)</dt><dd><tt>Set&nbsp;the&nbsp;follower&nbsp;count&nbsp;for&nbsp;this&nbsp;user.<br>
  1635. &nbsp;<br>
  1636. Args:<br>
  1637. &nbsp;&nbsp;count:<br>
  1638. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;users&nbsp;following&nbsp;this&nbsp;user.</tt></dd></dl>
  1639. <dl><dt><a name="User-SetFriendsCount"><strong>SetFriendsCount</strong></a>(self, count)</dt><dd><tt>Set&nbsp;the&nbsp;friend&nbsp;count&nbsp;for&nbsp;this&nbsp;user.<br>
  1640. &nbsp;<br>
  1641. Args:<br>
  1642. &nbsp;&nbsp;count:<br>
  1643. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;users&nbsp;this&nbsp;user&nbsp;has&nbsp;befriended.</tt></dd></dl>
  1644. <dl><dt><a name="User-SetId"><strong>SetId</strong></a>(self, id)</dt><dd><tt>Set&nbsp;the&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;user.<br>
  1645. &nbsp;<br>
  1646. Args:<br>
  1647. &nbsp;&nbsp;id:&nbsp;The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;user.</tt></dd></dl>
  1648. <dl><dt><a name="User-SetLocation"><strong>SetLocation</strong></a>(self, location)</dt><dd><tt>Set&nbsp;the&nbsp;geographic&nbsp;location&nbsp;of&nbsp;this&nbsp;user.<br>
  1649. &nbsp;<br>
  1650. Args:<br>
  1651. &nbsp;&nbsp;location:&nbsp;The&nbsp;geographic&nbsp;location&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1652. <dl><dt><a name="User-SetName"><strong>SetName</strong></a>(self, name)</dt><dd><tt>Set&nbsp;the&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;user.<br>
  1653. &nbsp;<br>
  1654. Args:<br>
  1655. &nbsp;&nbsp;name:&nbsp;The&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1656. <dl><dt><a name="User-SetProfileBackgroundColor"><strong>SetProfileBackgroundColor</strong></a>(self, profile_background_color)</dt></dl>
  1657. <dl><dt><a name="User-SetProfileBackgroundImageUrl"><strong>SetProfileBackgroundImageUrl</strong></a>(self, profile_background_image_url)</dt></dl>
  1658. <dl><dt><a name="User-SetProfileBackgroundTile"><strong>SetProfileBackgroundTile</strong></a>(self, profile_background_tile)</dt><dd><tt>Set&nbsp;the&nbsp;boolean&nbsp;flag&nbsp;for&nbsp;whether&nbsp;to&nbsp;tile&nbsp;the&nbsp;profile&nbsp;background&nbsp;image.<br>
  1659. &nbsp;<br>
  1660. Args:<br>
  1661. &nbsp;&nbsp;profile_background_tile:&nbsp;Boolean&nbsp;flag&nbsp;for&nbsp;whether&nbsp;to&nbsp;tile&nbsp;or&nbsp;not.</tt></dd></dl>
  1662. <dl><dt><a name="User-SetProfileImageUrl"><strong>SetProfileImageUrl</strong></a>(self, profile_image_url)</dt><dd><tt>Set&nbsp;the&nbsp;url&nbsp;of&nbsp;the&nbsp;thumbnail&nbsp;of&nbsp;this&nbsp;user.<br>
  1663. &nbsp;<br>
  1664. Args:<br>
  1665. &nbsp;&nbsp;profile_image_url:&nbsp;The&nbsp;url&nbsp;of&nbsp;the&nbsp;thumbnail&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1666. <dl><dt><a name="User-SetProfileLinkColor"><strong>SetProfileLinkColor</strong></a>(self, profile_link_color)</dt></dl>
  1667. <dl><dt><a name="User-SetProfileSidebarFillColor"><strong>SetProfileSidebarFillColor</strong></a>(self, profile_sidebar_fill_color)</dt></dl>
  1668. <dl><dt><a name="User-SetProfileTextColor"><strong>SetProfileTextColor</strong></a>(self, profile_text_color)</dt></dl>
  1669. <dl><dt><a name="User-SetProtected"><strong>SetProtected</strong></a>(self, protected)</dt></dl>
  1670. <dl><dt><a name="User-SetScreenName"><strong>SetScreenName</strong></a>(self, screen_name)</dt><dd><tt>Set&nbsp;the&nbsp;short&nbsp;twitter&nbsp;name&nbsp;of&nbsp;this&nbsp;user.<br>
  1671. &nbsp;<br>
  1672. Args:<br>
  1673. &nbsp;&nbsp;screen_name:&nbsp;the&nbsp;short&nbsp;twitter&nbsp;name&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1674. <dl><dt><a name="User-SetStatus"><strong>SetStatus</strong></a>(self, status)</dt><dd><tt>Set&nbsp;the&nbsp;latest&nbsp;twitter.<a href="#Status">Status</a>&nbsp;of&nbsp;this&nbsp;user.<br>
  1675. &nbsp;<br>
  1676. Args:<br>
  1677. &nbsp;&nbsp;status:<br>
  1678. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;latest&nbsp;twitter.<a href="#Status">Status</a>&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1679. <dl><dt><a name="User-SetStatusesCount"><strong>SetStatusesCount</strong></a>(self, count)</dt><dd><tt>Set&nbsp;the&nbsp;status&nbsp;update&nbsp;count&nbsp;for&nbsp;this&nbsp;user.<br>
  1680. &nbsp;<br>
  1681. Args:<br>
  1682. &nbsp;&nbsp;count:<br>
  1683. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;updates&nbsp;for&nbsp;this&nbsp;user.</tt></dd></dl>
  1684. <dl><dt><a name="User-SetTimeZone"><strong>SetTimeZone</strong></a>(self, time_zone)</dt><dd><tt>Sets&nbsp;the&nbsp;user's&nbsp;time&nbsp;zone&nbsp;string.<br>
  1685. &nbsp;<br>
  1686. Args:<br>
  1687. &nbsp;&nbsp;time_zone:<br>
  1688. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;descriptive&nbsp;time&nbsp;zone&nbsp;to&nbsp;assign&nbsp;for&nbsp;the&nbsp;user.</tt></dd></dl>
  1689. <dl><dt><a name="User-SetUrl"><strong>SetUrl</strong></a>(self, url)</dt><dd><tt>Set&nbsp;the&nbsp;homepage&nbsp;url&nbsp;of&nbsp;this&nbsp;user.<br>
  1690. &nbsp;<br>
  1691. Args:<br>
  1692. &nbsp;&nbsp;url:&nbsp;The&nbsp;homepage&nbsp;url&nbsp;of&nbsp;this&nbsp;user</tt></dd></dl>
  1693. <dl><dt><a name="User-SetUtcOffset"><strong>SetUtcOffset</strong></a>(self, utc_offset)</dt></dl>
  1694. <dl><dt><a name="User-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl>
  1695. <dl><dt><a name="User-__init__"><strong>__init__</strong></a>(self, id<font color="#909090">=None</font>, name<font color="#909090">=None</font>, screen_name<font color="#909090">=None</font>, location<font color="#909090">=None</font>, description<font color="#909090">=None</font>, profile_image_url<font color="#909090">=None</font>, profile_background_tile<font color="#909090">=None</font>, profile_background_image_url<font color="#909090">=None</font>, profile_sidebar_fill_color<font color="#909090">=None</font>, profile_background_color<font color="#909090">=None</font>, profile_link_color<font color="#909090">=None</font>, profile_text_color<font color="#909090">=None</font>, protected<font color="#909090">=None</font>, utc_offset<font color="#909090">=None</font>, time_zone<font color="#909090">=None</font>, followers_count<font color="#909090">=None</font>, friends_count<font color="#909090">=None</font>, statuses_count<font color="#909090">=None</font>, favourites_count<font color="#909090">=None</font>, url<font color="#909090">=None</font>, status<font color="#909090">=None</font>)</dt></dl>
  1696. <dl><dt><a name="User-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl>
  1697. <dl><dt><a name="User-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>A&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#User">User</a>&nbsp;instance.<br>
  1698. &nbsp;<br>
  1699. The&nbsp;return&nbsp;value&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;the&nbsp;JSON&nbsp;string&nbsp;representation.<br>
  1700. &nbsp;<br>
  1701. Returns:<br>
  1702. &nbsp;&nbsp;A&nbsp;string&nbsp;representation&nbsp;of&nbsp;this&nbsp;twitter.<a href="#User">User</a>&nbsp;instance.</tt></dd></dl>
  1703. <hr>
  1704. Static methods defined here:<br>
  1705. <dl><dt><a name="User-NewFromJsonDict"><strong>NewFromJsonDict</strong></a>(data)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;instance&nbsp;based&nbsp;on&nbsp;a&nbsp;JSON&nbsp;dict.<br>
  1706. &nbsp;<br>
  1707. Args:<br>
  1708. &nbsp;&nbsp;data:<br>
  1709. &nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;JSON&nbsp;dict,&nbsp;as&nbsp;converted&nbsp;from&nbsp;the&nbsp;JSON&nbsp;in&nbsp;the&nbsp;twitter&nbsp;API<br>
  1710. &nbsp;<br>
  1711. Returns:<br>
  1712. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance</tt></dd></dl>
  1713. <hr>
  1714. Data descriptors defined here:<br>
  1715. <dl><dt><strong>__dict__</strong></dt>
  1716. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  1717. </dl>
  1718. <dl><dt><strong>__weakref__</strong></dt>
  1719. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  1720. </dl>
  1721. <dl><dt><strong>description</strong></dt>
  1722. <dd><tt>The&nbsp;short&nbsp;text&nbsp;description&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1723. </dl>
  1724. <dl><dt><strong>favourites_count</strong></dt>
  1725. <dd><tt>The&nbsp;number&nbsp;of&nbsp;favourites&nbsp;for&nbsp;this&nbsp;user.</tt></dd>
  1726. </dl>
  1727. <dl><dt><strong>followers_count</strong></dt>
  1728. <dd><tt>The&nbsp;number&nbsp;of&nbsp;users&nbsp;following&nbsp;this&nbsp;user.</tt></dd>
  1729. </dl>
  1730. <dl><dt><strong>friends_count</strong></dt>
  1731. <dd><tt>The&nbsp;number&nbsp;of&nbsp;friends&nbsp;for&nbsp;this&nbsp;user.</tt></dd>
  1732. </dl>
  1733. <dl><dt><strong>id</strong></dt>
  1734. <dd><tt>The&nbsp;unique&nbsp;id&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1735. </dl>
  1736. <dl><dt><strong>location</strong></dt>
  1737. <dd><tt>The&nbsp;geographic&nbsp;location&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1738. </dl>
  1739. <dl><dt><strong>name</strong></dt>
  1740. <dd><tt>The&nbsp;real&nbsp;name&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1741. </dl>
  1742. <dl><dt><strong>profile_background_color</strong></dt>
  1743. </dl>
  1744. <dl><dt><strong>profile_background_image_url</strong></dt>
  1745. <dd><tt>The&nbsp;url&nbsp;of&nbsp;the&nbsp;profile&nbsp;background&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1746. </dl>
  1747. <dl><dt><strong>profile_background_tile</strong></dt>
  1748. <dd><tt>Boolean&nbsp;for&nbsp;whether&nbsp;to&nbsp;tile&nbsp;the&nbsp;background&nbsp;image.</tt></dd>
  1749. </dl>
  1750. <dl><dt><strong>profile_image_url</strong></dt>
  1751. <dd><tt>The&nbsp;url&nbsp;of&nbsp;the&nbsp;thumbnail&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1752. </dl>
  1753. <dl><dt><strong>profile_link_color</strong></dt>
  1754. </dl>
  1755. <dl><dt><strong>profile_sidebar_fill_color</strong></dt>
  1756. </dl>
  1757. <dl><dt><strong>profile_text_color</strong></dt>
  1758. </dl>
  1759. <dl><dt><strong>protected</strong></dt>
  1760. </dl>
  1761. <dl><dt><strong>screen_name</strong></dt>
  1762. <dd><tt>The&nbsp;short&nbsp;twitter&nbsp;name&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1763. </dl>
  1764. <dl><dt><strong>status</strong></dt>
  1765. <dd><tt>The&nbsp;latest&nbsp;twitter.Status&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1766. </dl>
  1767. <dl><dt><strong>statuses_count</strong></dt>
  1768. <dd><tt>The&nbsp;number&nbsp;of&nbsp;updates&nbsp;for&nbsp;this&nbsp;user.</tt></dd>
  1769. </dl>
  1770. <dl><dt><strong>time_zone</strong></dt>
  1771. <dd><tt>Returns&nbsp;the&nbsp;current&nbsp;time&nbsp;zone&nbsp;string&nbsp;for&nbsp;the&nbsp;user.<br>
  1772. &nbsp;<br>
  1773. Returns:<br>
  1774. &nbsp;&nbsp;The&nbsp;descriptive&nbsp;time&nbsp;zone&nbsp;string&nbsp;for&nbsp;the&nbsp;user.</tt></dd>
  1775. </dl>
  1776. <dl><dt><strong>url</strong></dt>
  1777. <dd><tt>The&nbsp;homepage&nbsp;url&nbsp;of&nbsp;this&nbsp;user.</tt></dd>
  1778. </dl>
  1779. <dl><dt><strong>utc_offset</strong></dt>
  1780. </dl>
  1781. </td></tr></table></td></tr></table><p>
  1782. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1783. <tr bgcolor="#eeaa77">
  1784. <td colspan=3 valign=bottom>&nbsp;<br>
  1785. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
  1786. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  1787. <td width="100%"><dl><dt><a name="-md5"><strong>md5</strong></a> = openssl_md5(...)</dt><dd><tt>Returns&nbsp;a&nbsp;md5&nbsp;hash&nbsp;<a href="__builtin__.html#object">object</a>;&nbsp;optionally&nbsp;initialized&nbsp;with&nbsp;a&nbsp;string</tt></dd></dl>
  1788. </td></tr></table><p>
  1789. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1790. <tr bgcolor="#55aa55">
  1791. <td colspan=3 valign=bottom>&nbsp;<br>
  1792. <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
  1793. <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  1794. <td width="100%"><strong>ACCESS_TOKEN_URL</strong> = 'https://api.twitter.com/oauth/access_token'<br>
  1795. <strong>AUTHORIZATION_URL</strong> = 'https://api.twitter.com/oauth/authorize'<br>
  1796. <strong>CHARACTER_LIMIT</strong> = 140<br>
  1797. <strong>DEFAULT_CACHE</strong> = &lt;object object at 0x1001da0a0&gt;<br>
  1798. <strong>REQUEST_TOKEN_URL</strong> = 'https://api.twitter.com/oauth/request_token'<br>
  1799. <strong>SIGNIN_URL</strong> = 'https://api.twitter.com/oauth/authenticate'<br>
  1800. <strong>__author__</strong> = 'python-twitter@googlegroups.com'<br>
  1801. <strong>__version__</strong> = '0.8'</td></tr></table><p>
  1802. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  1803. <tr bgcolor="#7799ee">
  1804. <td colspan=3 valign=bottom>&nbsp;<br>
  1805. <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
  1806. <tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  1807. <td width="100%">python-twitter@googlegroups.com</td></tr></table>
  1808. </body></html>