com.google.code.linkedinapi.client
Interface AsyncLinkedInApiClient

All Superinterfaces:
LinkedInAuthenticationClient, LinkedInCommunicationClient
All Known Implementing Classes:
AsyncLinkedInApiClientAdapter

public interface AsyncLinkedInApiClient
extends LinkedInAuthenticationClient

The Interface AsyncLinkedInApiClient. This interface can be used for asynchronous invocation of API methods.

Author:
Nabeel Mukhtar

Method Summary
 java.util.concurrent.Future<?> deleteCurrentStatus()
          Delete current status.
 java.util.concurrent.Future<Connections> getConnectionsById(java.lang.String id)
          Gets the connections by id.
 java.util.concurrent.Future<Connections> getConnectionsById(java.lang.String id, int start, int count)
          Gets the connections by id.
 java.util.concurrent.Future<Connections> getConnectionsById(java.lang.String id, java.util.Set<ProfileField> profileFields)
          Gets the connections by id.
 java.util.concurrent.Future<Connections> getConnectionsById(java.lang.String id, java.util.Set<ProfileField> profileFields, int start, int count)
          Gets the connections by id.
 java.util.concurrent.Future<Connections> getConnectionsByUrl(java.lang.String url)
          Gets the connections by url.
 java.util.concurrent.Future<Connections> getConnectionsByUrl(java.lang.String url, int start, int count)
          Gets the connections by url.
 java.util.concurrent.Future<Connections> getConnectionsByUrl(java.lang.String url, java.util.Set<ProfileField> profileFields)
          Gets the connections by url.
 java.util.concurrent.Future<Connections> getConnectionsByUrl(java.lang.String url, java.util.Set<ProfileField> profileFields, int start, int count)
          Gets the connections by url.
 java.util.concurrent.Future<Connections> getConnectionsForCurrentUser()
          Gets the connections for current user.
 java.util.concurrent.Future<Connections> getConnectionsForCurrentUser(int start, int count)
          Gets the connections for current user.
 java.util.concurrent.Future<Connections> getConnectionsForCurrentUser(java.util.Set<ProfileField> profileFields)
          Gets the connections for current user.
 java.util.concurrent.Future<Connections> getConnectionsForCurrentUser(java.util.Set<ProfileField> profileFields, int start, int count)
          Gets the connections for current user.
 java.util.concurrent.Future<UpdateComments> getNetworkUpdateComments(java.lang.String networkUpdateId)
          Gets the network update comments.
 java.util.concurrent.Future<Network> getNetworkUpdates()
          Gets the network updates.
 java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Date startDate, java.util.Date endDate)
          Gets the network updates.
 java.util.concurrent.Future<Network> getNetworkUpdates(int start, int count)
          Gets the network updates.
 java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Set<NetworkUpdateType> updateTypes)
          Gets the network updates.
 java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Set<NetworkUpdateType> updateTypes, java.util.Date startDate, java.util.Date endDate)
          Gets the network updates.
 java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Set<NetworkUpdateType> updateTypes, int start, int count)
          Gets the network updates.
 java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Set<NetworkUpdateType> updateTypes, int start, int count, java.util.Date startDate, java.util.Date endDate)
          Gets the network updates.
 java.util.concurrent.Future<Person> getProfileByApiRequest(ApiStandardProfileRequest apiRequest)
          Gets the profile by API request.
 java.util.concurrent.Future<Person> getProfileById(java.lang.String id)
          Gets the profile by id.
 java.util.concurrent.Future<Person> getProfileById(java.lang.String id, java.util.Set<ProfileField> profileFields)
          Gets the profile by id.
 java.util.concurrent.Future<Person> getProfileByUrl(java.lang.String url, ProfileType profileType)
          Gets the profile by url.
 java.util.concurrent.Future<Person> getProfileByUrl(java.lang.String url, ProfileType profileType, java.util.Set<ProfileField> profileFields)
          Gets the profile by url.
 java.util.concurrent.Future<Person> getProfileForCurrentUser()
          Gets the profile for current user.
 java.util.concurrent.Future<Person> getProfileForCurrentUser(java.util.Set<ProfileField> profileFields)
          Gets the profile for current user.
 java.util.concurrent.Future<?> postComment(java.lang.String networkUpdateId, java.lang.String commentText)
          Post comment.
 java.util.concurrent.Future<?> postNetworkUpdate(java.lang.String updateText)
          Post network update.
 java.util.concurrent.Future<People> searchPeople()
          Search people.
 java.util.concurrent.Future<People> searchPeople(java.util.Map<SearchParameter,java.lang.String> searchParameters)
          Search people.
 java.util.concurrent.Future<People> searchPeople(java.util.Map<SearchParameter,java.lang.String> searchParameters, int start, int count)
          Search people.
 java.util.concurrent.Future<People> searchPeople(java.util.Map<SearchParameter,java.lang.String> searchParameters, int start, int count, SearchSortOrder sortOrder)
          Search people.
 java.util.concurrent.Future<People> searchPeople(java.util.Map<SearchParameter,java.lang.String> searchParameters, SearchSortOrder sortOrder)
          Search people.
 java.util.concurrent.Future<?> sendInviteByEmail(java.lang.String email, java.lang.String firstName, java.lang.String lastName, java.lang.String subject, java.lang.String message)
          Send invite.
 java.util.concurrent.Future<?> sendInviteById(java.lang.String recepientId, java.lang.String subject, java.lang.String message, java.lang.String authHeader)
          Send invite.
 java.util.concurrent.Future<?> sendInviteToPerson(Person recepient, java.lang.String subject, java.lang.String message)
          Send invite.
 java.util.concurrent.Future<?> sendMessage(java.util.List<java.lang.String> recepientIds, java.lang.String subject, java.lang.String message)
          Send message.
 java.util.concurrent.Future<?> updateCurrentStatus(java.lang.String status)
          Update current status.
 
Methods inherited from interface com.google.code.linkedinapi.client.LinkedInAuthenticationClient
getAccessToken, getApiConsumer, setAccessToken, setApiConsumer
 
Methods inherited from interface com.google.code.linkedinapi.client.LinkedInCommunicationClient
addRequestHeader, getRequestHeaders, removeRequestHeader, setRequestHeaders
 

Method Detail

getProfileForCurrentUser

java.util.concurrent.Future<Person> getProfileForCurrentUser()
Gets the profile for current user. For details see http://developer.linkedin.com/docs/DOC-1002

Returns:
the profile for current user

getProfileById

java.util.concurrent.Future<Person> getProfileById(java.lang.String id)
Gets the profile by id. For details see http://developer.linkedin.com/docs/DOC-1002

Parameters:
id - the id
profileType - the profile type
Returns:
the profile by id

getProfileByUrl

java.util.concurrent.Future<Person> getProfileByUrl(java.lang.String url,
                                                    ProfileType profileType)
Gets the profile by url. For details see http://developer.linkedin.com/docs/DOC-1002

Parameters:
url - the url
profileType - the profile type
Returns:
the profile by url

getProfileForCurrentUser

java.util.concurrent.Future<Person> getProfileForCurrentUser(java.util.Set<ProfileField> profileFields)
Gets the profile for current user. For details see http://developer.linkedin.com/docs/DOC-1002

Parameters:
profileFields - the profile fields
Returns:
the profile for current user

getProfileById

java.util.concurrent.Future<Person> getProfileById(java.lang.String id,
                                                   java.util.Set<ProfileField> profileFields)
Gets the profile by id. For details see http://developer.linkedin.com/docs/DOC-1002

Parameters:
id - the id
profileType - the profile type
profileFields - the profile fields
Returns:
the profile by id

getProfileByUrl

java.util.concurrent.Future<Person> getProfileByUrl(java.lang.String url,
                                                    ProfileType profileType,
                                                    java.util.Set<ProfileField> profileFields)
Gets the profile by url. For details see http://developer.linkedin.com/docs/DOC-1002

Parameters:
url - the url
profileType - the profile type
profileFields - the profile fields
Returns:
the profile by url

getProfileByApiRequest

java.util.concurrent.Future<Person> getProfileByApiRequest(ApiStandardProfileRequest apiRequest)
Gets the profile by API request. For details see http://developer.linkedin.com/docs/DOC-1002

Parameters:
apiRequest - the api request
Returns:
the profile by api request

getNetworkUpdates

java.util.concurrent.Future<Network> getNetworkUpdates()
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006

Returns:
the network updates

getNetworkUpdates

java.util.concurrent.Future<Network> getNetworkUpdates(int start,
                                                       int count)
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006

Parameters:
start - the start
count - the count
Returns:
the network updates

getNetworkUpdates

java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Date startDate,
                                                       java.util.Date endDate)
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006

Parameters:
startDate - the start date
endDate - the end date
Returns:
the network updates

getNetworkUpdates

java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Set<NetworkUpdateType> updateTypes)
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006

Parameters:
updateTypes - the update types
Returns:
the network updates

getNetworkUpdates

java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Set<NetworkUpdateType> updateTypes,
                                                       int start,
                                                       int count)
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006

Parameters:
updateTypes - the update types
start - the start
count - the count
Returns:
the network updates

getNetworkUpdates

java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Set<NetworkUpdateType> updateTypes,
                                                       java.util.Date startDate,
                                                       java.util.Date endDate)
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006

Parameters:
updateTypes - the update types
startDate - the start date
endDate - the end date
Returns:
the network updates

getNetworkUpdates

java.util.concurrent.Future<Network> getNetworkUpdates(java.util.Set<NetworkUpdateType> updateTypes,
                                                       int start,
                                                       int count,
                                                       java.util.Date startDate,
                                                       java.util.Date endDate)
Gets the network updates. For details see http://developer.linkedin.com/docs/DOC-1006

Parameters:
updateTypes - the update types
start - the start
count - the count
startDate - the start date
endDate - the end date
Returns:
the network updates

getNetworkUpdateComments

java.util.concurrent.Future<UpdateComments> getNetworkUpdateComments(java.lang.String networkUpdateId)
Gets the network update comments. For details see http://developer.linkedin.com/docs/DOC-1043

Parameters:
networkUpdateId - the network update id
Returns:
the network update comments

getConnectionsForCurrentUser

java.util.concurrent.Future<Connections> getConnectionsForCurrentUser()
Gets the connections for current user. For details see http://developer.linkedin.com/docs/DOC-1004

Returns:
the connections for current user

getConnectionsById

java.util.concurrent.Future<Connections> getConnectionsById(java.lang.String id)
Gets the connections by id. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
id - the id
Returns:
the connections by id

getConnectionsByUrl

java.util.concurrent.Future<Connections> getConnectionsByUrl(java.lang.String url)
Gets the connections by url. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
url - the url
Returns:
the connections by url

getConnectionsForCurrentUser

java.util.concurrent.Future<Connections> getConnectionsForCurrentUser(java.util.Set<ProfileField> profileFields)
Gets the connections for current user. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
profileFields - the profile fields
Returns:
the connections for current user

getConnectionsById

java.util.concurrent.Future<Connections> getConnectionsById(java.lang.String id,
                                                            java.util.Set<ProfileField> profileFields)
Gets the connections by id. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
id - the id
profileFields - the profile fields
Returns:
the connections by id

getConnectionsByUrl

java.util.concurrent.Future<Connections> getConnectionsByUrl(java.lang.String url,
                                                             java.util.Set<ProfileField> profileFields)
Gets the connections by url. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
url - the url
profileFields - the profile fields
Returns:
the connections by url

getConnectionsForCurrentUser

java.util.concurrent.Future<Connections> getConnectionsForCurrentUser(int start,
                                                                      int count)
Gets the connections for current user. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
start - the start
count - the count
Returns:
the connections for current user

getConnectionsById

java.util.concurrent.Future<Connections> getConnectionsById(java.lang.String id,
                                                            int start,
                                                            int count)
Gets the connections by id. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
id - the id
start - the start
count - the count
Returns:
the connections by id

getConnectionsByUrl

java.util.concurrent.Future<Connections> getConnectionsByUrl(java.lang.String url,
                                                             int start,
                                                             int count)
Gets the connections by url. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
url - the url
start - the start
count - the count
Returns:
the connections by url

getConnectionsForCurrentUser

java.util.concurrent.Future<Connections> getConnectionsForCurrentUser(java.util.Set<ProfileField> profileFields,
                                                                      int start,
                                                                      int count)
Gets the connections for current user. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
profileFields - the profile fields
start - the start
count - the count
Returns:
the connections for current user

getConnectionsById

java.util.concurrent.Future<Connections> getConnectionsById(java.lang.String id,
                                                            java.util.Set<ProfileField> profileFields,
                                                            int start,
                                                            int count)
Gets the connections by id. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
id - the id
profileFields - the profile fields
start - the start
count - the count
Returns:
the connections by id

getConnectionsByUrl

java.util.concurrent.Future<Connections> getConnectionsByUrl(java.lang.String url,
                                                             java.util.Set<ProfileField> profileFields,
                                                             int start,
                                                             int count)
Gets the connections by url. For details see http://developer.linkedin.com/docs/DOC-1004

Parameters:
url - the url
profileFields - the profile fields
start - the start
count - the count
Returns:
the connections by url

searchPeople

java.util.concurrent.Future<People> searchPeople()
Search people. For details see http://developer.linkedin.com/docs/DOC-1005

Returns:
the future< people>

searchPeople

java.util.concurrent.Future<People> searchPeople(java.util.Map<SearchParameter,java.lang.String> searchParameters)
Search people. For details see http://developer.linkedin.com/docs/DOC-1005

Parameters:
searchParameters - the search parameters
Returns:
the future< people>

searchPeople

java.util.concurrent.Future<People> searchPeople(java.util.Map<SearchParameter,java.lang.String> searchParameters,
                                                 int start,
                                                 int count)
Search people. For details see http://developer.linkedin.com/docs/DOC-1005

Parameters:
searchParameters - the search parameters
start - the start
count - the count
Returns:
the future< people>

searchPeople

java.util.concurrent.Future<People> searchPeople(java.util.Map<SearchParameter,java.lang.String> searchParameters,
                                                 SearchSortOrder sortOrder)
Search people. For details see http://developer.linkedin.com/docs/DOC-1005

Parameters:
searchParameters - the search parameters
sortOrder - the sort order
Returns:
the future< people>

searchPeople

java.util.concurrent.Future<People> searchPeople(java.util.Map<SearchParameter,java.lang.String> searchParameters,
                                                 int start,
                                                 int count,
                                                 SearchSortOrder sortOrder)
Search people. For details see http://developer.linkedin.com/docs/DOC-1005

Parameters:
searchParameters - the search parameters
start - the start
count - the count
sortOrder - the sort order
Returns:
the future< people>

postNetworkUpdate

java.util.concurrent.Future<?> postNetworkUpdate(java.lang.String updateText)
Post network update. For details see http://developer.linkedin.com/docs/DOC-1009

Parameters:
updateText - the update text
Returns:
the future

postComment

java.util.concurrent.Future<?> postComment(java.lang.String networkUpdateId,
                                           java.lang.String commentText)
Post comment. For details see http://developer.linkedin.com/docs/DOC-1043

Parameters:
networkUpdateId - the network update id
commentText - the comment text
Returns:
the future

updateCurrentStatus

java.util.concurrent.Future<?> updateCurrentStatus(java.lang.String status)
Update current status. For details see http://developer.linkedin.com/docs/DOC-1007

Parameters:
status - the status
Returns:
the future

deleteCurrentStatus

java.util.concurrent.Future<?> deleteCurrentStatus()
Delete current status. For details see http://developer.linkedin.com/docs/DOC-1007

Returns:
the future

sendMessage

java.util.concurrent.Future<?> sendMessage(java.util.List<java.lang.String> recepientIds,
                                           java.lang.String subject,
                                           java.lang.String message)
Send message. For details see http://developer.linkedin.com/docs/DOC-1044

Parameters:
recepientIds - the recepient ids
subject - the subject
message - the message
Returns:
the future

sendInviteByEmail

java.util.concurrent.Future<?> sendInviteByEmail(java.lang.String email,
                                                 java.lang.String firstName,
                                                 java.lang.String lastName,
                                                 java.lang.String subject,
                                                 java.lang.String message)
Send invite. For details see http://developer.linkedin.com/docs/DOC-1012

Parameters:
email - the recepient email
firstName - the first name
lastName - the last name
subject - the subject
message - the message
Returns:
the future

sendInviteById

java.util.concurrent.Future<?> sendInviteById(java.lang.String recepientId,
                                              java.lang.String subject,
                                              java.lang.String message,
                                              java.lang.String authHeader)
Send invite. For details see http://developer.linkedin.com/docs/DOC-1012

To call this method one needs an auth header parameter. This can be obtained by getting ApiStandardProfileRequest.getHeaders() from Person.getApiStandardProfileRequest() and then getting the value of header with name ApplicationConstants.AUTH_HEADER_NAME.

Parameters:
recepientId - the recepient id
subject - the subject
message - the message
authHeader - the auth header
Returns:
the future

sendInviteToPerson

java.util.concurrent.Future<?> sendInviteToPerson(Person recepient,
                                                  java.lang.String subject,
                                                  java.lang.String message)
Send invite. For details see http://developer.linkedin.com/docs/DOC-1012

To call this method one needs an auth header parameter. This can be obtained by getting ApiStandardProfileRequest.getHeaders() from Person.getApiStandardProfileRequest() and then getting the value of header with name ApplicationConstants.AUTH_HEADER_NAME.

Parameters:
recepient - the recepient
subject - the subject
message - the message
Returns:
the future