Docs For Class JTwitterDirectmessages

Description

Twitter API Direct Messages class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/twitter/directmessages.php (line 19)

JTwitterObject
   |
   --JTwitterDirectmessages

Method Summary

array deleteDirectMessages (integer $id, [boolean $entities = null])

array getDirectMessages ([integer $since_id = 0], [integer $max_id = 0], [integer $count = 20], [boolean $entities = null], [boolean $skip_status = null])

array getDirectMessagesById (integer $id)

array getSentDirectMessages ([integer $since_id = 0], [integer $max_id = 0], [integer $count = 20], [integer $page = 0], [boolean $entities = null])

array sendDirectMessages (mixed $user, string $text)

Variables

Inherited Variables

Inherited from JTwitterObject

JTwitterObject::$client
JTwitterObject::$oauth
JTwitterObject::$options

Methods

deleteDirectMessages (line 204)

Method to delete the direct message specified in the required ID parameter.

return: The decoded JSON response
since: 12.3
access: public

array deleteDirectMessages (integer $id, [boolean $entities = null])

integer $id: The ID of the direct message.
boolean $entities: When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.

getDirectMessages (line 35)

Method to get the most recent direct messages sent to the authenticating user.

return: The decoded JSON response
since: 12.3
access: public

array getDirectMessages ([integer $since_id = 0], [integer $max_id = 0], [integer $count = 20], [boolean $entities = null], [boolean $skip_status = null])

integer $since_id: Returns results with an ID greater than (that is, more recent than) the specified ID.
integer $max_id: Returns results with an ID less than (that is, older than) or equal to the specified ID.
integer $count: Specifies the number of direct messages to try and retrieve, up to a maximum of 200.
boolean $entities: When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
boolean $skip_status: When set to either true, t or 1 statuses will not be included in the returned user objects.

getDirectMessagesById (line 179)

Method to get a single direct message, specified by an id parameter.

return: The decoded JSON response
since: 12.3
access: public

array getDirectMessagesById (integer $id)

integer $id: The ID of the direct message.

getSentDirectMessages (line 91)

Method to get the most recent direct messages sent by the authenticating user.

return: The decoded JSON response
since: 12.3
access: public

array getSentDirectMessages ([integer $since_id = 0], [integer $max_id = 0], [integer $count = 20], [integer $page = 0], [boolean $entities = null])

integer $since_id: Returns results with an ID greater than (that is, more recent than) the specified ID.
integer $max_id: Returns results with an ID less than (that is, older than) or equal to the specified ID.
integer $count: Specifies the number of direct messages to try and retrieve, up to a maximum of 200.
integer $page: Specifies the page of results to retrieve.
boolean $entities: When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.

sendDirectMessages (line 144)

Method to send a new direct message to the specified user from the authenticating user.

return: The decoded JSON response
since: 12.3
throws: RuntimeException
access: public

array sendDirectMessages (mixed $user, string $text)

mixed $user: Either an integer containing the user ID or a string containing the screen name.
string $text: The text of your direct message. Be sure to keep the message under 140 characters.

Inherited Methods

Inherited From JTwitterObject

JTwitterObject::__construct()
JTwitterObject::checkRateLimit()
JTwitterObject::fetchUrl()
JTwitterObject::getOption()
JTwitterObject::getRateLimit()
JTwitterObject::sendRequest()
JTwitterObject::setOption()