JLinkedinCommunications

class JLinkedinCommunications extends JLinkedinObject

Linkedin API Social Communications class for the Joomla Platform.

Methods

__construct( Registry $options = null, JHttp $client = null, JLinkedinOAuth $oauth = null)

Constructor.

from JLinkedinObject
string
booleanToString( boolean $bool)

Method to convert boolean to string.

from JLinkedinObject
mixed
getOption( string $key)

Get an option from the JLinkedinObject instance.

from JLinkedinObject
JLinkedinObject
setOption( string $key, mixed $value)

Set an option for the JLinkedinObject instance.

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

Method used to invite people.

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

Method used to invite people.

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

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

Details

__construct( Registry $options = null, JHttp $client = null, JLinkedinOAuth $oauth = null)

Constructor.

Parameters

Registry $options Linkedin options object.
JHttp $client The HTTP client object.
JLinkedinOAuth $oauth The OAuth client.

string booleanToString( boolean $bool)

Method to convert boolean to string.

Parameters

boolean $bool The boolean value to convert.

Return Value

string String with the converted boolean.

mixed getOption( string $key)

Get an option from the JLinkedinObject instance.

Parameters

string $key The name of the option to get.

Return Value

mixed The option value.

JLinkedinObject setOption( string $key, mixed $value)

Set an option for the JLinkedinObject instance.

Parameters

string $key The name of the option to set.
mixed $value The option value to set.

Return Value

JLinkedinObject This object for method chaining.

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

Method used to invite people.

Parameters

string $email A string containing email of the recipient.
string $first_name A string containing frist name of the recipient.
string $last_name A string containing last name of the recipient.
string $subject The subject of the message that will be sent to the recipient
string $body A text of the message.
string $connection Only connecting as a 'friend' is supported presently.

Return Value

array The decoded JSON response

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

Method used to invite people.

Parameters

string $id Member id.
string $first_name A string containing frist name of the recipient.
string $last_name A string containing last name of the recipient.
string $subject The subject of the message that will be sent to the recipient
string $body A text of the message.
string $connection Only connecting as a 'friend' is supported presently.

Return Value

array The decoded JSON response

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

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

.

Parameters

mixed $recipient A string containing the member id or an array of ids.
string $subject The subject of the message that will be sent to the recipient
string $body A text of the message.

Return Value

array The decoded JSON response