mixin

communications

Instance methods

instance method

communications#sendInvitation

    • communications#sendInvitation(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
mixin

companies

Instance methods

instance method

companies#addShare

    • companies#addShare(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

companies#addShareComment

    • companies#addShareComment(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

companies#addUpdateComment

    • companies#addUpdateComment(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

companies#all

    • companies#all(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors
  • is-company-admin (Boolean): Optional. Fetch a list of all companies the authenticated user is an administrator of.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.

  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.

    See Also
instance method

companies#get

    • companies#get(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • company-id (String): Required. The unique internal numeric company identifier.

    See Also
instance method

companies#getByEmailDomain

    • companies#getByEmailDomain(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • email-domain (String): Required. Company email identifier. Ex: apple.com.

    See Also
instance method

companies#getByUniversalName

    • companies#getByUniversalName(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • universal-name (String): Required. Company name identifier, ex: Apple.

    See Also
instance method

companies#getCurrentShareEnabled

    • companies#getCurrentShareEnabled(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • company-id (String): Required. The unique internal numeric company identifier.

    See Also
instance method

companies#getHistoricalFollowersStatistics

    • companies#getHistoricalFollowersStatistics(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • company-id (String): Required. The unique internal numeric company identifier.
  • start-timestamp (Number): Optional. Starting timestamp of when the stats search should begin (milliseconds since epoch). Validation rule: ^[0-9]+$.
  • end-timestamp (Number): Optional. Ending timestamp of when the stats search should end (milliseconds since epoch). The current time will be used if parameter not set. Validation rule: ^[0-9]+$.

  • time-granularity (String): Optional. Granularity of statistics. Supported values are 'day' and 'month'.

    See Also
instance method

companies#getHistoricalStatusUpdate

    • companies#getHistoricalStatusUpdate(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • company-id (String): Required. The unique internal numeric company identifier.
  • start-timestamp (Number): Optional. Starting timestamp of when the stats search should begin (milliseconds since epoch). Validation rule: ^[0-9]+$.
  • end-timestamp (Number): Optional. Ending timestamp of when the stats search should end (milliseconds since epoch). The current time will be used if parameter not set. Validation rule: ^[0-9]+$.
  • time-granularity (String): Optional. Granularity of statistics. Supported values are 'day' and 'month'.
  • update-key (String): Optional. Only needed if you want to fetch statistics for a specific company share.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

companies#getNumFollowers

    • companies#getNumFollowers(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • seniorities (String): Optional. Level of seniority to target.
  • geos (String): Optional. See geographies for the valid values.
  • companySizes (String): Optional. Specify the size range for the company.
  • jobFunc (String): Optional. Job functions.

  • industries (String): Optional. The industry the LinkedIn member has indicated their profile belongs to (Industry Codes).

    See Also
instance method

companies#getShareEnabled

    • companies#getShareEnabled(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • company-id (String): Required. The unique internal numeric company identifier.

    See Also
instance method

companies#getStatistics

    • companies#getStatistics(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • company-id (String): Required. The unique internal numeric company identifier.

    See Also
instance method

companies#getUpdate

    • companies#getUpdate(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • company-id (String): Required. The unique internal numeric company identifier.
  • event-type (String): Optional. Any valid Company Update Type.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.

  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.

    See Also
instance method

companies#getUpdateComments

    • companies#getUpdateComments(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • company-id (String): Required. The unique internal numeric company identifier.
  • company-update-key (String): Optional. Update/update-key representing a particular company update. By default, a company update will only return all comments, limiting at a max of 100.

  • event-type (String): Optional. Any valid Company Update Type.

    See Also
instance method

companies#getUpdateCommentsLike

    • companies#getUpdateCommentsLike(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • company-id (String): Required. The unique internal numeric company identifier.
  • company-update-key (String): Optional. Update/update-key representing a particular company update. By default, a company update will only return all comments, limiting at a max of 100.

  • event-type (String): Optional. Any valid Company Update Type.

    See Also
instance method

companies#likeShareComment

    • companies#likeShareComment(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

companies#search

    • companies#search(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • keywords (String): Optional. Use this field when you don't know how to more accurately map the input to a more specific parameter. (Don't forget to URL encode this data.)
  • hq-only (String): Optional. Matching companies by the headquarters location. When this is set to 'true' and a location facet is used, this restricts returned companies to only those whose headquarters resides in the specified location.
  • facet (String): Optional. Facet values to search over.
  • facets (String): Optional. Facet buckets to return.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • sort (String): Optional. Controls the search result order.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
mixin

groups

Instance methods

instance method

groups#addPost

    • groups#addPost(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#addPostComment

    • groups#addPostComment(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#flagPost

    • groups#flagPost(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#followPost

    • groups#followPost(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#getComment

    • groups#getComment(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#getDetail

    • groups#getDetail(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#getFromSuggestions

    • groups#getFromSuggestions(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

No other params, simply pass an empty Object literal {}

See Also
instance method

groups#getMembershipDetails

    • groups#getMembershipDetails(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#getMembershipPosts

    • groups#getMembershipPosts(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • group-id (String): Optional. Default. The group ID. Read-only. The ID is assigned automatically when the group is created.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • role (String): Optional. Filter for posts related to the caller. Valid only for group-memberships/{id}/posts resource.
  • order (String): Optional. Sort order for posts.
  • category (Array): Optional. Category of posts.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

groups#getMemberships

    • groups#getMemberships(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • membership-state (String): Optional. The state of the caller’s membership to the specified group. Use the value member to retrieve the groups to which a user belongs.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

groups#getPost

    • groups#getPost(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#getPostComments

    • groups#getPostComments(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • post-id (String): Required. The unique identifier for a post.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

groups#getPosts

    • groups#getPosts(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • group-id (String): Optional. Default. The group ID. Read-only. The ID is assigned automatically when the group is created.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • role (String): Optional. Filter for posts related to the caller. Valid only for group-memberships/{id}/posts resource.
  • order (String): Optional. Sort order for posts.
  • category (Array): Optional. Category of posts.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

groups#getSuggestionPosts

    • groups#getSuggestionPosts(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • group-id (String): Optional. Default. The group ID. Read-only. The ID is assigned automatically when the group is created.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • role (String): Optional. Filter for posts related to the caller. Valid only for group-memberships/{id}/posts resource.
  • order (String): Optional. Sort order for posts.
  • category (Array): Optional. Category of posts.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

groups#join

    • groups#join(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

No other params, simply pass an empty Object literal {}

See Also
instance method

groups#joinAdvanced

    • groups#joinAdvanced(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

No other params, simply pass an empty Object literal {}

See Also
instance method

groups#likePost

    • groups#likePost(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#remove

    • groups#remove(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • group-id (String): Optional. Default. The group ID. Read-only. The ID is assigned automatically when the group is created.

    See Also
instance method

groups#removeComment

    • groups#removeComment(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • comment-id (String): Required. The unique identifier for a comment.

    See Also
instance method

groups#removeFlagPost

    • groups#removeFlagPost(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • post-id (String): Required. The unique identifier for a post.

    See Also
instance method

groups#removeSuggestions

    • groups#removeSuggestions(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • id (String): Optional. A unique identifier token for this member.

    See Also
instance method

groups#updateMembership

    • groups#updateMembership(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

groups#updateMembershipFull

    • groups#updateMembershipFull(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
mixin

jobs

Instance methods

instance method

jobs#add

    • jobs#add(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

jobs#bookmark

    • jobs#bookmark(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

jobs#get

    • jobs#get(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

jobs#getCurrentBookmarks

    • jobs#getCurrentBookmarks(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

jobs#getCurrentSuggestions

    • jobs#getCurrentSuggestions(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • job-id (String): Optional. The unique identifier for a job.

    See Also
instance method

jobs#remove

    • jobs#remove(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • partner-job-id (String): Optional. Unique ID for the job created by the partner (must be unique for each job posted).

    See Also
instance method

jobs#removeBookmark

    • jobs#removeBookmark(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • job-id (String): Optional. The unique identifier for a job.

    See Also
instance method

jobs#search

    • jobs#search(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • keywords (String): Optional. Use this field when you don't know how to more accurately map the input to a more specific parameter. (Don't forget to URL encode this data.)
  • company-name (String): Optional. Members who have a matching company name on their profile. company-name can be combined with the current-company parameter to specifies whether the person is or is not still working at the company.
  • job-title (String): Optional. Matches jobs with the same job title.
  • country-code (String): Optional. 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.
  • postal-code (String): Optional. Matches members centered around a Postal Code. Must be combined with the country-code parameter. Not supported for all countries.
  • distance (String): Optional. The degree distance of the fetched profile from the member who fetched the profile.
  • facet (String): Optional. Facet values to search over.
  • facets (String): Optional. Facet buckets to return.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • sort (String): Optional. Controls the search result order.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

jobs#update

    • jobs#update(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
mixin

people

Instance methods

instance method

people#getCurrent

    • people#getCurrent(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

people#getCurrentConnections

    • people#getCurrentConnections(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • modified (String): Optional. Values are: 'updated' or 'new'.
  • modified-since (Number): Optional. Value as a Unix time stamp of milliseconds since epoch.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

people#getMember

    • people#getMember(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • id (String): Optional. A unique identifier token for this member.
  • url (String): Optional. Public profile URL.
  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

  • secure-urls (Boolean): Optional. Indicate that you want the URLs in your response to be HTTPS.

    See Also
instance method

people#getMemberConnections

    • people#getMemberConnections(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • idOrUrl (String): Required. A unique identifier token for this member or public URL.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • modified (String): Optional. Values are: 'updated' or 'new'.

  • modified-since (Number): Optional. Value as a Unix time stamp of milliseconds since epoch.

    See Also
instance method

people#search

    • people#search(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • keywords (String): Optional. Use this field when you don't know how to more accurately map the input to a more specific parameter. (Don't forget to URL encode this data.)
  • first-name (String): Optional. The member's first name.
  • last-name (String): Optional. The member's last name.
  • company-name (String): Optional. Members who have a matching company name on their profile. company-name can be combined with the current-company parameter to specifies whether the person is or is not still working at the company.
  • current-company (String): Optional. Valid values are true or false. A value of true matches members who currently work at the company specified in the company-name parameter. A value of false matches members who once worked at the company. Omitting the parameter matches members who currently or once worked the company.
  • title (String): Optional. Matches members with that title on their profile. Works with the current-title parameter.
  • current-title (String): Optional. Valid values are true or false. A value of true matches members whose title is currently the one specified in the title-name parameter. A value of false matches members who once had that title. Omitting the parameter matches members who currently or once had that title.
  • school-name (String): Optional. Members who have a matching school name on their profile. school-name can be combined with the current-school parameter to specifies whether the person is or is not still at the school. It's often valuable to not be too specific with the school name. The same explation provided with company name applies: 'Yale' vs. 'Yale University'.
  • current-school (String): Optional. Valid values are true or false. A value of true matches members who currently attend the school specified in the school-name parameter. A value of false matches members who once attended the school. Omitting the parameter matches members who currently or once attended the school.
  • country-code (String): Optional. 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.
  • postal-code (String): Optional. Matches members centered around a Postal Code. Must be combined with the country-code parameter. Not supported for all countries.
  • distance (String): Optional. The degree distance of the fetched profile from the member who fetched the profile.
  • facet (String): Optional. Facet values to search over.
  • facets (String): Optional. Facet buckets to return.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • sort (String): Optional. Controls the search result order.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
mixin

shares

Instance methods

instance method

shares#add

    • shares#add(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

shares#addNetworkUpdate

    • shares#addNetworkUpdate(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

shares#addShareComment

    • shares#addShareComment(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
instance method

shares#getNetworksStats

    • shares#getNetworksStats(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

No other params, simply pass an empty Object literal {}

See Also
instance method

shares#getNetworksUpdates

    • shares#getNetworksUpdates(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
  • scope (String): Optional. self to return member's feed. Omitted to return aggregated network feed.
  • type (String): Optional. Any valid Network Update Type from the table below. Types must be in all capital letters. To specify more than one Network Update type, add the type parameter to the resource URL for each type.
  • start (Number): Optional. Record index at which to start pagination. Validation rule: ^[0-9]+$.
  • count (Number): Optional. Number of records to return. Validation rule: ^[0-9]+$.
  • after (Number): Optional. Timestamp after which to retrieve updates for (Ex: 1243834824000) note: precision is milliseconds since the epoch. Validation rule: ^[0-9]+$.
  • before (Number): Optional. Timestamp before which to retrieve updates for (Ex: 1243834824000) note: precision is milliseconds since the epoch. Validation rule: ^[0-9]+$.
  • show-hidden-members (String): Optional. true or false. default is false. Whether to display updates from people the member has chosen to 'hide' from their update stream.

  • url-field-selector (String): Optional. Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors

    See Also
instance method

shares#getNetworksUpdatesComments

    • shares#getNetworksUpdatesComments(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • update-key (String): Optional. Only needed if you want to fetch statistics for a specific company share.

    See Also
instance method

shares#getNetworksUpdatesLike

    • shares#getNetworksUpdatesLike(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

  • update-key (String): Optional. Only needed if you want to fetch statistics for a specific company share.

    See Also
instance method

shares#likeShareComment

    • shares#likeShareComment(msg, callback)
    • msg
      • Object

    • Object that contains the parameters and their values to be sent to the server.

    • callback
      • Function

    • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:
class

Linkedin

Description

The MIT License (MIT) Copyright (c) 2014 Julien Valéry

Author: Julien Valéry darul75@gmail.com

Deeply inspired by node-github project.

Linkedin load version 1 of the [[linkedin]] client API, with the requirement that a valid routes.json definition file is present in the api/[VERSION] directory and that the routes found in this file are implemented as well.

Upon instantiation of the Linkedin class, the routes.json file is loaded from the API version specified in the configuration and, parsed and from it the routes for HTTP requests are extracted. For each HTTP endpoint to the HTTP server, a method is generated which accepts a Javascript Object with parameters and an optional callback to be invoked when the API request returns from the server or when the parameters could not be validated.

When an HTTP endpoint is processed and a method is generated as described above, Linkedin also sets up parameter validation with the rules as defined in the routes.json. A full example that illustrates how this works is shown below:

Example

First, we look at a listing of a sample routes.json routes definition file:

{
    "defines": {
        "constants": {
            "name": "Github",
            "description": "A Node.JS module, which provides an object oriented wrapper for the LinkedIn API.",
            "protocol": "https",
            "host": "api.linkedin.com",
            "port": 443,
            "dateFormat": "YYYY-MM-DDTHH:MM:SSZ",
            "requestFormat": "json"
        },
        "response-headers": [
            "X-RateLimit-Limit",
            "X-RateLimit-Remaining",
            "Link"
        ],
        "params": {
            "url-field-selector": {
                "type": "String",
                "required": true,
                "validation": "",
                "invalidmsg": "",
                "description": "Explicitly request the data you want, more details here : https://developer.linkedin.com/documents/understanding-field-selectors"
            },
            "id": {
                "type": "String",
                "required": true,
                "validation": "",
                "invalidmsg": "",
                "description": "A unique identifier token for this member."
            },
        }
    },

    "people": {
        "get-current": {
            "url": "/people/~",
            "method": "GET",
            "params": {
                "$url-field-selector": null,
                "$secure-urls": null
            }
        },

        "get-member": {
            "url": "/people/",
            "method": "GET",
            "params": {
                "$id": null,
                "$url": null,
                "$url-field-selector": null,
                "$secure-urls": null,
            }
        }
    }
 }

You probably noticed that the definition is quite verbose and the decision for its design was made to be verbose whilst still allowing for basic variable definitions and substitions for request parameters.

There are two sections; 'defines' and 'people' in this example.

The defines section contains a list of constants that will be used by the Linkedin to make requests to the right URL that hosts the API. The people section defines the endpoints for calls to the API server, for people specifically in this example, but the other API sections are defined in the exact same way. These definitions are parsed and methods are created that the client can call to make an HTTP request to the server. there is one endpoint defined: . In this example, the endpoint people/get-current may be invoked with

var Linkedin = require('node-linked-in');

var cfg = {version: "1", pathPrefix:"v1"};
var linkedin = new Linkedin(cfg);
// oauth2 authentication then:      
linkedin.authenticate({
  type: "oauth",
  token: accessToken
});

linkedin.getCurrent({}, function(err, ret) {
    // do something with the result here.
});

// or to fetch a specfic member:
linkedin.getMember({
    "id": "abcde"
}, function(err, ret) {
    // do something with the result here.
});

All the parameters as specified in the Object that is passed to the function as first argument, will be validated according to the rules in the params block of the route definition. Thus, in the case of the id parameter, according to the definition in the params block, it's a variable that first needs to be looked up in the params block of the defines section (at the top of the JSON file). Params that start with a $ sign will be substituted with the param with the same name from the defines/params section. There we see that it is a required parameter (needs to hold a value). In other words, if the validation requirements are not met, an HTTP error is passed as first argument of the callback.

Instance methods

instance method

Linkedin#authenticate

    • Linkedin#authenticate(options)
    • options
      • Object

    • Object containing the authentication type and credentials

    • token
      • String

    • OAuth2 token

Set an authentication method to have access to protected resources.

Example
linkedin.authenticate({
    token: "e5a4a27487c26e571892846366de023349321a73"
});