Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe JTwitterProfile
+ Graphe d'héritage de JTwitterProfile:

Fonctions membres publiques

 updateProfile ($name=null, $url=null, $location=null, $description=null, $entities=null, $skipStatus=null)
 
 updateProfileBackgroundImage ($image=null, $tile=false, $entities=null, $skipStatus=null, $use=false)
 
 updateProfileImage ($image=null, $entities=null, $skipStatus=null)
 
 updateProfileColors ($background=null, $link=null, $sidebarBorder=null, $sidebarFill=null, $text=null, $entities=null, $skipStatus=null)
 
 getSettings ()
 
 updateSettings ($location=null, $sleepTime=false, $startSleep=null, $endSleep=null, $timeZone=null, $lang=null)
 
- Fonctions membres publiques hérités de JTwitterObject
 __construct (Registry &$options=null, JHttp $client=null, JTwitterOAuth $oauth=null)
 
 checkRateLimit ($resource=null, $action=null)
 
 fetchUrl ($path, $parameters=null)
 
 getRateLimit ($resource)
 
 sendRequest ($path, $method='GET', $data=array(), $headers=array())
 
 getOption ($key)
 
 setOption ($key, $value)
 

Membres hérités additionnels

- Attributs protégés hérités de JTwitterObject
 $options
 
 $client
 
 $oauth
 

Description détaillée

Twitter API Profile class for the Joomla Platform.

Depuis
3.1.4
Obsolète:
4.0 Use the joomla/twitter package via Composer instead

Documentation des fonctions membres

◆ getSettings()

getSettings ( )

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

Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $path.

◆ updateProfile()

updateProfile (   $name = null,
  $url = null,
  $location = null,
  $description = null,
  $entities = null,
  $skipStatus = null 
)

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

Paramètres
string$nameFull name associated with the profile. Maximum of 20 characters.
string$urlURL associated with the profile. Will be prepended with "http://" if not present. Maximum of 100 characters.
string$locationThe 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$descriptionA description of the user owning the account. Maximum of 160 characters.
boolean$entitiesWhen 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$skipStatusWhen set to either true, t or 1 statuses will not be included in the returned user objects.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $data, $description, $location, $name, $path, et $url.

◆ updateProfileBackgroundImage()

updateProfileBackgroundImage (   $image = null,
  $tile = false,
  $entities = null,
  $skipStatus = null,
  $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.

Paramètres
string$imageThe background image for the profile.
boolean$tileWhether or not to tile the background image.
boolean$entitiesWhen 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$skipStatusWhen set to either true, t or 1 statuses will not be included in the returned user objects.
boolean$useDetermines whether to display the profile background image or not.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $data, $image, et $path.

◆ updateProfileColors()

updateProfileColors (   $background = null,
  $link = null,
  $sidebarBorder = null,
  $sidebarFill = null,
  $text = null,
  $entities = null,
  $skipStatus = null 
)

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

Paramètres
string$backgroundProfile background color.
string$linkProfile link color.
string$sidebarBorderProfile sidebar's border color.
string$sidebarFillProfile sidebar's fill color.
string$textProfile text color.
boolean$entitiesWhen 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$skipStatusWhen set to either true, t or 1 statuses will not be included in the returned user objects.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $data, $link, $path, et $text.

◆ updateProfileImage()

updateProfileImage (   $image = null,
  $entities = null,
  $skipStatus = null 
)

Method to update the authenticating user's profile image.

Paramètres
string$imageThe background image for the profile.
boolean$entitiesWhen 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$skipStatusWhen set to either true, t or 1 statuses will not be included in the returned user objects.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $data, $image, et $path.

◆ updateSettings()

updateSettings (   $location = null,
  $sleepTime = false,
  $startSleep = null,
  $endSleep = null,
  $timeZone = null,
  $lang = null 
)

Method to update the authenticating user's settings.

Paramètres
integer$locationThe Yahoo! Where On Earth ID to use as the user's default trend location.
boolean$sleepTimeWhen set to true, t or 1, will enable sleep time for the user.
integer$startSleepThe hour that sleep time should begin if it is enabled.
integer$endSleepThe hour that sleep time should end if it is enabled.
string$timeZoneThe timezone dates and times should be displayed in for the user. The timezone must be one of the Rails TimeZone names.
string$langThe language which Twitter should render in for this user.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $data, $lang, $location, et $path.


La documentation de cette classe a été générée à partir du fichier suivant :