Documentation

LinkedIn
in package

Table of Contents

Constants

_SHARE_COMMENT_LENGTH  = 700
_SHARE_CONTENT_DESC_LENGTH  = 400
_SHARE_CONTENT_TITLE_LENGTH  = 200
_URL_ACCESS_V2  = 'https://www.linkedin.com/oauth/v2/accessToken'
_URL_API  = 'https://api.linkedin.com'
_URL_API_V2  = 'https://api.linkedin.com/v2'
_URL_AUTH_V2  = 'https://www.linkedin.com/oauth/v2/authorization?response_type=code'
_URL_REVOKE  = 'https://api.linkedin.com/uas/oauth/invalidateToken'
_USER_CONSTANT  = 'LINKEDIN_USER_ID_'

Properties

$access_token  : mixed
$application_key  : mixed
$application_secret  : mixed
$callback  : mixed
$token  : mixed

Methods

__construct()  : mixed
checkResponse()  : mixed
Determine the response type from each API call
checkStatusOfUpload()  : mixed
Method to check the status of the photo upload
company()  : mixed
Method to retrieve company information
emailAddress()  : mixed
API to retrieve user email address for Oauth V2
getCompanyLists()  : mixed
Method to retrieve lists of company that the user have
isThrottled()  : mixed
Determine if request is throttled by LinkedIn
me()  : mixed
General user profile retrieval function
retrieveTokenAccess()  : mixed
Retrieve token access for oauth2 authentication
revoke()  : mixed
Revoke application access
setAccessToken()  : mixed
Set access token required for API call
setApplicationKey()  : mixed
Set application key
setApplicationSecret()  : mixed
Set application secret
setCallbackUrl()  : mixed
Set callback url after authentication
sharePost()  : mixed
Method to share the post (version 2.0)
sharePostLegacy()  : mixed
Method to share the post made in EB
xmlToArray()  : mixed
Converts passed XML data to an array.
fetch()  : mixed
General fetch method for all API call
processMedia()  : mixed
Method to process the media properties for sharing

Constants

_SHARE_COMMENT_LENGTH

public mixed _SHARE_COMMENT_LENGTH = 700

_SHARE_CONTENT_DESC_LENGTH

public mixed _SHARE_CONTENT_DESC_LENGTH = 400

_SHARE_CONTENT_TITLE_LENGTH

public mixed _SHARE_CONTENT_TITLE_LENGTH = 200

_URL_ACCESS_V2

public mixed _URL_ACCESS_V2 = 'https://www.linkedin.com/oauth/v2/accessToken'

_URL_API

public mixed _URL_API = 'https://api.linkedin.com'

_URL_API_V2

public mixed _URL_API_V2 = 'https://api.linkedin.com/v2'

_URL_AUTH_V2

public mixed _URL_AUTH_V2 = 'https://www.linkedin.com/oauth/v2/authorization?response_type=code'

_URL_REVOKE

public mixed _URL_REVOKE = 'https://api.linkedin.com/uas/oauth/invalidateToken'

_USER_CONSTANT

public mixed _USER_CONSTANT = 'LINKEDIN_USER_ID_'

Properties

$access_token

protected mixed $access_token = \null

$application_key

protected mixed $application_key = \null

$application_secret

protected mixed $application_secret = \null

$callback

protected mixed $callback = \null

Methods

__construct()

public __construct(mixed $config) : mixed
Parameters
$config : mixed

checkResponse()

Determine the response type from each API call

public checkResponse(mixed $http_code_required, mixed $response) : mixed
Parameters
$http_code_required : mixed
$response : mixed
Tags
since
5.2.5
access

public

checkStatusOfUpload()

Method to check the status of the photo upload

public checkStatusOfUpload(mixed $asset) : mixed
Parameters
$asset : mixed
Tags
since
5.4.13
access

public

company()

Method to retrieve company information

public company(mixed $options) : mixed
Parameters
$options : mixed
Tags
since
5.2.13
access

public

emailAddress()

API to retrieve user email address for Oauth V2

public emailAddress([mixed $options = '?q=members&projection=(elements*(handle~))' ]) : mixed
Parameters
$options : mixed = '?q=members&projection=(elements*(handle~))'
Tags
since
5.2.13
access

public

getCompanyLists()

Method to retrieve lists of company that the user have

public getCompanyLists(mixed $options) : mixed
Parameters
$options : mixed
Tags
since
5.2.14
access

public

isThrottled()

Determine if request is throttled by LinkedIn

public isThrottled(mixed $response) : mixed
Parameters
$response : mixed
Tags
since
5.2.5
access

public

me()

General user profile retrieval function

public me([mixed $options = '?projection=(id,firstName,lastName,profilePicture(displayImage~:playableStreams))' ]) : mixed
Parameters
$options : mixed = '?projection=(id,firstName,lastName,profilePicture(displayImage~:playableStreams))'
Tags
since
5.2.13
access

public

retrieveTokenAccess()

Retrieve token access for oauth2 authentication

public retrieveTokenAccess(mixed $code) : mixed
Parameters
$code : mixed
Tags
since
5.2.5
access

public

revoke()

Revoke application access

public revoke() : mixed
Tags
since
5.2.5
access

public

setAccessToken()

Set access token required for API call

public setAccessToken(mixed $token) : mixed
Parameters
$token : mixed
Tags
since
5.2.5
access

public

setApplicationKey()

Set application key

public setApplicationKey(mixed $key) : mixed
Parameters
$key : mixed
Tags
since
5.2.5
access

public

setApplicationSecret()

Set application secret

public setApplicationSecret(mixed $secret) : mixed
Parameters
$secret : mixed
Tags
since
5.2.5
access

public

setCallbackUrl()

Set callback url after authentication

public setCallbackUrl(mixed $url) : mixed
Parameters
$url : mixed
Tags
since
5.2.5
access

public

sharePost()

Method to share the post (version 2.0)

public sharePost(mixed $action, mixed $content[, mixed $private = true ][, mixed $twitter = false ][, mixed $company = false ]) : mixed
Parameters
$action : mixed
$content : mixed
$private : mixed = true
$twitter : mixed = false
$company : mixed = false
Tags
since
5.2.13
access

public

sharePostLegacy()

Method to share the post made in EB

public sharePostLegacy(mixed $action, mixed $content[, mixed $private = TRUE ][, mixed $twitter = FALSE ][, mixed $companies = array() ]) : mixed
Parameters
$action : mixed
$content : mixed
$private : mixed = TRUE
$twitter : mixed = FALSE
$companies : mixed = array()
Tags
since
5.2.5
access

public

xmlToArray()

Converts passed XML data to an array.

public xmlToArray(mixed $xml) : mixed
Parameters
$xml : mixed
Tags
since
5.2.5
access

public

fetch()

General fetch method for all API call

protected fetch(mixed $method, mixed $url[, mixed $data = NULL ][, mixed $parameters = array() ]) : mixed
Parameters
$method : mixed
$url : mixed
$data : mixed = NULL
$parameters : mixed = array()
Tags
since
5.2.5
access

public

processMedia()

Method to process the media properties for sharing

private processMedia(mixed $content, mixed $company) : mixed
Parameters
$content : mixed
$company : mixed
Tags
since
5.2.13
access

public


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results