Namespace | http://www.mulesoft.org/schema/mule/linkedin |
---|---|
Schema Location | http://www.mulesoft.org/schema/mule/linkedin/current/mule-linkedin.xsd (View Schema) |
Schema Version | 1.0 |
Minimum Mule Version | 3.2 |
LinkedIn is a business-related social networking site. Founded in December 2002 and launched in May 2003, it is mainly used for professional networking. This connector allows you to interact with LinkedIn API.
Configuration | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Configure an instance of this module
|
To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:
<mule xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:linkedin="http://www.mulesoft.org/schema/mule/linkedin" xsi:schemaLocation=" http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd http://www.mulesoft.org/schema/mule/linkedin http://www.mulesoft.org/schema/mule/linkedin/current/mule-linkedin.xsd"> <!-- here goes your flows and configuration elements --> </mule>
This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.
Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.
Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Type | Name | Default Value | Description | Java Type | MIME Type | Encoding | Optional. Give a name to this configuration so it can be later referenced. | ||||
API Key | |||||||||||
API Secret | |||||||||||
r_basicprofile+r_emailaddress | Optional. LinkedIn permissions | ||||||||||
https://api.linkedin.com/uas/oauth/authorize | Optional. The URL defined by the Service Provider where the resource owner will be redirected to grant authorization to the connector | ||||||||||
https://api.linkedin.com/uas/oauth/accessToken | Optional. The URL defined by the Service Provider to obtain an access token | ||||||||||
https://api.linkedin.com/uas/oauth/requestToken | Optional. The URL defined by the Service Provider used to obtain an un-authorized request token |
This connector uses OAuth1 as an authorization and authentication mechanism.
Authorizing the connector is a simple process of calling:
<linkedin:authorize/>
The call to authorize message processor must be made from a message coming from an HTTP inbound endpoint as the authorize process will reply with a redirect to the service provider. The following is an example of how to use it in a flow with an HTTP inbound endpoint:
<flow name="authorizationAndAuthenticationFlow"> <http:inbound-endpoint host="localhost" port="8080" path="oauth-authorize"/> <linkedin:authorize/> </flow>
If you hit that endpoint via a web-browser it will initiate the OAuth dance, redirecting the user to the service provider page and creating a callback endpoint so the service provider can call us back once the user has been authenticated. Once the callback gets called then the connector will switch to an authorized state and any message processor or source that requires authentication can be called.
The authorize message processor supports the following attributes:
Authorize Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Name | Default Value | Description | |||||||||
https://api.linkedin.com/uas/oauth/authorize | Optional. The URL defined by the Service Provider where the resource owner will be redirected to grant authorization to the connector | ||||||||||
https://api.linkedin.com/uas/oauth/accessToken | Optional. The URL defined by the Service Provider to obtain an access token | ||||||||||
https://api.linkedin.com/uas/oauth/requestToken | Optional. The URL defined by the Service Provider used to obtain an un-authorized request token |
The authorize message processor is an intercepting one. If something that requires authentication is requested but the connector is not authorized yet, the authorize message processor will be triggered. It will redirect the user to the service provider so that he can authorize the connector. This is why the authorize message processor needs to be behind an http:inbound-endpoint. Once authentication and authorization are successful, the service provider will respond to the connector with a callback. The connector will extract information from this callback, set its own internal state to authorized, and then move on to executing anything that had been interrupted by the authorization method.
<flow name="authorizationAndAuthenticationFlow"> <http:inbound-endpoint host="localhost" port="8080" path="oauth-authorize"/> <linkedin:authorize/> <http:response-builder status="200"> <set-payload value="You have successfully authorized the connector"/> </http:response-builder> </flow>
In the above example we added the http:response-builder (keep in mind that this element is available only in Mule 3.3.0 and later). If the connector is not yet authorized, the execution of the response builder will be delayed until the callback is received.
On the other hand, if the connector had already been authorized before, then the flow execution will not be delayed; it will continue and the http:response-builder will get executed right away rather than after the callback.
If for any reason, an errors ocurrs while processing the callback, the exception strategy of the flow containing the authorize will be executed. So, if the callback sent the wrong information you can handle that situation by setting up an exception strategy as follows:
<flow name="authorizationAndAuthenticationFlow"> <http:inbound-endpoint host="localhost" port="8080" path="oauth-authorize"/> <linkedin:authorize/> <http:response-builder status="200"> <set-payload value="You have successfully authorized the connector"/> </http:response-builder> <catch-exception-strategy> <http:response-builder status="404"> <set-payload value="An error has occurred authorizing the connector"/> </http:response-builder> </catch-exception-strategy> </flow>
What happens if a tenant who is not yet authorized wants to perform an OAuth protected operation? You can set this with the onNoToken property:
<google-calendars:config-with-oauth name="google-calendars" consumerKey="${google.apiclient}" consumerSecret="${google.apisecret}" onNoToken="[STOP_FLOW|EXCEPTION]"> <google-calendars:oauth-callback-config connector-ref="${oauth.http.connector}" domain="${oauth.url}" localPort="${https.port}" async="false" path="oauth2callback" /> </google-calendars:config-with-oauth>
The onNoToken property can be set to two different values:
Once this connector has been authorized further calls to the authorize message processor will be no-ops. If you wish to reset the state of the connector back to a non-authorized state you can call:
<linkedin:unauthorize/>
Keep in mind that after the connector is unauthorized all future calls that attempt to access protected resources will fail until the connector is re-authorized.
As mentioned earlier, once authorize gets called and before we redirect the user to the service provider, we create a callback endpoint. The callback endpoint will get called automatically by the service provider once the user is authenticated and he grants authorization to the connector to access his private information.
The callback can be customized in the config element of the this connector as follows:
<linkedin:config> <linkedin:oauth-callback-config domain="${fullDomain}" localPort="${http.port}" remotePort="80"/> </linkedin:config>
The oauth-callback-config element can be used to customize the endpoint that gets created for the callback. It features the following attributes:
OAuth Callback Config Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Name | Description | ||||||||||
Optional. Reference to a user-defined HTTP connector. | |||||||||||
Optional. The domain portion of the callback URL. This is usually something like xxx.cloudhub.io if you are deploying to CloudHub for example. | |||||||||||
Optional. The local port number that the endpoint will listen on. Normally 80, in the case of CloudHub you can use the environment variable ${http.port}. | |||||||||||
Optional. This is the port number that we will tell the service provider we are listening on. It is usually the same as localPort but it is separated in case your deployment features port forwarding or a proxy. | |||||||||||
Optional. Path under which the callback should be exposed. If not specified a random path will be generated. |
The example shown above is what the configuration would look like if your app would be deployed to CloudHub.
Once the service providers hits the callback it will do so in way that state information it is also sent. This state information is later used by the connector on each call made to the service provider to let him know that we have completed the authorization and authentication process.
The state information is currently held in-memory but the connector offers hooks to save/restore this state. The ammount of information that needs to be saved and/or restored varies between version of the OAuth specification. At the bare minimum for OAuth 1.0a that needs to be the OAuth access token and OAuth access token secret.
The following is an example of how to log the access token and access token secret.
<linkedin:config> <linkedin:oauth-save-access-token> <logger level="INFO" message="Received access token #[variable:OAuthAccessToken] and #[variable:OAuthAccessTokenSecret]"/> </linkedin:oauth-save-access-token> </linkedin:config>
The oauth-save-access-token is a message processor chain and you can add inside of it as many message processors as you want. The chain will be called with special inbound properties in the message which the information that needs saved.
Restoring the information is equally simple:
<linkedin:config> <linkedin:oauth-restore-access-token> <message-properties-transformer scope="invocation"> <add-message-property key="OAuthAccessToken" value="123"/> <add-message-property key="OAuthAccessTokenSecret" value="567"/> </message-properties-transformer> </linkedin:oauth-restore-access-token> </linkedin:config>
The example above does not do anything useful expect hardcode the access token and the token secret to 123 and 567 respectively. Just like oauth-save-access-token, oauth-restore-access-token is another message processor chain. Once the chain is done executing we will extract the OAuth access token property and OAuth access token secret property values.
The following shows a full example on how to save and restore using Mule ObjectStore Module to store the information inside an object store.
<mule xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:linkedin="http://www.mulesoft.org/schema/mule/linkedin" xmlns:objectstore="http://www.mulesoft.org/schema/mule/objectstore" xsi:schemaLocation=" http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd http://www.mulesoft.org/schema/mule/objectstore http://www.mulesoft.org/schema/mule/objectstore/1.0/mule-objectstore.xsd http://www.mulesoft.org/schema/mule/linkedin http://www.mulesoft.org/schema/mule/linkedin/current/mule-linkedin.xsd"> <linkedin:config> <linkedin:oauth-save-access-token> <objectstore:store key="OAuthAccessToken" value-ref="#[variable:OAuthAccessToken]"/> <objectstore:store key="OAuthAccessTokenSecret" value-ref="#[variable:OAuthAccessTokenSecret]"/> </linkedin:oauth-save-access-token> <linkedin:oauth-restore-access-token> <enricher target="#[header:OAuthAccessToken]"> <objectstore:retrieve key="OAuthAccessToken"/> </enricher> <enricher target="#[header:OAuthAccessTokenSecret]"> <objectstore:retrieve key="OAuthAccessTokenSecret"/> </enricher> </linkedin:oauth-restore-access-token> </linkedin:config> </mule>
Gets the connections by id. For details see http://developer.linkedin.com/docs/DOC-1004
<linkedin:get-connections-by-id id="some-id" start="10" count="20" modificationDate="2011-08-20T00:00:00-00:00" modificationType="NEW"> <linkedin:profile-fields> <linkedin:profile-field>LAST_NAME</linkedin:profile-field> <linkedin:profile-field>HONORS</linkedin:profile-field> </linkedin:profile-fields> </linkedin:get-connections-by-id>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id to search | String | */* | UTF-8 | ||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
Optional. The modification date, if set modification type needs to be specified | Date | */* | |||
Optional. The modification type, if set modification date needs to be specified | ConnectionModificationType | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The profile fields to retrieve | List<ProfileField> |
Return Type | Description |
---|---|
Connections | the connections by id |
Gets the connections by url. For details see http://developer.linkedin.com/docs/DOC-1004
<linkedin:get-connections-by-url url="some-url" start="10" count="20" modificationDate="2011-08-20T00:00:00-00:00" modificationType="NEW"> <linkedin:profile-fields> <linkedin:profile-field>LAST_NAME</linkedin:profile-field> <linkedin:profile-field>HONORS</linkedin:profile-field> </linkedin:profile-fields> </linkedin:get-connections-by-url>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The url to search | String | */* | UTF-8 | ||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
Optional. The modification date, if set modification type needs to be specified | Date | */* | |||
Optional. The modification type, if set modification date needs to be specified | ConnectionModificationType | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The profile fields to retrieve | List<ProfileField> |
Return Type | Description |
---|---|
Connections | the connections by url |
Gets the connections for current user. For details see http://developer.linkedin.com/docs/DOC-1004
<linkedin:get-connections-for-current-user start="10" count="20" modificationDate="2011-08-20T00:00:00-00:00" modificationType="NEW"> <linkedin:profile-fields> <linkedin:profile-field>LAST_NAME</linkedin:profile-field> <linkedin:profile-field>HONORS</linkedin:profile-field> </linkedin:profile-fields> </linkedin:get-connections-for-current-user>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
Optional. The modification date, if set modification type needs to be specified | Date | */* | |||
Optional. The modification type, if set modification date needs to be specified | ConnectionModificationType | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The profile fields to retrieve | List<ProfileField> |
Return Type | Description |
---|---|
Connections | the connections for current user |
Gets the network update comments. For details see http://developer.linkedin.com/docs/DOC-1043
<linkedin:get-network-update-comments networkUpdateId="some-network-update-id"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The network update id to search | String | */* | UTF-8 |
Return Type | Description |
---|---|
UpdateComments | the network update comments |
Gets the network update likes. For details see http://developer.linkedin.com/docs/DOC-1043
<linkedin:get-network-update-likes networkUpdateId="some-network-update-id"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The network update id to search | String | */* | UTF-8 |
Return Type | Description |
---|---|
Likes | the network update likes |
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006
<linkedin:get-network-updates start="10" count="20" showHiddenMembers="true" startDate="2011-08-10T00:00:00-00:00" endDate="2011-08-10T00:00:00-00:00"> <linkedin:update-types> <linkedin:update-type>PROFILE_UPDATE</linkedin:update-type> <linkedin:update-type>RECOMMENDATION_UPDATE</linkedin:update-type> </linkedin:update-types> </linkedin:get-network-updates>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
Optional. The start date, if set end date needs to be specified | Date | */* | |||
Optional. The end date, if set start date needs to be specified | Date | */* | |||
Optional. Whether to show hidden memberts | Boolean | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The update types to retrieve | List<NetworkUpdateType> |
Return Type | Description |
---|---|
Network | the network updates |
Gets the profile by id. For details see http://developer.linkedin.com/docs/DOC-1002
<linkedin:get-profile-by-id id="some-id"> <linkedin:profile-fields> <linkedin:profile-field>LAST_NAME</linkedin:profile-field> <linkedin:profile-field>HONORS</linkedin:profile-field> </linkedin:profile-fields> </linkedin:get-profile-by-id>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id to search | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The profile fields to retrieve | List<ProfileField> |
Return Type | Description |
---|---|
Person | the profile by id |
Gets the profile by url. For details see http://developer.linkedin.com/docs/DOC-1002
<linkedin:get-profile-by-url url="some-url" profileType="STANDARD"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The url to search | String | */* | UTF-8 | ||
The profile type to search | ProfileType | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The profile fields to retrieve | List<ProfileField> |
Return Type | Description |
---|---|
Person | the profile by url |
Gets the profile for current user. For details see http://developer.linkedin.com/docs/DOC-1002
<linkedin:get-profile-for-current-user> <linkedin:profile-fields> <linkedin:profile-field>LAST_NAME</linkedin:profile-field> <linkedin:profile-field>HONORS</linkedin:profile-field> </linkedin:profile-fields> </linkedin:get-profile-for-current-user>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The profile fields to retrieve | List<ProfileField> |
Return Type | Description |
---|---|
Person | the profile for current user |
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006
<linkedin:get-user-updates start="10" count="20" startDate="2011-08-10T00:00:00-00:00" endDate="2011-08-10T00:00:00-00:00"> <linkedin:update-types> <linkedin:update-type>PROFILE_UPDATE</linkedin:update-type> <linkedin:update-type>RECOMMENDATION_UPDATE</linkedin:update-type> </linkedin:update-types> </linkedin:get-user-updates>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
Optional. The start date, if set end date needs to be specified | Date | */* | |||
Optional. The end date, if set start date needs to be specified | Date | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The update types to retrieve | List<NetworkUpdateType> |
Return Type | Description |
---|---|
Network | the network updates |
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006
<linkedin:get-user-updates-by-id id="some-id" start="10" count="20" startDate="2011-08-10T00:00:00-00:00" endDate="2011-08-10T00:00:00-00:00"> <linkedin:update-types> <linkedin:update-type>PROFILE_UPDATE</linkedin:update-type> <linkedin:update-type>RECOMMENDATION_UPDATE</linkedin:update-type> </linkedin:update-types> </linkedin:get-user-updates-by-id>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id to search | String | */* | UTF-8 | ||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
Optional. The start date, if set end date needs to be specified | Date | */* | |||
Optional. The end date, if set end date needs to be specified | Date | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The update types to retrieve | List<NetworkUpdateType> |
Return Type | Description |
---|---|
Network | the network updates |
Like post. For details see http://developer.linkedin.com/docs/DOC-1043
<linkedin:like-post networkUpdateId="some-network-update-id"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The network update id | String | */* | UTF-8 |
Post comment. For details see http://developer.linkedin.com/docs/DOC-1043
<linkedin:post-comment networkUpdateId="some-network-update-id" commentText="some-comment-text"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The network update id | String | */* | UTF-8 | ||
The comment text | String | */* | UTF-8 |
Post network update. For details see http://developer.linkedin.com/docs/DOC-1009
<linkedin:post-network-update updateText="some-update-text"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The update text | String | */* | UTF-8 |
Post share. For details see http://developer.linkedin.com/docs/DOC-1212
<linkedin:post-share commentText="some-comment" title="some-title" url="some-url" imageUrl="some-image-url" visibility="ALL_MEMBERS" postToTwitter="true"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The comment text | String | */* | UTF-8 | ||
The title | String | */* | UTF-8 | ||
The url | String | */* | UTF-8 | ||
The image url | String | */* | UTF-8 | ||
The visibility | LinkedInVisibilityType | */* | |||
false | Optional. Whether to post to twitter | Boolean | */* |
Re-share. For details see http://developer.linkedin.com/docs/DOC-1212
<linkedin:re-share shareId="some-share-id" commentText="some-comment" visibility="ALL_MEMBERS"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The share id | String | */* | UTF-8 | ||
The comment text | String | */* | UTF-8 | ||
The visibility | LinkedInVisibilityType | */* |
Search people. For details see http://developer.linkedin.com/docs/DOC-1005
<linkedin:search-people start="10" count="20" sortOrder="RECOMMENDERS"> <linkedin:search-parameters> <linkedin:search-parameter key="CURRENT_COMPANY">MuleSoft</linkedin:search-parameter> <linkedin:search-parameter key="TITLE">Engineer</linkedin:search-parameter> </linkedin:search-parameters> <linkedin:profile-fields> <linkedin:profile-field>LAST_NAME</linkedin:profile-field> <linkedin:profile-field>HONORS</linkedin:profile-field> </linkedin:profile-fields> </linkedin:search-people>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
RELEVANCE | Optional. The sort order to use, defaults to RELEVANCE | SearchSortOrder | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
Optional. The search parameters to use | Map<SearchParameter, String> | ||
Optional. The profile fields to retriee | List<ProfileField> |
Return Type | Description |
---|---|
People | the people |
Search people. For details see http://developer.linkedin.com/docs/DOC-1005
<linkedin:search-people-with-facet-fields start="10" count="20" sortOrder="RECOMMENDERS"> <linkedin:search-parameters> <linkedin:search-parameter key="CURRENT_COMPANY">MuleSoft</linkedin:search-parameter> <linkedin:search-parameter key="TITLE">Engineer</linkedin:search-parameter> </linkedin:search-parameters> <linkedin:profile-fields> <linkedin:profile-field>LAST_NAME</linkedin:profile-field> <linkedin:profile-field>HONORS</linkedin:profile-field> </linkedin:profile-fields> <linkedin:facet-fields> <linkedin:facet-field>BUCKET_NAME</linkedin:facet-field> <linkedin:facet-field>BUCKET_CODE</linkedin:facet-field> </linkedin:facet-fields> <linkedin:facets> <linkedin:facet key="INDUSTRY">Software</linkedin:facet> <linkedin:facet key="PAST_COMPANY">MuleSource</linkedin:facet> </linkedin:facets> </linkedin:search-people-with-facet-fields>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
RELEVANCE | Optional. The sort order, defaults to RELEVANCE | SearchSortOrder | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
The search parameters | Map<SearchParameter, String> | ||
The profile fields to retrieve | List<ProfileField> | ||
The facet fields to use | List<FacetField> | ||
Optional. The facets to use | Map<FacetType, String> |
Return Type | Description |
---|---|
PeopleSearch | the people |
Search people. For details see http://developer.linkedin.com/docs/DOC-1005
<linkedin:search-people-with-facets start="10" count="20" sortOrder="RECOMMENDERS"> <linkedin:search-parameters> <linkedin:search-parameter key="CURRENT_COMPANY">MuleSoft</linkedin:search-parameter> <linkedin:search-parameter key="TITLE">Engineer</linkedin:search-parameter> </linkedin:search-parameters> <linkedin:profile-fields> <linkedin:profile-field>LAST_NAME</linkedin:profile-field> <linkedin:profile-field>HONORS</linkedin:profile-field> </linkedin:profile-fields> <linkedin:facets> <linkedin:facet key="INDUSTRY">Software</linkedin:facet> <linkedin:facet key="PAST_COMPANY">MuleSource</linkedin:facet> </linkedin:facets> </linkedin:search-people-with-facets>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The start, if set count needs to be specified | Integer | */* | |||
Optional. The count, if set start needs to be specified | Integer | */* | |||
RELEVANCE | Optional. The sort order to use, defaults to RELEVANCE | SearchSortOrder | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
The search parameters | Map<SearchParameter, String> | ||
Optional. The profile fields to retrieve | List<ProfileField> | ||
The facet type and a comma separated string with all the values | Map<FacetType, String> |
Return Type | Description |
---|---|
People | the people |
Send invite. For details see http://developer.linkedin.com/docs/DOC-1012
<linkedin:send-invite-by-email email="some-email" firstName="some-name" lastName="some-last-name" subject="some-subject" message="some-message"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The email | String | */* | UTF-8 | ||
The first name | String | */* | UTF-8 | ||
The last name | String | */* | UTF-8 | ||
The subject | String | */* | UTF-8 | ||
The message | String | */* | UTF-8 |
Send message. For details see http://developer.linkedin.com/docs/DOC-1044
<linkedin:send-message subject="some-subject" message="some-message"> <linkedin:recepient-ids> <linkedin:recepient-id>recipientId1</linkedin:recepient-id> <linkedin:recepient-id>recipientId2</linkedin:recepient-id> </linkedin:recepient-ids> </linkedin:send-message>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The subject | String | */* | UTF-8 | ||
The message | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
The recepient ids | List<String> |
Unlike post. For details see http://developer.linkedin.com/docs/DOC-1043
<linkedin:unlike-post networkUpdateId="some-network-update-id"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The network update id | String | */* | UTF-8 |
Update current status. For details see http://developer.linkedin.com/docs/DOC-1007
<linkedin:update-current-status status="new-status" postToTwitter="true"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The status | String | */* | UTF-8 | ||
false | Optional. Whether to post the update to Twitter | Boolean | */* |