Class JTwitterProfile
Twitter API Profile class for the Joomla Platform.
-
JTwitterObject
-
JTwitterProfile
Methods summary
public
array
|
#
updateProfile( string $name = null, string $url = null, string $location = null, string $description = null, boolean $entities = null, boolean $skip_status = null )
Method to et values that users are able to set under the "Account" tab of
their settings page.
Method to et values that users are able to set under the "Account" tab of
their settings page.
Parameters
- $name
string - $name Full name associated with the profile. Maximum of 20 characters.- $url
string - $url URL associated with the profile. Will be prepended with "http://" if not
present. Maximum of 100 characters.- $location
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.- $description
string - $description A description of the user owning the account. Maximum of 160
characters.- $entities
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.- $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
|
#
updateProfileBackgroundImage( string $image = null, boolean $tile = false, boolean $entities = null, boolean $skip_status = null, boolean $use = false )
Method to update the authenticating user's profile background image. This
method can also be used to enable or disable the profile background image.
Method to update the authenticating user's profile background image. This
method can also be used to enable or disable the profile background image.
Parameters
- $image
string - $image The background image for the profile.- $tile
boolean - $tile Whether or not to tile the background image.- $entities
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.- $skip_status
boolean - $skip_status When set to either true, t or 1 statuses will not be included in
the returned user objects.- $use
boolean - $use Determines whether to display the profile background image or not. Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
updateProfileImage( string $image = null, boolean $entities = null, boolean $skip_status = null )
Method to update the authenticating user's profile image.
Method to update the authenticating user's profile image.
Parameters
- $image
string - $image The background image for the profile.- $entities
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.- $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
|
#
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 )
Method to set one or more hex values that control the color scheme of the
authenticating user's profile page on twitter.com.
Method to set one or more hex values that control the color scheme of the
authenticating user's profile page on twitter.com.
Parameters
- $background
string - $background Profile background color.- $link
string - $link Profile link color.- $sidebar_border
string - $sidebar_border Profile sidebar's border color.- $sidebar_fill
string - $sidebar_fill Profile sidebar's fill color.- $text
string - $text Profile text color.- $entities
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.- $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
|
#
getSettings( )
Method to get the settings (including current trend, geo and sleep time
information) for the authenticating user.
Method to get the settings (including current trend, geo and sleep time
information) for the authenticating user.
Returns
array - The decoded JSON response
Since
12.3
|
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 )
Method to update the authenticating user's settings.
Method to update the authenticating user's settings.
Parameters
- $location
integer - $location The Yahoo! Where On Earth ID to use as the user's default trend
location.- $sleep_time
boolean - $sleep_time When set to true, t or 1, will enable sleep time for the user.- $start_sleep
integer - $start_sleep The hour that sleep time should begin if it is enabled.- $end_sleep
integer - $end_sleep The hour that sleep time should end if it is enabled.- $time_zone
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.- $lang
string - $lang The language which Twitter should render in for this user. Returns
array - The decoded JSON response
Since
12.3
|
__construct(),
checkRateLimit(),
fetchUrl(),
getOption(),
getRateLimit(),
sendRequest(),
setOption()
Magic methods summary
Properties summary
$client,
$oauth,
$options
