forked from bear/python-twitter
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtwitter.html
More file actions
1999 lines (1782 loc) · 127 KB
/
twitter.html
File metadata and controls
1999 lines (1782 loc) · 127 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module twitter</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>twitter</strong></big></big> (version 0.8)</font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="twitter.py">twitter.py</a></font></td></tr></table>
<p><tt>A library that provides a Python interface to the Twitter API</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="StringIO.html">StringIO</a><br>
<a href="base64.html">base64</a><br>
<a href="calendar.html">calendar</a><br>
<a href="datetime.html">datetime</a><br>
<a href="gzip.html">gzip</a><br>
</td><td width="25%" valign=top><a href="httplib.html">httplib</a><br>
<a href="oauth2.html">oauth2</a><br>
<a href="os.html">os</a><br>
<a href="rfc822.html">rfc822</a><br>
<a href="json.html">json</a><br>
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
<a href="tempfile.html">tempfile</a><br>
<a href="textwrap.html">textwrap</a><br>
<a href="time.html">time</a><br>
<a href="urllib.html">urllib</a><br>
</td><td width="25%" valign=top><a href="urllib2.html">urllib2</a><br>
<a href="urlparse.html">urlparse</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="twitter.html#Api">Api</a>
</font></dt><dt><font face="helvetica, arial"><a href="twitter.html#DirectMessage">DirectMessage</a>
</font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Hashtag">Hashtag</a>
</font></dt><dt><font face="helvetica, arial"><a href="twitter.html#List">List</a>
</font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Status">Status</a>
</font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Trend">Trend</a>
</font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Url">Url</a>
</font></dt><dt><font face="helvetica, arial"><a href="twitter.html#User">User</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="twitter.html#TwitterError">TwitterError</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<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>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A python interface into the Twitter API<br>
<br>
By default, the <a href="#Api">Api</a> caches results for 1 minute.<br>
<br>
Example usage:<br>
<br>
To create an instance of the twitter.<a href="#Api">Api</a> class, with no authentication:<br>
<br>
>>> import twitter<br>
>>> api = twitter.<a href="#Api">Api</a>()<br>
<br>
To fetch a single user's public status messages, where "user" is either<br>
a Twitter "short name" or their user id.<br>
<br>
>>> statuses = api.<a href="#Api-GetUserTimeline">GetUserTimeline</a>(user)<br>
>>> print [s.text for s in statuses]<br>
<br>
To use authentication, instantiate the twitter.<a href="#Api">Api</a> class with a<br>
consumer key and secret; and the oAuth key and secret:<br>
<br>
>>> api = twitter.<a href="#Api">Api</a>(consumer_key='twitter consumer key',<br>
consumer_secret='twitter consumer secret',<br>
access_token_key='the_key_given',<br>
access_token_secret='the_key_secret')<br>
<br>
To fetch your friends (after being authenticated):<br>
<br>
>>> users = api.<a href="#Api-GetFriends">GetFriends</a>()<br>
>>> print [u.name for u in users]<br>
<br>
To post a twitter status message (after being authenticated):<br>
<br>
>>> status = api.<a href="#Api-PostUpdate">PostUpdate</a>('I love python-twitter!')<br>
>>> print status.text<br>
I love python-twitter!<br>
<br>
There are many other methods, including:<br>
<br>
>>> api.<a href="#Api-PostUpdates">PostUpdates</a>(status)<br>
>>> api.<a href="#Api-PostDirectMessage">PostDirectMessage</a>(user, text)<br>
>>> api.<a href="#Api-GetUser">GetUser</a>(user)<br>
>>> api.<a href="#Api-GetReplies">GetReplies</a>()<br>
>>> api.<a href="#Api-GetUserTimeline">GetUserTimeline</a>(user)<br>
>>> api.<a href="#Api-GetStatus">GetStatus</a>(id)<br>
>>> api.<a href="#Api-DestroyStatus">DestroyStatus</a>(id)<br>
>>> api.<a href="#Api-GetFriendsTimeline">GetFriendsTimeline</a>(user)<br>
>>> api.<a href="#Api-GetFriends">GetFriends</a>(user)<br>
>>> api.<a href="#Api-GetFollowers">GetFollowers</a>()<br>
>>> api.<a href="#Api-GetFeatured">GetFeatured</a>()<br>
>>> api.<a href="#Api-GetDirectMessages">GetDirectMessages</a>()<br>
>>> api.<a href="#Api-PostDirectMessage">PostDirectMessage</a>(user, text)<br>
>>> api.<a href="#Api-DestroyDirectMessage">DestroyDirectMessage</a>(id)<br>
>>> api.<a href="#Api-DestroyFriendship">DestroyFriendship</a>(user)<br>
>>> api.<a href="#Api-CreateFriendship">CreateFriendship</a>(user)<br>
>>> api.<a href="#Api-GetUserByEmail">GetUserByEmail</a>(email)<br>
>>> api.<a href="#Api-VerifyCredentials">VerifyCredentials</a>()<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Api-ClearCredentials"><strong>ClearCredentials</strong></a>(self)</dt><dd><tt>Clear the any credentials for this instance</tt></dd></dl>
<dl><dt><a name="Api-CreateFavorite"><strong>CreateFavorite</strong></a>(self, status)</dt><dd><tt>Favorites the status specified in the status parameter as the authenticating user.<br>
Returns the favorite status when successful.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
The twitter.<a href="#Status">Status</a> instance to mark as a favorite.<br>
Returns:<br>
A twitter.<a href="#Status">Status</a> instance representing the newly-marked favorite.</tt></dd></dl>
<dl><dt><a name="Api-CreateFriendship"><strong>CreateFriendship</strong></a>(self, user)</dt><dd><tt>Befriends the user specified in the user parameter as the authenticating user.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
The ID or screen name of the user to befriend.<br>
Returns:<br>
A twitter.<a href="#User">User</a> instance representing the befriended user.</tt></dd></dl>
<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 a new list with the give name<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
user:<br>
Twitter name to create the list for<br>
name:<br>
New name for the list<br>
mode:<br>
'public' or 'private'.<br>
Defaults to 'public'. [Optional]<br>
description:<br>
Description of the list. [Optional]<br>
<br>
Returns:<br>
A twitter.<a href="#List">List</a> instance representing the new list</tt></dd></dl>
<dl><dt><a name="Api-CreateSubscription"><strong>CreateSubscription</strong></a>(self, owner, list)</dt><dd><tt>Creates a subscription to a list by the authenticated user<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
owner:<br>
<a href="#User">User</a> name or id of the owner of the list being subscribed to.<br>
list:<br>
The slug or list id to subscribe the user to<br>
<br>
Returns:<br>
A twitter.<a href="#List">List</a> instance representing the list subscribed to</tt></dd></dl>
<dl><dt><a name="Api-DestroyDirectMessage"><strong>DestroyDirectMessage</strong></a>(self, id)</dt><dd><tt>Destroys the direct message specified in the required ID parameter.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated, and the<br>
authenticating user must be the recipient of the specified direct<br>
message.<br>
<br>
Args:<br>
id: The id of the direct message to be destroyed<br>
<br>
Returns:<br>
A twitter.<a href="#DirectMessage">DirectMessage</a> instance representing the message destroyed</tt></dd></dl>
<dl><dt><a name="Api-DestroyFavorite"><strong>DestroyFavorite</strong></a>(self, status)</dt><dd><tt>Un-favorites the status specified in the ID parameter as the authenticating user.<br>
Returns the un-favorited status in the requested format when successful.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
The twitter.<a href="#Status">Status</a> to unmark as a favorite.<br>
Returns:<br>
A twitter.<a href="#Status">Status</a> instance representing the newly-unmarked favorite.</tt></dd></dl>
<dl><dt><a name="Api-DestroyFriendship"><strong>DestroyFriendship</strong></a>(self, user)</dt><dd><tt>Discontinues friendship with the user specified in the user parameter.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
The ID or screen name of the user with whom to discontinue friendship.<br>
Returns:<br>
A twitter.<a href="#User">User</a> instance representing the discontinued friend.</tt></dd></dl>
<dl><dt><a name="Api-DestroyList"><strong>DestroyList</strong></a>(self, user, id)</dt><dd><tt>Destroys the list from the given user<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
user:<br>
The user to remove the list from.<br>
id:<br>
The slug or id of the list to remove.<br>
Returns:<br>
A twitter.<a href="#List">List</a> instance representing the removed list.</tt></dd></dl>
<dl><dt><a name="Api-DestroyStatus"><strong>DestroyStatus</strong></a>(self, id)</dt><dd><tt>Destroys the status specified by the required ID parameter.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated and the<br>
authenticating user must be the author of the specified status.<br>
<br>
Args:<br>
id:<br>
The numerical ID of the status you're trying to destroy.<br>
<br>
Returns:<br>
A twitter.<a href="#Status">Status</a> instance representing the destroyed status message</tt></dd></dl>
<dl><dt><a name="Api-DestroySubscription"><strong>DestroySubscription</strong></a>(self, owner, list)</dt><dd><tt>Destroys the subscription to a list for the authenticated user<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
owner:<br>
The user id or screen name of the user that owns the<br>
list that is to be unsubscribed from<br>
list:<br>
The slug or list id of the list to unsubscribe from<br>
<br>
Returns:<br>
A twitter.<a href="#List">List</a> instance representing the removed list.</tt></dd></dl>
<dl><dt><a name="Api-FilterPublicTimeline"><strong>FilterPublicTimeline</strong></a>(self, term, since_id<font color="#909090">=None</font>)</dt><dd><tt>Filter the public twitter timeline by a given search term on<br>
the local machine.<br>
<br>
Args:<br>
term:<br>
term to search by.<br>
since_id:<br>
Returns results with an ID greater than (that is, more recent<br>
than) the specified ID. There are limits to the number of<br>
Tweets which can be accessed through the API. If the limit of<br>
Tweets has occured since the since_id, the since_id will be<br>
forced to the oldest ID available. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#Status">Status</a> instances, one for each message<br>
containing the term</tt></dd></dl>
<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 a list of the direct messages sent to the authenticating user.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
since:<br>
Narrows the returned results to just those statuses created<br>
after the specified HTTP-formatted date. [Optional]<br>
since_id:<br>
Returns results with an ID greater than (that is, more recent<br>
than) the specified ID. There are limits to the number of<br>
Tweets which can be accessed through the API. If the limit of<br>
Tweets has occured since the since_id, the since_id will be<br>
forced to the oldest ID available. [Optional]<br>
page:<br>
Specifies the page of results to retrieve.<br>
Note: there are pagination limits. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#DirectMessage">DirectMessage</a> instances</tt></dd></dl>
<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 a list of <a href="#Status">Status</a> objects representing favorited tweets.<br>
By default, returns the (up to) 20 most recent tweets for the<br>
authenticated user.<br>
<br>
Args:<br>
user:<br>
The twitter name or id of the user whose favorites you are fetching.<br>
If not specified, defaults to the authenticated user. [Optional]<br>
page:<br>
Specifies the page of results to retrieve.<br>
Note: there are pagination limits. [Optional]</tt></dd></dl>
<dl><dt><a name="Api-GetFeatured"><strong>GetFeatured</strong></a>(self)</dt><dd><tt>Fetch the sequence of twitter.<a href="#User">User</a> instances featured on twitter.com<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#User">User</a> instances</tt></dd></dl>
<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 the sequence of twitter.<a href="#User">User</a> instances, one for each follower<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#User">User</a> instances, one for each follower</tt></dd></dl>
<dl><dt><a name="Api-GetFollowers"><strong>GetFollowers</strong></a>(self, page<font color="#909090">=None</font>)</dt><dd><tt>Fetch the sequence of twitter.<a href="#User">User</a> instances, one for each follower<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
page:<br>
Specifies the page of results to retrieve.<br>
Note: there are pagination limits. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#User">User</a> instances, one for each follower</tt></dd></dl>
<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 a list of twitter user id's for every person<br>
the specified user is following.<br>
<br>
Args:<br>
user:<br>
The id or screen_name of the user to retrieve the id list for<br>
[Optional]<br>
<br>
Returns:<br>
A list of integers, one for each user id.</tt></dd></dl>
<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 the sequence of twitter.<a href="#User">User</a> instances, one for each friend.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
user:<br>
The twitter name or id of the user whose friends you are fetching.<br>
If not specified, defaults to the authenticated user. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#User">User</a> instances, one for each friend</tt></dd></dl>
<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 the sequence of twitter.<a href="#Status">Status</a> messages for a user's friends<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated if the user is private.<br>
<br>
Args:<br>
user:<br>
Specifies the ID or screen name of the user for whom to return<br>
the friends_timeline. If not specified then the authenticated<br>
user set in the twitter.<a href="#Api">Api</a> instance will be used. [Optional]<br>
count:<br>
Specifies the number of statuses to retrieve. May not be<br>
greater than 100. [Optional]<br>
page:<br>
Specifies the page of results to retrieve.<br>
Note: there are pagination limits. [Optional]<br>
since_id:<br>
Returns results with an ID greater than (that is, more recent<br>
than) the specified ID. There are limits to the number of<br>
Tweets which can be accessed through the API. If the limit of<br>
Tweets has occured since the since_id, the since_id will be<br>
forced to the oldest ID available. [Optional]<br>
retweets:<br>
If True, the timeline will contain native retweets. [Optional]<br>
include_entities:<br>
If True, each tweet will include a node called "entities,".<br>
This node offers a variety of metadata about the tweet in a<br>
discreet structure, including: user_mentions, urls, and<br>
hashtags. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#Status">Status</a> instances, one for each message</tt></dd></dl>
<dl><dt><a name="Api-GetLists"><strong>GetLists</strong></a>(self, user, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch the sequence of lists for a user.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
user:<br>
The twitter name or id of the user whose friends you are fetching.<br>
If the passed in user is the same as the authenticated user<br>
then you will also receive private list data.<br>
cursor:<br>
"page" value that Twitter will use to start building the<br>
list sequence from. -1 to start at the beginning.<br>
Twitter will return in the result the values for next_cursor<br>
and previous_cursor. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#List">List</a> instances, one for each list</tt></dd></dl>
<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 the 20 most recent mentions (status containing @twitterID)<br>
for the authenticating user.<br>
<br>
Args:<br>
since_id:<br>
Returns results with an ID greater than (that is, more recent<br>
than) the specified ID. There are limits to the number of<br>
Tweets which can be accessed through the API. If the limit of<br>
Tweets has occured since the since_id, the since_id will be<br>
forced to the oldest ID available. [Optional]<br>
max_id:<br>
Returns only statuses with an ID less than<br>
(that is, older than) the specified ID. [Optional]<br>
page:<br>
Specifies the page of results to retrieve.<br>
Note: there are pagination limits. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#Status">Status</a> instances, one for each mention of the user.</tt></dd></dl>
<dl><dt><a name="Api-GetRateLimitStatus"><strong>GetRateLimitStatus</strong></a>(self)</dt><dd><tt>Fetch the rate limit status for the currently authorized user.<br>
<br>
Returns:<br>
A dictionary containing the time the limit will reset (reset_time),<br>
the number of remaining hits allowed before the reset (remaining_hits),<br>
the number of hits allowed in a 60-minute period (hourly_limit), and<br>
the time of the reset in seconds since The Epoch (reset_time_in_seconds).</tt></dd></dl>
<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 a sequence of status messages representing the 20 most<br>
recent replies (status updates prefixed with @twitterID) to the<br>
authenticating user.<br>
<br>
Args:<br>
since_id:<br>
Returns results with an ID greater than (that is, more recent<br>
than) the specified ID. There are limits to the number of<br>
Tweets which can be accessed through the API. If the limit of<br>
Tweets has occured since the since_id, the since_id will be<br>
forced to the oldest ID available. [Optional]<br>
page:<br>
Specifies the page of results to retrieve.<br>
Note: there are pagination limits. [Optional]<br>
since:<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#Status">Status</a> instances, one for each reply to the user.</tt></dd></dl>
<dl><dt><a name="Api-GetRetweets"><strong>GetRetweets</strong></a>(self, statusid)</dt><dd><tt>Returns up to 100 of the first retweets of the tweet identified<br>
by statusid<br>
<br>
Args:<br>
statusid:<br>
The ID of the tweet for which retweets should be searched for<br>
<br>
Returns:<br>
A list of twitter.<a href="#Status">Status</a> instances, which are retweets of statusid</tt></dd></dl>
<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 twitter search results for a given term.<br>
<br>
Args:<br>
term:<br>
term to search by.<br>
since_id:<br>
Returns results with an ID greater than (that is, more recent<br>
than) the specified ID. There are limits to the number of<br>
Tweets which can be accessed through the API. If the limit of<br>
Tweets has occured since the since_id, the since_id will be<br>
forced to the oldest ID available. [Optional]<br>
geocode:<br>
geolocation information in the form (latitude, longitude, radius)<br>
[Optional]<br>
per_page:<br>
number of results to return. Default is 15 [Optional]<br>
page:<br>
Specifies the page of results to retrieve.<br>
Note: there are pagination limits. [Optional]<br>
lang:<br>
language for results. Default is English [Optional]<br>
show_user:<br>
prefixes screen name in status<br>
query_users:<br>
If set to False, then all users only have screen_name and<br>
profile_image_url available.<br>
If set to True, all information of users are available,<br>
but it uses lots of request quota, one per status.<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#Status">Status</a> instances, one for each message containing<br>
the term</tt></dd></dl>
<dl><dt><a name="Api-GetStatus"><strong>GetStatus</strong></a>(self, id)</dt><dd><tt>Returns a single status message.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated if the<br>
status message is private.<br>
<br>
Args:<br>
id:<br>
The numeric ID of the status you are trying to retrieve.<br>
<br>
Returns:<br>
A twitter.<a href="#Status">Status</a> instance representing that status message</tt></dd></dl>
<dl><dt><a name="Api-GetSubscriptions"><strong>GetSubscriptions</strong></a>(self, user, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch the sequence of Lists that the given user is subscribed to<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
user:<br>
The twitter name or id of the user<br>
cursor:<br>
"page" value that Twitter will use to start building the<br>
list sequence from. -1 to start at the beginning.<br>
Twitter will return in the result the values for next_cursor<br>
and previous_cursor. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#List">List</a> instances, one for each list</tt></dd></dl>
<dl><dt><a name="Api-GetTrendsCurrent"><strong>GetTrendsCurrent</strong></a>(self, exclude<font color="#909090">=None</font>)</dt><dd><tt>Get the current top trending topics<br>
<br>
Args:<br>
exclude:<br>
Appends the exclude parameter as a request parameter.<br>
Currently only exclude=hashtags is supported. [Optional]<br>
<br>
Returns:<br>
A list with 10 entries. Each entry contains the twitter.</tt></dd></dl>
<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 the current top trending topics for each hour in a given day<br>
<br>
Args:<br>
startdate:<br>
The start date for the report.<br>
Should be in the format YYYY-MM-DD. [Optional]<br>
exclude:<br>
Appends the exclude parameter as a request parameter.<br>
Currently only exclude=hashtags is supported. [Optional]<br>
<br>
Returns:<br>
A list with 24 entries. Each entry contains the twitter.<br>
<a href="#Trend">Trend</a> elements that were trending at the corresponding hour of the day.</tt></dd></dl>
<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 the top 30 trending topics for each day in a given week.<br>
<br>
Args:<br>
startdate:<br>
The start date for the report.<br>
Should be in the format YYYY-MM-DD. [Optional]<br>
exclude:<br>
Appends the exclude parameter as a request parameter.<br>
Currently only exclude=hashtags is supported. [Optional]<br>
Returns:<br>
A list with each entry contains the twitter.<br>
<a href="#Trend">Trend</a> elements of trending topics for the corrsponding day of the week</tt></dd></dl>
<dl><dt><a name="Api-GetUser"><strong>GetUser</strong></a>(self, user)</dt><dd><tt>Returns a single user.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
user: The twitter name or id of the user to retrieve.<br>
<br>
Returns:<br>
A twitter.<a href="#User">User</a> instance representing that user</tt></dd></dl>
<dl><dt><a name="Api-GetUserByEmail"><strong>GetUserByEmail</strong></a>(self, email)</dt><dd><tt>Returns a single user by email address.<br>
<br>
Args:<br>
email:<br>
The email of the user to retrieve.<br>
<br>
Returns:<br>
A twitter.<a href="#User">User</a> instance representing that user</tt></dd></dl>
<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 the sequence of retweets made by a single user.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
count:<br>
The number of status messages to retrieve. [Optional]<br>
since_id:<br>
Returns results with an ID greater than (that is, more recent<br>
than) the specified ID. There are limits to the number of<br>
Tweets which can be accessed through the API. If the limit of<br>
Tweets has occured since the since_id, the since_id will be<br>
forced to the oldest ID available. [Optional]<br>
max_id:<br>
Returns results with an ID less than (that is, older than) or<br>
equal to the specified ID. [Optional]<br>
include_entities:<br>
If True, each tweet will include a node called "entities,".<br>
This node offers a variety of metadata about the tweet in a<br>
discreet structure, including: user_mentions, urls, and<br>
hashtags. [Optional]<br>
<br>
Returns:<br>
A sequence of twitter.<a href="#Status">Status</a> instances, one for each message up to count</tt></dd></dl>
<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 the sequence of public <a href="#Status">Status</a> messages for a single user.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated if the user is private.<br>
<br>
Args:<br>
id:<br>
Specifies the ID or screen name of the user for whom to return<br>
the user_timeline. [Optional]<br>
user_id:<br>
Specfies the ID of the user for whom to return the<br>
user_timeline. Helpful for disambiguating when a valid user ID<br>
is also a valid screen name. [Optional]<br>
screen_name:<br>
Specfies the screen name of the user for whom to return the<br>
user_timeline. Helpful for disambiguating when a valid screen<br>
name is also a user ID. [Optional]<br>
since_id:<br>
Returns results with an ID greater than (that is, more recent<br>
than) the specified ID. There are limits to the number of<br>
Tweets which can be accessed through the API. If the limit of<br>
Tweets has occured since the since_id, the since_id will be<br>
forced to the oldest ID available. [Optional]<br>
max_id:<br>
Returns only statuses with an ID less than (that is, older<br>
than) or equal to the specified ID. [Optional]<br>
count:<br>
Specifies the number of statuses to retrieve. May not be<br>
greater than 200. [Optional]<br>
page:<br>
Specifies the page of results to retrieve.<br>
Note: there are pagination limits. [Optional]<br>
include_rts:<br>
If True, the timeline will contain native retweets (if they<br>
exist) in addition to the standard stream of tweets. [Optional]<br>
include_entities:<br>
If True, each tweet will include a node called "entities,".<br>
This node offers a variety of metadata about the tweet in a<br>
discreet structure, including: user_mentions, urls, and<br>
hashtags. [Optional]<br>
<br>
Returns:<br>
A sequence of <a href="#Status">Status</a> instances, one for each message up to count</tt></dd></dl>
<dl><dt><a name="Api-MaximumHitFrequency"><strong>MaximumHitFrequency</strong></a>(self)</dt><dd><tt>Determines the minimum number of seconds that a program must wait<br>
before hitting the server again without exceeding the rate_limit<br>
imposed for the currently authenticated user.<br>
<br>
Returns:<br>
The minimum second interval that a program must use so as to not<br>
exceed the rate_limit imposed for the user.</tt></dd></dl>
<dl><dt><a name="Api-PostDirectMessage"><strong>PostDirectMessage</strong></a>(self, user, text)</dt><dd><tt>Post a twitter direct message from the authenticated user<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
user: The ID or screen name of the recipient user.<br>
text: The message text to be posted. Must be less than 140 characters.<br>
<br>
Returns:<br>
A twitter.<a href="#DirectMessage">DirectMessage</a> instance representing the message posted</tt></dd></dl>
<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 a twitter status message from the authenticated user.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
status:<br>
The message text to be posted.<br>
Must be less than or equal to 140 characters.<br>
in_reply_to_status_id:<br>
The ID of an existing status that the status to be posted is<br>
in reply to. This implicitly sets the in_reply_to_user_id<br>
attribute of the resulting status to the user ID of the<br>
message being replied to. Invalid/missing status IDs will be<br>
ignored. [Optional]<br>
Returns:<br>
A twitter.<a href="#Status">Status</a> instance representing the message posted.</tt></dd></dl>
<dl><dt><a name="Api-PostUpdates"><strong>PostUpdates</strong></a>(self, status, continuation<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Post one or more twitter status messages from the authenticated user.<br>
<br>
Unlike api.PostUpdate, this method will post multiple status updates<br>
if the message is longer than 140 characters.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
status:<br>
The message text to be posted.<br>
May be longer than 140 characters.<br>
continuation:<br>
The character string, if any, to be appended to all but the<br>
last message. Note that Twitter strips trailing '...' strings<br>
from messages. Consider using the unicode \u2026 character<br>
(horizontal ellipsis) instead. [Defaults to None]<br>
**kwargs:<br>
See api.PostUpdate for a list of accepted parameters.<br>
<br>
Returns:<br>
A of list twitter.<a href="#Status">Status</a> instance representing the messages posted.</tt></dd></dl>
<dl><dt><a name="Api-SetCache"><strong>SetCache</strong></a>(self, cache)</dt><dd><tt>Override the default cache. Set to None to prevent caching.<br>
<br>
Args:<br>
cache:<br>
An instance that supports the same API as the twitter._FileCache</tt></dd></dl>
<dl><dt><a name="Api-SetCacheTimeout"><strong>SetCacheTimeout</strong></a>(self, cache_timeout)</dt><dd><tt>Override the default cache timeout.<br>
<br>
Args:<br>
cache_timeout:<br>
Time, in seconds, that responses should be reused.</tt></dd></dl>
<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 the consumer_key and consumer_secret for this instance<br>
<br>
Args:<br>
consumer_key:<br>
The consumer_key of the twitter account.<br>
consumer_secret:<br>
The consumer_secret for the twitter account.<br>
access_token_key:<br>
The oAuth access token key value you retrieved<br>
from running get_access_token.py.<br>
access_token_secret:<br>
The oAuth access token's secret, also retrieved<br>
from the get_access_token.py run.</tt></dd></dl>
<dl><dt><a name="Api-SetSource"><strong>SetSource</strong></a>(self, source)</dt><dd><tt>Suggest the "from source" value to be displayed on the Twitter web site.<br>
<br>
The value of the 'source' parameter must be first recognized by<br>
the Twitter server. New source values are authorized on a case by<br>
case basis by the Twitter development team.<br>
<br>
Args:<br>
source:<br>
The source name as a string. Will be sent to the server as<br>
the 'source' parameter.</tt></dd></dl>
<dl><dt><a name="Api-SetUrllib"><strong>SetUrllib</strong></a>(self, urllib)</dt><dd><tt>Override the default urllib implementation.<br>
<br>
Args:<br>
urllib:<br>
An instance that supports the same API as the urllib2 module</tt></dd></dl>
<dl><dt><a name="Api-SetUserAgent"><strong>SetUserAgent</strong></a>(self, user_agent)</dt><dd><tt>Override the default user agent<br>
<br>
Args:<br>
user_agent:<br>
A string that should be send to the server as the <a href="#User">User</a>-agent</tt></dd></dl>
<dl><dt><a name="Api-SetXTwitterHeaders"><strong>SetXTwitterHeaders</strong></a>(self, client, url, version)</dt><dd><tt>Set the X-Twitter HTTP headers that will be sent to the server.<br>
<br>
Args:<br>
client:<br>
The client name as a string. Will be sent to the server as<br>
the 'X-Twitter-Client' header.<br>
url:<br>
The URL of the meta.xml as a string. Will be sent to the server<br>
as the 'X-Twitter-Client-URL' header.<br>
version:<br>
The client version as a string. Will be sent to the server<br>
as the 'X-Twitter-Client-Version' header.</tt></dd></dl>
<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 extended information for the specified users.<br>
<br>
Users may be specified either as lists of either user_ids,<br>
screen_names, or twitter.<a href="#User">User</a> objects. The list of users that<br>
are queried is the union of all specified parameters.<br>
<br>
The twitter.<a href="#Api">Api</a> instance must be authenticated.<br>
<br>
Args:<br>
user_id:<br>
A list of user_ids to retrieve extended information.<br>
[Optional]<br>
screen_name:<br>
A list of screen_names to retrieve extended information.<br>
[Optional]<br>
users:<br>
A list of twitter.<a href="#User">User</a> objects to retrieve extended information.<br>
[Optional]<br>
<br>
Returns:<br>
A list of twitter.<a href="#User">User</a> objects for the requested users</tt></dd></dl>
<dl><dt><a name="Api-VerifyCredentials"><strong>VerifyCredentials</strong></a>(self)</dt><dd><tt>Returns a twitter.<a href="#User">User</a> instance if the authenticating user is valid.<br>
<br>
Returns:<br>
A twitter.<a href="#User">User</a> instance representing that user if the<br>
credentials are valid, None otherwise.</tt></dd></dl>
<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">=<object object at 0x1001da0a0></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 a new twitter.<a href="#Api">Api</a> <a href="__builtin__.html#object">object</a>.<br>
<br>
Args:<br>
consumer_key:<br>
Your Twitter user's consumer_key.<br>
consumer_secret:<br>
Your Twitter user's consumer_secret.<br>
access_token_key:<br>
The oAuth access token key value you retrieved<br>
from running get_access_token.py.<br>
access_token_secret:<br>
The oAuth access token's secret, also retrieved<br>
from the get_access_token.py run.<br>
input_encoding:<br>
The encoding used to encode input strings. [Optional]<br>
request_header:<br>
A dictionary of additional HTTP request headers. [Optional]<br>
cache:<br>
The cache instance to use. Defaults to DEFAULT_CACHE.<br>
Use None to disable caching. [Optional]<br>
shortner:<br>
The shortner instance to use. Defaults to None.<br>
See shorten_url.py for an example shortner. [Optional]<br>
base_url:<br>
The base URL to use to contact the Twitter API.<br>
Defaults to https://twitter.com. [Optional]<br>
use_gzip_compression:<br>
Set to True to tell enable gzip compression for any call<br>
made to Twitter. Defaults to False. [Optional]<br>
debugHTTP:<br>
Set to True to enable debug output from urllib2 when performing<br>
any HTTP requests. Defaults to False. [Optional]</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>DEFAULT_CACHE_TIMEOUT</strong> = 60</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<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>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A class representing the <a href="#DirectMessage">DirectMessage</a> structure used by the twitter API.<br>
<br>
The <a href="#DirectMessage">DirectMessage</a> structure exposes the following properties:<br>
<br>
direct_message.id<br>
direct_message.created_at<br>
direct_message.created_at_in_seconds # read only<br>
direct_message.sender_id<br>
direct_message.sender_screen_name<br>
direct_message.recipient_id<br>
direct_message.recipient_screen_name<br>
direct_message.text<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="DirectMessage-AsDict"><strong>AsDict</strong></a>(self)</dt><dd><tt>A dict representation of this twitter.<a href="#DirectMessage">DirectMessage</a> instance.<br>
<br>
The return value uses the same key names as the JSON representation.<br>
<br>
Return:<br>
A dict representing this twitter.<a href="#DirectMessage">DirectMessage</a> instance</tt></dd></dl>
<dl><dt><a name="DirectMessage-AsJsonString"><strong>AsJsonString</strong></a>(self)</dt><dd><tt>A JSON string representation of this twitter.<a href="#DirectMessage">DirectMessage</a> instance.<br>
<br>
Returns:<br>
A JSON string representation of this twitter.<a href="#DirectMessage">DirectMessage</a> instance</tt></dd></dl>
<dl><dt><a name="DirectMessage-GetCreatedAt"><strong>GetCreatedAt</strong></a>(self)</dt><dd><tt>Get the time this direct message was posted.<br>
<br>
Returns:<br>
The time this direct message was posted</tt></dd></dl>
<dl><dt><a name="DirectMessage-GetCreatedAtInSeconds"><strong>GetCreatedAtInSeconds</strong></a>(self)</dt><dd><tt>Get the time this direct message was posted, in seconds since the epoch.<br>
<br>
Returns:<br>
The time this direct message was posted, in seconds since the epoch.</tt></dd></dl>
<dl><dt><a name="DirectMessage-GetId"><strong>GetId</strong></a>(self)</dt><dd><tt>Get the unique id of this direct message.<br>
<br>
Returns:<br>
The unique id of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-GetRecipientId"><strong>GetRecipientId</strong></a>(self)</dt><dd><tt>Get the unique recipient id of this direct message.<br>
<br>
Returns:<br>
The unique recipient id of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-GetRecipientScreenName"><strong>GetRecipientScreenName</strong></a>(self)</dt><dd><tt>Get the unique recipient screen name of this direct message.<br>
<br>
Returns:<br>
The unique recipient screen name of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-GetSenderId"><strong>GetSenderId</strong></a>(self)</dt><dd><tt>Get the unique sender id of this direct message.<br>
<br>
Returns:<br>
The unique sender id of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-GetSenderScreenName"><strong>GetSenderScreenName</strong></a>(self)</dt><dd><tt>Get the unique sender screen name of this direct message.<br>
<br>
Returns:<br>
The unique sender screen name of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-GetText"><strong>GetText</strong></a>(self)</dt><dd><tt>Get the text of this direct message.<br>
<br>
Returns:<br>
The text of this direct message.</tt></dd></dl>
<dl><dt><a name="DirectMessage-SetCreatedAt"><strong>SetCreatedAt</strong></a>(self, created_at)</dt><dd><tt>Set the time this direct message was posted.<br>
<br>
Args:<br>
created_at:<br>
The time this direct message was created</tt></dd></dl>
<dl><dt><a name="DirectMessage-SetId"><strong>SetId</strong></a>(self, id)</dt><dd><tt>Set the unique id of this direct message.<br>
<br>
Args:<br>
id:<br>
The unique id of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-SetRecipientId"><strong>SetRecipientId</strong></a>(self, recipient_id)</dt><dd><tt>Set the unique recipient id of this direct message.<br>
<br>
Args:<br>
recipient_id:<br>
The unique recipient id of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-SetRecipientScreenName"><strong>SetRecipientScreenName</strong></a>(self, recipient_screen_name)</dt><dd><tt>Set the unique recipient screen name of this direct message.<br>
<br>
Args:<br>
recipient_screen_name:<br>
The unique recipient screen name of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-SetSenderId"><strong>SetSenderId</strong></a>(self, sender_id)</dt><dd><tt>Set the unique sender id of this direct message.<br>
<br>
Args:<br>
sender_id:<br>
The unique sender id of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-SetSenderScreenName"><strong>SetSenderScreenName</strong></a>(self, sender_screen_name)</dt><dd><tt>Set the unique sender screen name of this direct message.<br>
<br>
Args:<br>
sender_screen_name:<br>
The unique sender screen name of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-SetText"><strong>SetText</strong></a>(self, text)</dt><dd><tt>Set the text of this direct message.<br>
<br>
Args:<br>
text:<br>
The text of this direct message</tt></dd></dl>
<dl><dt><a name="DirectMessage-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl>
<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 <a href="__builtin__.html#object">object</a> to hold a Twitter direct message.<br>
<br>
This class is normally instantiated by the twitter.<a href="#Api">Api</a> class and<br>
returned in a sequence.<br>
<br>
Note: Dates are posted in the form "Sat Jan 27 04:17:38 +0000 2007"<br>
<br>
Args:<br>
id:<br>
The unique id of this direct message. [Optional]<br>
created_at:<br>
The time this direct message was posted. [Optional]<br>
sender_id:<br>
The id of the twitter user that sent this message. [Optional]<br>
sender_screen_name:<br>
The name of the twitter user that sent this message. [Optional]<br>
recipient_id:<br>
The id of the twitter that received this message. [Optional]<br>
recipient_screen_name:<br>
The name of the twitter that received this message. [Optional]<br>
text:<br>
The text of this direct message. [Optional]</tt></dd></dl>
<dl><dt><a name="DirectMessage-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl>
<dl><dt><a name="DirectMessage-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>A string representation of this twitter.<a href="#DirectMessage">DirectMessage</a> instance.<br>
<br>
The return value is the same as the JSON string representation.<br>
<br>
Returns:<br>
A string representation of this twitter.<a href="#DirectMessage">DirectMessage</a> instance.</tt></dd></dl>
<hr>
Static methods defined here:<br>
<dl><dt><a name="DirectMessage-NewFromJsonDict"><strong>NewFromJsonDict</strong></a>(data)</dt><dd><tt>Create a new instance based on a JSON dict.<br>
<br>
Args:<br>
data:<br>
A JSON dict, as converted from the JSON in the twitter API<br>
<br>
Returns:<br>
A twitter.<a href="#DirectMessage">DirectMessage</a> instance</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>