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 JLinkedinCompanies
+ Graphe d'héritage de JLinkedinCompanies:

Fonctions membres publiques

 getCompanies ($id=null, $name=null, $domain=null, $fields=null)
 
 getUpdates ($id, $type=null, $count=0, $start=0)
 
 search ($fields=null, $keywords=null, $hq=false, $facets=null, $facet=null, $start=0, $count=0, $sort=null)
 
 getFollowed ($fields=null)
 
 follow ($id)
 
 unfollow ($id)
 
 getSuggested ($fields=null, $start=0, $count=0)
 
 getProducts ($id, $fields=null, $start=0, $count=0)
 
- 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)
 

Membres hérités additionnels

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

Description détaillée

Linkedin API Companies class for the Joomla Platform.

Depuis
13.1

Documentation des fonctions membres

◆ follow()

follow (   $id)

Method to follow a company.

Paramètres
string$idThe unique identifier for a company.
Renvoie
array The decoded JSON response
Depuis
13.1

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

◆ getCompanies()

getCompanies (   $id = null,
  $name = null,
  $domain = null,
  $fields = null 
)

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

Paramètres
integer$idThe unique internal numeric company identifier.
string$nameThe unique string identifier for a company.
string$domainCompany email domains.
string$fieldsRequest fields beyond the default ones.
Renvoie
array The decoded JSON response
Depuis
13.1
Exceptions
RuntimeException

Références $base, $data, $fields, $id, $name, $parameters, $path, elseif, et null.

◆ getFollowed()

getFollowed (   $fields = null)

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

Paramètres
string$fieldsRequest fields beyond the default ones.
Renvoie
array The decoded JSON response
Depuis
13.1

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

◆ getProducts()

getProducts (   $id,
  $fields = null,
  $start = 0,
  $count = 0 
)

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

Paramètres
string$idThe unique identifier for a company.
string$fieldsRequest fields beyond the default ones.
integer$startStarting location within the result set for paginated returns.
integer$countThe number of results returned.
Renvoie
array The decoded JSON response
Depuis
13.1

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

◆ getSuggested()

getSuggested (   $fields = null,
  $start = 0,
  $count = 0 
)

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

Paramètres
string$fieldsRequest fields beyond the default ones.
integer$startStarting location within the result set for paginated returns.
integer$countThe number of results returned.
Renvoie
array The decoded JSON response
Depuis
13.1

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

◆ getUpdates()

getUpdates (   $id,
  $type = null,
  $count = 0,
  $start = 0 
)

Method to read shares for a particular company .

Paramètres
string$idThe unique company identifier.
string$typeAny valid Company Update Type from the table: https://developer.linkedin.com/reading-company-updates.
integer$countMaximum number of updates to return.
integer$startThe offset by which to start Network Update pagination.
Renvoie
array The decoded JSON response
Depuis
13.1

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

◆ search()

search (   $fields = null,
  $keywords = null,
  $hq = false,
  $facets = null,
  $facet = null,
  $start = 0,
  $count = 0,
  $sort = null 
)

Method to search across company pages.

Paramètres
string$fieldsRequest fields beyond the default ones.
string$keywordsMembers who have all the keywords anywhere in their profile.
boolean$hqMatching 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$facetsFacet buckets to return, e.g. location.
array$facetArray 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$startStarting location within the result set for paginated returns.
integer$countThe number of results returned.
string$sortControls the search result order. There are four options: relevance, relationship, followers and company-size.
Renvoie
array The decoded JSON response
Depuis
13.1

Références $base, $count, $data, $fields, $i, $keywords, $parameters, $path, et $start.

◆ unfollow()

unfollow (   $id)

Method to unfollow a company.

Paramètres
string$idThe unique identifier for a company.
Renvoie
array The decoded JSON response
Depuis
13.1

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


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