Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
tree: e7ed9f7830
Fetching contributors…

Cannot retrieve contributors at this time

85 lines (81 sloc) 4.97 kB
module Twitter
class Client
# Defines methods related to direct messages
module DirectMessages
# Returns the 20 most recent direct messages sent to the authenticating user
#
# @format :json, :xml
# @authenticated true
# @rate_limited true
# @param options [Hash] A customizable set of options.
# @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
# @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
# @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
# @option options [Integer] :page Specifies the page of results to retrieve.
# @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
# @return [Array] Direct messages sent to the authenticating user.
# @see http://dev.twitter.com/doc/get/direct_messages
# @example Return the 20 most recent direct messages sent to the authenticating user
# Twitter.direct_messages
def direct_messages(options={})
response = get('direct_messages', options)
format.to_s.downcase == 'xml' ? response['direct_messages'] : response
end
# Returns the 20 most recent direct messages sent by the authenticating user
#
# @format :json, :xml
# @authenticated true
# @rate_limited true
# @param options [Hash] A customizable set of options.
# @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
# @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
# @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
# @option options [Integer] :page Specifies the page of results to retrieve.
# @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
# @return [Array] Direct messages sent by the authenticating user.
# @see http://dev.twitter.com/doc/get/direct_messages/sent
# @example Return the 20 most recent direct messages sent by the authenticating user
# Twitter.direct_messages_sent
def direct_messages_sent(options={})
response = get('direct_messages/sent', options)
format.to_s.downcase == 'xml' ? response['direct_messages'] : response
end
# Sends a new direct message to the specified user from the authenticating user
#
# @format :json, :xml
# @authenticated true
# @rate_limited false
# @param user [Integer, String] A Twitter user ID or screen name.
# @param text [String] The text of your direct message, up to 140 characters.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
# @return [Hashie::Mash] The sent message.
# @see http://dev.twitter.com/doc/post/direct_messages/new
# @example Send a direct message to @sferik from the authenticating user
# Twitter.direct_message_create("sferik", "I'm sending you this message via the Twitter Ruby Gem!")
# Twitter.direct_message_create(7505382, "I'm sending you this message via the Twitter Ruby Gem!") # Same as above
def direct_message_create(user, text, options={})
merge_user_into_options!(user, options)
response = post('direct_messages/new', options.merge(:text => text))
format.to_s.downcase == 'xml' ? response['direct_message'] : response
end
# Destroys a direct message
#
# @note The authenticating user must be the recipient of the specified direct message.
# @format :json, :xml
# @authenticated true
# @rate_limited false
# @param id [Integer] The ID of the direct message to delete.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
# @return [Hashie::Mash] The deleted message.
# @see http://dev.twitter.com/doc/post/direct_messages/destroy/:id
# @example Destroys the direct message with the ID 1825785544
# Twitter.direct_message_destroy(1825785544)
def direct_message_destroy(id, options={})
response = delete("direct_messages/destroy/#{id}", options)
format.to_s.downcase == 'xml' ? response['direct_message'] : response
end
end
end
end
Jump to Line
Something went wrong with that request. Please try again.