Joomla! API

Download
Launch

Stream

Extends \Joomla\Linkedin\Object

Linkedin API Social Stream class for the Joomla Framework.

deprecated
since

1.0
deprecated

The joomla/linkedin package is deprecated

Methods

__construct

Constructor.

__construct(array $options = array(), \Joomla\Http\Http $client = null, \Joomla\Linkedin\OAuth $oauth = null)
inherited
since

1.2.0

Arguments

$options

arrayLinkedin options array.

$client

\Joomla\Http\HttpThe HTTP client object.

$oauth

\Joomla\Linkedin\OAuthThe OAuth client.

booleanToString

Method to convert boolean to string.

booleanToString(boolean $bool) : string
inherited
since

1.2.0

Arguments

$bool

booleanThe boolean value to convert.

Response

stringString with the converted boolean.

getComments

Method to retrieve all comments for a given network update.

getComments(string $key) : array
since

1.0

Arguments

$key

stringupdate/update-key representing an update.

Response

arrayThe decoded JSON response

getCurrentShare

Method to get a particular member's current share.

getCurrentShare(string $id = null, string $url = null) : array
since

1.0

Arguments

$id

stringMember id of the profile you want.

$url

stringThe public profile URL.

Response

arrayThe decoded JSON response

getLikes

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

getLikes(string $key) : array
since

1.0

Arguments

$key

stringupdate/update-key representing an update.

Response

arrayThe decoded JSON response

getNetworkStats

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

getNetworkStats() : array
since

1.0

Response

arrayThe decoded JSON response

getNetworkUpdates

Method to get the users network updates.

getNetworkUpdates(string $id = null, boolean $self = true, mixed $type = null, integer $count, integer $start, string $after = null, string $before = null, boolean $hidden = false) : array
since

1.0

Arguments

$id

stringMember id.

$self

booleanUsed to return member's feed. Omitted to return aggregated network feed.

$type

mixedString containing any valid Network Update Type from the table or an array of strings to specify more than one Network Update type.

$count

integerNumber of updates to return, with a maximum of 250.

$start

integerThe offset by which to start Network Update pagination.

$after

stringTimestamp after which to retrieve updates.

$before

stringTimestamp before which to retrieve updates.

$hidden

booleanWhether to display updates from people the member has chosen to "hide" from their update stream.

Response

arrayThe decoded JSON response

getOption

Get an option from the Object instance.

getOption(string $key) : mixed
inherited
since

1.2.0

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

getShareStream

Method to get a particular member's current share.

getShareStream(string $id = null, string $url = null, boolean $self = true) : array
since

1.0

Arguments

$id

stringMember id of the profile you want.

$url

stringThe public profile URL.

$self

booleanUsed to return member's feed. Omitted to return aggregated network feed.

Response

arrayThe decoded JSON response

like

Method used to like an update.

like(string $key) : array
since

1.0

Arguments

$key

stringUpdate/update-key representing an update.

Response

arrayThe decoded JSON response

postComment

Method to post a new comment to an existing update.

postComment(string $key, string $comment) : array
since

1.0

Arguments

$key

stringupdate/update-key representing an update.

$comment

stringMaximum length of 700 characters

Response

arrayThe decoded JSON response

postNetworkUpdate

Method to get the users network updates.

postNetworkUpdate(string $body) : array
since

1.0

Arguments

$body

stringThe 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.

Response

arrayThe decoded JSON response

processLikeUnlike

Method to like or unlike an update.

processLikeUnlike(string $key, boolean $like) : array
since

1.0

Arguments

$key

stringUpdate/update-key representing an update.

$like

booleanTrue to like update, false otherwise.

Response

arrayThe decoded JSON response

reshare

Method to reshare an existing share.

reshare(string $visibility, string $id, string $comment = null, boolean $twitter = false) : array
since

1.0

Arguments

$visibility

stringOne of anyone: all members or connections-only: connections only.

$id

stringThe unique identifier for a share.

$comment

stringText of member's comment.

$twitter

booleanTrue to have LinkedIn pass the status message along to a member's tethered Twitter account.

Response

arrayThe decoded JSON response

setOption

Set an option for the Object instance.

setOption(string $key, mixed $value) : \Joomla\Linkedin\AbstractLinkedinObject
inherited
since

1.2.0

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\Joomla\Linkedin\AbstractLinkedinObjectThis object for method chaining.

share

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

share(string $visibility, string $comment = null, string $title = null, string $url = null, string $image = null, string $description = null, boolean $twitter = false) : array
since

1.0
throws

\RuntimeException

Arguments

$visibility

stringOne of anyone: all members or connections-only: connections only.

$comment

stringText of member's comment.

$title

stringTitle of shared document.

$url

stringURL for shared content.

$image

stringURL for image of shared content.

$description

stringDescription of shared content.

$twitter

booleanTrue to have LinkedIn pass the status message along to a member's tethered Twitter account.

Response

arrayThe decoded JSON response

unlike

Method used to unlike an update.

unlike(string $key) : array
since

1.0

Arguments

$key

stringUpdate/update-key representing an update.

Response

arrayThe decoded JSON response

Properties

options

Options for the Linkedin object.

inherited
since

1.2.0

Type(s)

array

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.2.0

Type(s)

\Joomla\Http\Http

oauth

The OAuth client.

inherited
since

1.2.0

Type(s)

\Joomla\Linkedin\OAuth
  • \ Joomla
  • \ Linkedin
  • \ Stream