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

Fonctions membres publiques

 share ($visibility, $comment=null, $title=null, $url=null, $image=null, $description=null, $twitter=false)
 
 reshare ($visibility, $id, $comment=null, $twitter=false)
 
 getCurrentShare ($id=null, $url=null)
 
 getShareStream ($id=null, $url=null, $self=true)
 
 getNetworkUpdates ($id=null, $self=true, $type=null, $count=0, $start=0, $after=null, $before=null, $hidden=false)
 
 getNetworkStats ()
 
 postNetworkUpdate ($body)
 
 getComments ($key)
 
 postComment ($key, $comment)
 
 getLikes ($key)
 
 like ($key)
 
 unlike ($key)
 
- Fonctions membres publiques hérités de JLinkedinObject
 __construct (Registry $options=null, JHttp $client=null, JLinkedinOAuth $oauth=null)
 
 booleanToString ($bool)
 
 getOption ($key)
 
 setOption ($key, $value)
 

Fonctions membres privées

 _likeUnlike ($key, $like)
 

Membres hérités additionnels

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

Description détaillée

Linkedin API Social Stream class for the Joomla Platform.

Depuis
13.1

Documentation des fonctions membres

◆ _likeUnlike()

_likeUnlike (   $key,
  $like 
)
private

Method to like or unlike an update.

Paramètres
string$keyUpdate/update-key representing an update.
boolean$likeTrue to like update, false otherwise.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $key, $parameters, et $path.

◆ getComments()

getComments (   $key)

Method to retrieve all comments for a given network update.

Paramètres
string$keyupdate/update-key representing an update.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $data, $key, $parameters, et $path.

◆ getCurrentShare()

getCurrentShare (   $id = null,
  $url = null 
)

Method to get a particular member's current share.

Paramètres
string$idMember id of the profile you want.
string$urlThe public profile URL.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $data, $id, $parameters, $path, $url, et elseif.

◆ getLikes()

getLikes (   $key)

Method to retrieve the complete list of people who liked an update.

Paramètres
string$keyupdate/update-key representing an update.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $data, $key, $parameters, et $path.

◆ getNetworkStats()

getNetworkStats ( )

Method to get information about the current member's network.

Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $data, $parameters, et $path.

◆ getNetworkUpdates()

getNetworkUpdates (   $id = null,
  $self = true,
  $type = null,
  $count = 0,
  $start = 0,
  $after = null,
  $before = null,
  $hidden = false 
)

Method to get the users network updates.

Paramètres
string$idMember id.
boolean$selfUsed to return member's feed. Omitted to return aggregated network feed.
mixed$typeString containing any valid Network Update Type from the table or an array of strings to specify more than one Network Update type.
integer$countNumber of updates to return, with a maximum of 250.
integer$startThe offset by which to start Network Update pagination.
string$afterTimestamp after which to retrieve updates.
string$beforeTimestamp before which to retrieve updates.
boolean$hiddenWhether to display updates from people the member has chosen to "hide" from their update stream.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $count, $data, $hidden, $id, $parameters, $path, $start, et $type.

◆ getShareStream()

getShareStream (   $id = null,
  $url = null,
  $self = true 
)

Method to get a particular member's current share.

Paramètres
string$idMember id of the profile you want.
string$urlThe public profile URL.
boolean$selfUsed to return member's feed. Omitted to return aggregated network feed.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $data, $id, $parameters, $path, $url, et elseif.

◆ like()

like (   $key)

Method used to like an update.

Paramètres
string$keyUpdate/update-key representing an update.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $key.

◆ postComment()

postComment (   $key,
  $comment 
)

Method to post a new comment to an existing update.

Paramètres
string$keyupdate/update-key representing an update.
string$commentMaximum length of 700 characters
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $key, $parameters, et $path.

◆ postNetworkUpdate()

postNetworkUpdate (   $body)

Method to get the users network updates.

Paramètres
string$bodyThe actual content of the update. You can use HTML to include links to the user name and the content the user created. Other HTML tags are not supported. All body text should be HTML entity escaped and UTF-8 compliant.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $parameters, et $path.

◆ reshare()

reshare (   $visibility,
  $id,
  $comment = null,
  $twitter = false 
)

Method to reshare an existing share.

Paramètres
string$visibilityOne of anyone: all members or connections-only: connections only.
string$idThe unique identifier for a share.
string$commentText of member's comment.
boolean$twitterTrue to have LinkedIn pass the status message along to a member's tethered Twitter account.
Renvoie
array The decoded JSON response
Depuis
13.1
Exceptions
RuntimeException

Références $base, $id, $parameters, et $path.

◆ share()

share (   $visibility,
  $comment = null,
  $title = null,
  $url = null,
  $image = null,
  $description = null,
  $twitter = false 
)

Method to add a new share. Note: post must contain comment and/or (title and url).

Paramètres
string$visibilityOne of anyone: all members or connections-only: connections only.
string$commentText of member's comment.
string$titleTitle of shared document.
string$urlURL for shared content.
string$imageURL for image of shared content.
string$descriptionDescription of shared content.
boolean$twitterTrue to have LinkedIn pass the status message along to a member's tethered Twitter account.
Renvoie
array The decoded JSON response
Depuis
13.1
Exceptions
RuntimeException

Références $base, $description, $image, $parameters, $path, $title, $url, et elseif.

◆ unlike()

unlike (   $key)

Method used to unlike an update.

Paramètres
string$keyUpdate/update-key representing an update.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $key.


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