Class JLinkedinStream

Description
Description | Vars | Methods (details)

Linkedin API Social Stream class for the Joomla Platform.

  • since: 13.1

Located in /libraries/joomla/linkedin/stream.php (line 19) 

JLinkedinObject
   |
   --JLinkedinStream
Method Summary
Description | Vars | Methods (details)
array getComments (string $key)
array getCurrentShare ([string $id = null], [string $url = null])
array getLikes (string $key)
array getNetworkStats ()
array getNetworkUpdates ([string $id = null], [boolean $self = true], [mixed $type = null], [integer $count = 0], [integer $start = 0], [string $after = null], [string $before = null], [boolean $hidden = false])
array getShareStream ([string $id = null], [string $url = null], [boolean $self = true])
array like (string $key)
array postComment (string $key, string $comment)
array postNetworkUpdate (string $body)
array reshare (string $visibility, string $id, [string $comment = null], [boolean $twitter = false])
array share (string $visibility, [string $comment = null], [string $title = null], [string $url = null], [string $image = null], [string $description = null], [boolean $twitter = false])
array unlike (string $key)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JLinkedinObject

JLinkedinObject::$client
 JLinkedinObject::$oauth
 JLinkedinObject::$options
Methods
Description | Vars Methods (details)
getComments (line 463)

Method to retrieve all comments for a given network update.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getComments (string $key)
  • string $key: update/update-key representing an update.
getCurrentShare (line 183)

Method to get a particular member's current share.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getCurrentShare ([string $id = null], [string $url = null])
  • string $id: Member id of the profile you want.
  • string $url: The public profile URL.
getLikes (line 537)

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

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getLikes (string $key)
  • string $key: update/update-key representing an update.
getNetworkStats (line 388)

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

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getNetworkStats ()
getNetworkUpdates (line 302)

Method to get the users network updates.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getNetworkUpdates ([string $id = null], [boolean $self = true], [mixed $type = null], [integer $count = 0], [integer $start = 0], [string $after = null], [string $before = null], [boolean $hidden = false])
  • string $id: Member id.
  • boolean $self: Used to return member's feed. Omitted to return aggregated network feed.
  • mixed $type: String containing any valid Network Update Type from the table or an array of strings to specify more than one Network Update type.
  • integer $count: Number of updates to return, with a maximum of 250.
  • integer $start: The offset by which to start Network Update pagination.
  • string $after: Timestamp after which to retrieve updates.
  • string $before: Timestamp before which to retrieve updates.
  • boolean $hidden: Whether to display updates from people the member has chosen to "hide" from their update stream.
getShareStream (line 236)

Method to get a particular member's current share.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getShareStream ([string $id = null], [string $url = null], [boolean $self = true])
  • string $id: Member id of the profile you want.
  • string $url: The public profile URL.
  • boolean $self: Used to return member's feed. Omitted to return aggregated network feed.
like (line 609)

Method used to like an update.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array like (string $key)
  • string $key: Update/update-key representing an update.
postComment (line 497)

Method to post a new comment to an existing update.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array postComment (string $key, string $comment)
  • string $key: update/update-key representing an update.
  • string $comment: Maximum length of 700 characters
postNetworkUpdate (line 422)

Method to get the users network updates.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array postNetworkUpdate (string $body)
  • string $body: The 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.
reshare (line 122)

Method to reshare an existing share.

  • return: The decoded JSON response
  • since: 13.1
  • throws: RuntimeException
  • access: public
array reshare (string $visibility, string $id, [string $comment = null], [boolean $twitter = false])
  • string $visibility: One of anyone: all members or connections-only: connections only.
  • string $id: The unique identifier for a share.
  • string $comment: Text of member's comment.
  • boolean $twitter: True to have LinkedIn pass the status message along to a member's tethered Twitter account.
share (line 37)

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

  • return: The decoded JSON response
  • since: 13.1
  • throws: RuntimeException
  • access: public
array share (string $visibility, [string $comment = null], [string $title = null], [string $url = null], [string $image = null], [string $description = null], [boolean $twitter = false])
  • string $visibility: One of anyone: all members or connections-only: connections only.
  • string $comment: Text of member's comment.
  • string $title: Title of shared document.
  • string $url: URL for shared content.
  • string $image: URL for image of shared content.
  • string $description: Description of shared content.
  • boolean $twitter: True to have LinkedIn pass the status message along to a member's tethered Twitter account.
unlike (line 623)

Method used to unlike an update.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array unlike (string $key)
  • string $key: Update/update-key representing an update.

Inherited Methods

Inherited From JLinkedinObject

JLinkedinObject::__construct()
JLinkedinObject::booleanToString()
JLinkedinObject::getOption()
JLinkedinObject::setOption()

Documentation generated on Tue, 19 Nov 2013 15:14:30 +0100 by phpDocumentor 1.4.3