JLinkedinCommunications

Extends \JLinkedinObject

Linkedin API Social Communications 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.

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.

inviteByEmail

Method used to invite people.

inviteByEmail(string $email, string $first_name, string $last_name, string $subject, string $body, string $connection = 'friend') : array
since

3.2.0

Arguments

$email

stringA string containing email of the recipient.

$first_name

stringA string containing frist name of the recipient.

$last_name

stringA string containing last name of the recipient.

$subject

stringThe subject of the message that will be sent to the recipient

$body

stringA text of the message.

$connection

stringOnly connecting as a 'friend' is supported presently.

Response

arrayThe decoded JSON response

inviteById

Method used to invite people.

inviteById(string $id, string $first_name, string $last_name, string $subject, string $body, string $connection = 'friend') : array
since

3.2.0

Arguments

$id

stringMember id.

$first_name

stringA string containing frist name of the recipient.

$last_name

stringA string containing last name of the recipient.

$subject

stringThe subject of the message that will be sent to the recipient

$body

stringA text of the message.

$connection

stringOnly connecting as a 'friend' is supported presently.

Response

arrayThe decoded JSON response

sendMessage

Method used to send messages via LinkedIn between two or more individuals connected to the member sending the message.

sendMessage(mixed $recipient, string $subject, string $body) : array

.

since

3.2.0

Arguments

$recipient

mixedA string containing the member id or an array of ids.

$subject

stringThe subject of the message that will be sent to the recipient

$body

stringA text of the message.

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