Docs For Class JLinkedinCompanies

Description

Linkedin API Companies class for the Joomla Platform.

since: 13.1

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

JLinkedinObject
   |
   --JLinkedinCompanies

Method Summary

array follow (string $id)

array getCompanies ([integer $id = null], [string $name = null], [string $domain = null], [string $fields = null])

array getFollowed ([string $fields = null])

array getProducts (string $id, [string $fields = null], [integer $start = 0], [integer $count = 0])

array getSuggested ([string $fields = null], [integer $start = 0], [integer $count = 0])

array getUpdates (string $id, [string $type = null], [integer $count = 0], [integer $start = 0])

array search ([string $fields = null], [string $keywords = null], [boolean $hq = false], [string $facets = null], [array $facet = null], [integer $start = 0], [integer $count = 0], [string $sort = null])

array unfollow (string $id)

Variables

Inherited Variables

Inherited from JLinkedinObject

JLinkedinObject::$client
JLinkedinObject::$oauth
JLinkedinObject::$options

Methods

follow (line 310)

Method to follow a company.

return: The decoded JSON response
since: 13.1
access: public

array follow (string $id)

string $id: The unique identifier for a company.

getCompanies (line 34)

Method to retrieve companies using a company ID, a universal name, or an email domain.

return: The decoded JSON response
since: 13.1
throws: RuntimeException
access: public

array getCompanies ([integer $id = null], [string $name = null], [string $domain = null], [string $fields = null])

integer $id: The unique internal numeric company identifier.
string $name: The unique string identifier for a company.
string $domain: Company email domains.
string $fields: Request fields beyond the default ones.

getFollowed (line 272)

Method to get a list of companies the current member is following.

return: The decoded JSON response
since: 13.1
access: public

array getFollowed ([string $fields = null])

string $fields: Request fields beyond the default ones.

getProducts (line 436)

Method to get a collection of suggested companies for the current user.

return: The decoded JSON response
since: 13.1
access: public

array getProducts (string $id, [string $fields = null], [integer $start = 0], [integer $count = 0])

string $id: The unique identifier for a company.
string $fields: Request fields beyond the default ones.
integer $start: Starting location within the result set for paginated returns.
integer $count: The number of results returned.

getSuggested (line 383)

Method to get a collection of suggested companies for the current user.

return: The decoded JSON response
since: 13.1
access: public

array getSuggested ([string $fields = null], [integer $start = 0], [integer $count = 0])

string $fields: Request fields beyond the default ones.
integer $start: Starting location within the result set for paginated returns.
integer $count: The number of results returned.

getUpdates (line 101)

Method to read shares for a particular company .

return: The decoded JSON response
since: 13.1
access: public

array getUpdates (string $id, [string $type = null], [integer $count = 0], [integer $start = 0])

string $id: The unique company identifier.
string $type: Any valid Company Update Type from the table: https://developer.linkedin.com/reading-company-updates.
integer $count: Maximum number of updates to return.
integer $start: The offset by which to start Network Update pagination.

search (line 162)

Method to search across company pages.

return: The decoded JSON response
since: 13.1
access: public

array search ([string $fields = null], [string $keywords = null], [boolean $hq = false], [string $facets = null], [array $facet = null], [integer $start = 0], [integer $count = 0], [string $sort = null])

string $fields: Request fields beyond the default ones.
string $keywords: Members who have all the keywords anywhere in their profile.
boolean $hq: Matching companies by the headquarters location. When this is set to "true" and a location facet is used, this restricts returned companies to only those whose headquarters resides in the specified location.
string $facets: Facet buckets to return, e.g. location.
array $facet: Array of facet values to search over. Contains values for location, industry, network, company-size, num-followers-range and fortune, in exactly this order, null must be specified for an element if no value.
integer $start: Starting location within the result set for paginated returns.
integer $count: The number of results returned.
string $sort: Controls the search result order. There are four options: relevance, relationship, followers and company-size.

unfollow (line 348)

Method to unfollow a company.

return: The decoded JSON response
since: 13.1
access: public

array unfollow (string $id)

string $id: The unique identifier for a company.

Inherited Methods

Inherited From JLinkedinObject

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