Skip to content

Commit

Permalink
Merge pull request #664 from tjphopkins/full_text
Browse files Browse the repository at this point in the history
Allow 'full_text' param when getting direct messages
  • Loading branch information
joshthecoder committed Nov 3, 2015
2 parents 954b2f4 + 2e2657d commit cda2a31
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
15 changes: 13 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,25 +216,36 @@ User methods
Direct Message Methods
----------------------

.. method:: API.direct_messages([since_id], [max_id], [count], [page])
.. method:: API.direct_messages([since_id], [max_id], [count], [page], [full_text])

Returns direct messages sent to the authenticating user.

:param since_id: |since_id|
:param max_id: |max_id|
:param count: |count|
:param page: |page|
:param full_text: |full_text|
:rtype: list of :class:`DirectMessage` objects


.. method:: API.sent_direct_messages([since_id], [max_id], [count], [page])
.. method:: API.get_direct_message([id], [full_text])

Returns a specific direct message.

:param id: |id|
:param full_text: |full_text|
:rtype: :class:`DirectMessage` object


.. method:: API.sent_direct_messages([since_id], [max_id], [count], [page], [full_text])

Returns direct messages sent by the authenticating user.

:param since_id: |since_id|
:param max_id: |max_id|
:param count: |count|
:param page: |page|
:param full_text: |full_text|
:rtype: list of :class:`DirectMessage` objects


Expand Down
1 change: 1 addition & 0 deletions docs/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@
.. |slug| replace:: the slug name or numerical ID of the list
.. |list_mode| replace:: Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.
.. |list_owner| replace:: the screen name of the owner of the list
.. |full_text| replace:: A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False.

12 changes: 6 additions & 6 deletions tweepy/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -392,39 +392,39 @@ def suggested_users_tweets(self):
@property
def direct_messages(self):
""" :reference: https://dev.twitter.com/rest/reference/get/direct_messages
:allowed_param:'since_id', 'max_id', 'count'
:allowed_param:'since_id', 'max_id', 'count', 'full_text'
"""
return bind_api(
api=self,
path='/direct_messages.json',
payload_type='direct_message', payload_list=True,
allowed_param=['since_id', 'max_id', 'count'],
allowed_param=['since_id', 'max_id', 'count', 'full_text'],
require_auth=True
)

@property
def get_direct_message(self):
""" :reference: https://dev.twitter.com/rest/reference/get/direct_messages/show
:allowed_param:'id'
:allowed_param:'id', 'full_text'
"""
return bind_api(
api=self,
path='/direct_messages/show/{id}.json',
payload_type='direct_message',
allowed_param=['id'],
allowed_param=['id', 'full_text'],
require_auth=True
)

@property
def sent_direct_messages(self):
""" :reference: https://dev.twitter.com/rest/reference/get/direct_messages/sent
:allowed_param:'since_id', 'max_id', 'count', 'page'
:allowed_param:'since_id', 'max_id', 'count', 'page', 'full_text'
"""
return bind_api(
api=self,
path='/direct_messages/sent.json',
payload_type='direct_message', payload_list=True,
allowed_param=['since_id', 'max_id', 'count', 'page'],
allowed_param=['since_id', 'max_id', 'count', 'page', 'full_text'],
require_auth=True
)

Expand Down

0 comments on commit cda2a31

Please sign in to comment.