JLinkedinCompanies
Extends \JLinkedinObjectLinkedin API Companies class for the Joomla Platform.
| since |
3.2.0 |
|---|---|
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JHttp $client = null, \JLinkedinOAuth $oauth = null)
| since |
3.2.0 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryLinkedin options object.- $client
\JHttpThe HTTP client object.- $oauth
\JLinkedinOAuthThe OAuth client.
booleanToString
Method to convert boolean to string.
booleanToString(boolean $bool) : string
| since |
3.2.0 |
|---|
Arguments
- $bool
booleanThe boolean value to convert.
Response
stringString with the converted boolean.
follow
Method to follow a company.
follow(string $id) : array
| since |
3.2.0 |
|---|
Arguments
- $id
stringThe unique identifier for a company.
Response
arrayThe decoded JSON response
getCompanies
Method to retrieve companies using a company ID, a universal name, or an email domain.
getCompanies(integer $id = null, string $name = null, string $domain = null, string $fields = null) : array
| since |
3.2.0 |
|---|---|
| throws |
|
Arguments
- $id
integerThe unique internal numeric company identifier.- $name
stringThe unique string identifier for a company.- $domain
stringCompany email domains.- $fields
stringRequest fields beyond the default ones.
Response
arrayThe decoded JSON response
getFollowed
Method to get a list of companies the current member is following.
getFollowed(string $fields = null) : array
| since |
3.2.0 |
|---|
Arguments
- $fields
stringRequest fields beyond the default ones.
Response
arrayThe decoded JSON response
getOption
Get an option from the JLinkedinObject instance.
getOption(string $key) : mixed
| since |
3.2.0 |
|---|
Arguments
- $key
stringThe name of the option to get.
Response
mixedThe option value.
getProducts
Method to get a collection of suggested companies for the current user.
getProducts(string $id, string $fields = null, integer $start, integer $count) : array
| since |
3.2.0 |
|---|
Arguments
- $id
stringThe unique identifier for a company.- $fields
stringRequest fields beyond the default ones.- $start
integerStarting location within the result set for paginated returns.- $count
integerThe number of results returned.
Response
arrayThe decoded JSON response
getSuggested
Method to get a collection of suggested companies for the current user.
getSuggested(string $fields = null, integer $start, integer $count) : array
| since |
3.2.0 |
|---|
Arguments
- $fields
stringRequest fields beyond the default ones.- $start
integerStarting location within the result set for paginated returns.- $count
integerThe number of results returned.
Response
arrayThe decoded JSON response
getUpdates
Method to read shares for a particular company .
getUpdates(string $id, string $type = null, integer $count, integer $start) : array
| since |
3.2.0 |
|---|
Arguments
- $id
stringThe unique company identifier.- $type
stringAny valid Company Update Type from the table: https://developer.linkedin.com/reading-company-updates.- $count
integerMaximum number of updates to return.- $start
integerThe offset by which to start Network Update pagination.
Response
arrayThe decoded JSON response
search
Method to search across company pages.
search(string $fields = null, string $keywords = null, boolean $hq = false, string $facets = null, array $facet = null, integer $start, integer $count, string $sort = null) : array
| since |
3.2.0 |
|---|
Arguments
- $fields
stringRequest fields beyond the default ones.- $keywords
stringMembers who have all the keywords anywhere in their profile.- $hq
booleanMatching 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.- $facets
stringFacet buckets to return, e.g. location.- $facet
arrayArray 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.- $start
integerStarting location within the result set for paginated returns.- $count
integerThe number of results returned.- $sort
stringControls the search result order. There are four options: relevance, relationship, followers and company-size.
Response
arrayThe decoded JSON response
setOption
Set an option for the JLinkedinObject instance.
setOption(string $key, mixed $value) : \JLinkedinObject
| since |
3.2.0 |
|---|
Arguments
- $key
stringThe name of the option to set.- $value
mixedThe option value to set.
Response
\JLinkedinObjectThis object for method chaining.
unfollow
Method to unfollow a company.
unfollow(string $id) : array
| since |
3.2.0 |
|---|
Arguments
- $id
stringThe unique identifier for a company.
Response
arrayThe decoded JSON response
Properties
client
The HTTP client object to use in sending HTTP requests.
| since |
3.2.0 |
|---|
Type(s)
\JHttp
oauth
The OAuth client.
| since |
3.2.0 |
|---|
Type(s)
\JLinkedinOAuth