Docs For Class JTwitterProfile

Description

Twitter API Profile class for the Joomla Platform.

since: 12.3

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

JTwitterObject
   |
   --JTwitterProfile

Method Summary

array getSettings ()

array updateProfile ([string $name = null], [string $url = null], [string $location = null], [string $description = null], [boolean $entities = null], [boolean $skip_status = null])

array updateProfileBackgroundImage ([string $image = null], [boolean $tile = false], [boolean $entities = null], [boolean $skip_status = null], [boolean $use = false])

array updateProfileColors ([string $background = null], [string $link = null], [string $sidebar_border = null], [string $sidebar_fill = null], [string $text = null], [boolean $entities = null], [boolean $skip_status = null])

array updateProfileImage ([string $image = null], [boolean $entities = null], [boolean $skip_status = null])

array updateSettings ([integer $location = null], [boolean $sleep_time = false], [integer $start_sleep = null], [integer $end_sleep = null], [string $time_zone = null], [string $lang = null])

Variables

Inherited Variables

Inherited from JTwitterObject

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

Methods

getSettings (line 274)

Method to get the settings (including current trend, geo and sleep time information) for the authenticating user.

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

array getSettings ()

updateProfile (line 37)

Method to et values that users are able to set under the "Account" tab of their settings page.

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

array updateProfile ([string $name = null], [string $url = null], [string $location = null], [string $description = null], [boolean $entities = null], [boolean $skip_status = null])

string $name: Full name associated with the profile. Maximum of 20 characters.
string $url: URL associated with the profile. Will be prepended with "http://" if not present. Maximum of 100 characters.
string $location: The city or country describing where the user of the account is located. The contents are not normalized or geocoded in any way. Maximum of 30 characters.
string $description: A description of the user owning the account. Maximum of 160 characters.
boolean $entities: When set to either true, t or 1, 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.

updateProfileBackgroundImage (line 102)

Method to update the authenticating user's profile background image. This method can also be used to enable or disable the profile background image.

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

array updateProfileBackgroundImage ([string $image = null], [boolean $tile = false], [boolean $entities = null], [boolean $skip_status = null], [boolean $use = false])

string $image: The background image for the profile.
boolean $tile: Whether or not to tile the background image.
boolean $entities: When set to either true, t or 1, 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.
boolean $use: Determines whether to display the profile background image or not.

updateProfileColors (line 210)

Method to set one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com.

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

array updateProfileColors ([string $background = null], [string $link = null], [string $sidebar_border = null], [string $sidebar_fill = null], [string $text = null], [boolean $entities = null], [boolean $skip_status = null])

string $background: Profile background color.
string $link: Profile link color.
string $sidebar_border: Profile sidebar's border color.
string $sidebar_fill: Profile sidebar's fill color.
string $text: Profile text color.
boolean $entities: When set to either true, t or 1, 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.

updateProfileImage (line 160)

Method to update the authenticating user's profile image.

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

array updateProfileImage ([string $image = null], [boolean $entities = null], [boolean $skip_status = null])

string $image: The background image for the profile.
boolean $entities: When set to either true, t or 1, 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.

updateSettings (line 301)

Method to update the authenticating user's settings.

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

array updateSettings ([integer $location = null], [boolean $sleep_time = false], [integer $start_sleep = null], [integer $end_sleep = null], [string $time_zone = null], [string $lang = null])

integer $location: The Yahoo! Where On Earth ID to use as the user's default trend location.
boolean $sleep_time: When set to true, t or 1, will enable sleep time for the user.
integer $start_sleep: The hour that sleep time should begin if it is enabled.
integer $end_sleep: The hour that sleep time should end if it is enabled.
string $time_zone: The timezone dates and times should be displayed in for the user. The timezone must be one of the Rails TimeZone names.
string $lang: The language which Twitter should render in for this user.

Inherited Methods

Inherited From JTwitterObject

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