Docs For Class JLinkedinPeople

Description

Linkedin API People class for the Joomla Platform.

since: 13.1

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

JLinkedinObject
   |
   --JLinkedinPeople

Method Summary

array getConnections ([string $fields = null], [integer $start = 0], [integer $count = 500], [string $modified = null], [string $modified_since = null])

array getProfile ([string $id = null], [string $url = null], [string $fields = null], [string $type = 'standard'], [string $language = null])

array search ([string $fields = null], [string $keywords = null], [string $first_name = null], [string $last_name = null], [string $company_name = null], [boolean $current_company = null], [string $title = null], [boolean $current_title = null], [string $school_name = null], [string $current_school = null], [string $country_code = null], [integer $postal_code = null], [integer $distance = null], [string $facets = null], [array $facet = null], [integer $start = 0], [integer $count = 10], [string $sort = null])

Variables

Inherited Variables

Inherited from JLinkedinObject

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

Methods

getConnections (line 105)

Method to get a list of connections for a user who has granted access to his/her account.

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

array getConnections ([string $fields = null], [integer $start = 0], [integer $count = 500], [string $modified = null], [string $modified_since = null])

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.
string $modified: Values are updated or new.
string $modified_since: Value as a Unix time stamp of milliseconds since epoch.

getProfile (line 34)

Method to get a member's profile.

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

array getProfile ([string $id = null], [string $url = null], [string $fields = null], [string $type = 'standard'], [string $language = null])

string $id: Member id of the profile you want.
string $url: The public profile URL.
string $fields: Request fields beyond the default ones.
string $type: Choosing public or standard profile.
string $language: A comma separated list of locales ordered from highest to lowest preference.

search (line 189)

Method to get information about people.

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

array search ([string $fields = null], [string $keywords = null], [string $first_name = null], [string $last_name = null], [string $company_name = null], [boolean $current_company = null], [string $title = null], [boolean $current_title = null], [string $school_name = null], [string $current_school = null], [string $country_code = null], [integer $postal_code = null], [integer $distance = null], [string $facets = null], [array $facet = null], [integer $start = 0], [integer $count = 10], [string $sort = null])

string $fields: Request fields beyond the default ones. provide 'api-standard-profile-request' field for out of network profiles.
string $keywords: Members who have all the keywords anywhere in their profile.
string $first_name: Members with a matching first name. Matches must be exact.
string $last_name: Members with a matching last name. Matches must be exactly.
string $company_name: Members who have a matching company name on their profile.
boolean $current_company: A value of true matches members who currently work at the company specified in the company-name parameter.
string $title: Matches members with that title on their profile.
boolean $current_title: A value of true matches members whose title is currently the one specified in the title-name parameter.
string $school_name: Members who have a matching school name on their profile.
string $current_school: A value of true matches members who currently attend the school specified in the school-name parameter.
string $country_code: Matches members with a location in a specific country. Values are defined in by ISO 3166 standard. Country codes must be in all lower case.
integer $postal_code: Matches members centered around a Postal Code. Must be combined with the country-code parameter. Not supported for all countries.
integer $distance: Matches members within a distance from a central point. This is measured in miles.
string $facets: Facet buckets to return, e.g. location.
array $facet: Array of facet values to search over. Contains values for location, industry, network, language, current-company, past-company and school, 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: connections, recommenders, distance and relevance.

Inherited Methods

Inherited From JLinkedinObject

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