JLinkedinPeople

Extends \JLinkedinObject

Linkedin API People 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) 
inherited
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
inherited
since

3.2.0

Arguments

$bool

booleanThe boolean value to convert.

Response

stringString with the converted boolean.

getConnections

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

getConnections(string $fields = null, integer $start, integer $count = 500, string $modified = null, string $modified_since = null) : 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.

$modified

stringValues are updated or new.

$modified_since

stringValue as a Unix time stamp of milliseconds since epoch.

Response

arrayThe decoded JSON response

getOption

Get an option from the JLinkedinObject instance.

getOption(string $key) : mixed
inherited
since

3.2.0

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

getProfile

Method to get a member's profile.

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

3.2.0

Arguments

$id

stringMember id of the profile you want.

$url

stringThe public profile URL.

$fields

stringRequest fields beyond the default ones.

$type

stringChoosing public or standard profile.

$language

stringA comma separated list of locales ordered from highest to lowest preference.

Response

arrayThe decoded JSON response

setOption

Set an option for the JLinkedinObject instance.

setOption(string $key, mixed $value) : \JLinkedinObject
inherited
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.

Properties

options

Options for the Linkedin object.

inherited
since

3.2.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

3.2.0

Type(s)

\JHttp

oauth

The OAuth client.

inherited
since

3.2.0

Type(s)

\JLinkedinOAuth