Class Twitter::Message
In: lib/twitter/model.rb
Parent: Object

Represents a direct message on Twitter between Twitter users.

Methods

attributes   create   find   init  

Included Modules

ModelMixin

Public Class methods

Used as factory method callback

Creates a new direct message from the authenticated user of the given client context.

You MUST include a valid/authenticated client context in the given params argument.

For example:

 status = Twitter::Message.create(
   :text => 'I am shopping for flip flops',
   :recipient => 'anotherlogin',
   :client => client)

An ArgumentError will be raised if no valid client context is given in the params Hash. For example,

 status = Twitter::Status.create(:text => 'I am shopping for flip flops')

The above line of code will raise an ArgumentError.

The same is true when you do not provide any of the following key-value pairs in the params argument given:

  • text - the String that will be the message text to send to user
  • recipient - the user ID, screen_name or Twitter::User object representation of the recipient of the direct message

The Twitter::Message object returned after the direct message is successfully sent on the Twitter server side is returned from this method.

Raises NotImplementedError because currently Twitter doesn‘t provide a facility to retrieve one message by unique ID.

Protected Instance methods

Constructor callback

[Validate]