Class JTwitterDirectmessages

Twitter API Direct Messages class for the Joomla Platform.

JTwitterDirectmessages

Package: Joomla\Platform\Twitter
Deprecated: 4.0 Use the joomla/twitter package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/twitter/directmessages.php

Methods summary

`public array`	# `getDirectMessages( integer $since_id = 0, integer $max_id = 0, integer $count = 20, boolean $entities = null, boolean $skip_status = null )` Method to get the most recent direct messages sent to the authenticating user. Method to get the most recent direct messages sent to the authenticating user. Parameters `$since_id` `integer` - $since_id Returns results with an ID greater than (that is, more recent than) the specified ID. `$max_id` `integer` - $max_id Returns results with an ID less than (that is, older than) or equal to the specified ID. `$count` `integer` - $count Specifies the number of direct messages to try and retrieve, up to a maximum of 200. `$entities` `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. `$skip_status` `boolean` - $skip_status When set to either true, t or 1 statuses will not be included in the returned user objects. Returns `array` - The decoded JSON response Since 12.3
`public array`	# `getSentDirectMessages( integer $since_id = 0, integer $max_id = 0, integer $count = 20, integer $page = 0, boolean $entities = null )` Method to get the most recent direct messages sent by the authenticating user. Method to get the most recent direct messages sent by the authenticating user. Parameters `$since_id` `integer` - $since_id Returns results with an ID greater than (that is, more recent than) the specified ID. `$max_id` `integer` - $max_id Returns results with an ID less than (that is, older than) or equal to the specified ID. `$count` `integer` - $count Specifies the number of direct messages to try and retrieve, up to a maximum of 200. `$page` `integer` - $page Specifies the page of results to retrieve. `$entities` `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. Returns `array` - The decoded JSON response Since 12.3
`public array`	# `sendDirectMessages( mixed $user, string $text )` Method to send a new direct message to the specified user from the authenticating user. Method to send a new direct message to the specified user from the authenticating user. Parameters `$user` `mixed` - $user Either an integer containing the user ID or a string containing the screen name. `$text` `string` - $text The text of your direct message. Be sure to keep the message under 140 characters. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `getDirectMessagesById( integer $id )` Method to get a single direct message, specified by an id parameter. Method to get a single direct message, specified by an id parameter. Parameters `$id` `integer` - $id The ID of the direct message. Returns `array` - The decoded JSON response Since 12.3
`public array`	# `deleteDirectMessages( integer $id, boolean $entities = null )` Method to delete the direct message specified in the required ID parameter. Method to delete the direct message specified in the required ID parameter. Parameters `$id` `integer` - $id The ID of the direct message. `$entities` `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. Returns `array` - The decoded JSON response Since 12.3

Methods inherited from JTwitterObject

__construct(), checkRateLimit(), fetchUrl(), getOption(), getRateLimit(), sendRequest(), setOption()

Magic methods summary

Properties summary

Properties inherited from JTwitterObject

$client, $oauth, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JTwitterDirectmessages

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JTwitterObject

Magic methods summary

Properties summary

Properties inherited from JTwitterObject