com.symphony.bdk.core.service.user

Interface OboUserService

All Known Implementing Classes:

UserService

@API(status=STABLE)
public interface OboUserService

Service interface exposing OBO-enabled endpoints to manage users.

Method Summary

Modifier and Type	Method and Description
void	followUser(java.util.List<java.lang.Long> followerIds, java.lang.Long userId) Make a list of users to start following a specific user.
java.util.List<UserV2>	listUsersByEmails(java.util.List<java.lang.String> emailList) UserService.listUsersByEmails(List)
java.util.List<UserV2>	listUsersByEmails(java.util.List<java.lang.String> emailList, java.lang.Boolean local, java.lang.Boolean active) UserService.listUsersByEmails(List, Boolean, Boolean)
java.util.List<UserV2>	listUsersByIds(java.util.List<java.lang.Long> uidList) UserService.listUsersByIds(List)
java.util.List<UserV2>	listUsersByIds(java.util.List<java.lang.Long> uidList, java.lang.Boolean local, java.lang.Boolean active) UserService.listUsersByIds(List, Boolean, Boolean)
java.util.List<UserV2>	listUsersByUsernames(java.util.List<java.lang.String> usernameList) UserService.listUsersByUsernames(List)
java.util.List<UserV2>	listUsersByUsernames(java.util.List<java.lang.String> usernameList, java.lang.Boolean active) UserService.listUsersByUsernames(List, Boolean)
java.util.stream.Stream<UserV2>	searchAllUsers(UserSearchQuery query, java.lang.Boolean local) UserService.searchAllUsers(UserSearchQuery, Boolean)
java.util.stream.Stream<UserV2>	searchAllUsers(UserSearchQuery query, java.lang.Boolean local, StreamPaginationAttribute pagination) UserService.searchAllUsers(UserSearchQuery, Boolean, StreamPaginationAttribute)
java.util.List<UserV2>	searchUsers(UserSearchQuery query, java.lang.Boolean local) UserService.searchUsers(UserSearchQuery, Boolean)
java.util.List<UserV2>	searchUsers(UserSearchQuery query, java.lang.Boolean local, PaginationAttribute pagination) UserService.searchUsers(UserSearchQuery, Boolean, PaginationAttribute)
void	unfollowUser(java.util.List<java.lang.Long> followerIds, java.lang.Long userId) Make a list of users to stop following a specific user.

Method Detail

listUsersByIds

java.util.List<UserV2> listUsersByIds(@Nonnull
                                      java.util.List<java.lang.Long> uidList,
                                      @Nullable
                                      java.lang.Boolean local,
                                      @Nullable
                                      java.lang.Boolean active)

UserService.listUsersByIds(List, Boolean, Boolean)

Parameters:

uidList - List of user ids

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

active - If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned

Returns:

Users found by user ids

See Also:

Users Lookup V3

listUsersByIds

java.util.List<UserV2> listUsersByIds(@Nonnull
                                      java.util.List<java.lang.Long> uidList)

UserService.listUsersByIds(List)

Parameters:

uidList - List of user ids

Returns:

Users found by user ids

See Also:

Users Lookup V3

listUsersByEmails

java.util.List<UserV2> listUsersByEmails(@Nonnull
                                         java.util.List<java.lang.String> emailList,
                                         @Nullable
                                         java.lang.Boolean local,
                                         @Nullable
                                         java.lang.Boolean active)

UserService.listUsersByEmails(List, Boolean, Boolean)

Parameters:

emailList - List of emails

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

active - If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned

Returns:

Users found by emails.

See Also:

Users Lookup V3

listUsersByEmails

java.util.List<UserV2> listUsersByEmails(@Nonnull
                                         java.util.List<java.lang.String> emailList)

UserService.listUsersByEmails(List)

Parameters:

emailList - List of emails

Returns:

Users found by emails

See Also:

Users Lookup V3

listUsersByUsernames

java.util.List<UserV2> listUsersByUsernames(@Nonnull
                                            java.util.List<java.lang.String> usernameList,
                                            @Nullable
                                            java.lang.Boolean active)

UserService.listUsersByUsernames(List, Boolean)

Parameters:

usernameList - List of usernames

active - If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned

Returns:

Users found by usernames

See Also:

Users Lookup V3

listUsersByUsernames

java.util.List<UserV2> listUsersByUsernames(@Nonnull
                                            java.util.List<java.lang.String> usernameList)

UserService.listUsersByUsernames(List)

Parameters:

usernameList - List of usernames

Returns:

Users found by usernames

See Also:

Users Lookup V3

searchUsers

java.util.List<UserV2> searchUsers(@Nonnull
                                   UserSearchQuery query,
                                   @Nullable
                                   java.lang.Boolean local)

UserService.searchUsers(UserSearchQuery, Boolean)

Parameters:

query - Searching query containing complicated information like title, location, company...

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

Returns:

List of users found by query

See Also:

Search Users

searchUsers

java.util.List<UserV2> searchUsers(@Nonnull
                                   UserSearchQuery query,
                                   @Nullable
                                   java.lang.Boolean local,
                                   @Nonnull
                                   PaginationAttribute pagination)

UserService.searchUsers(UserSearchQuery, Boolean, PaginationAttribute)

Parameters:

query - Searching query containing complicated information like title, location, company...

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

pagination - The skip and limit for pagination.

Returns:

List of users found by query

See Also:

Search Users

searchAllUsers

@API(status=EXPERIMENTAL)
java.util.stream.Stream<UserV2> searchAllUsers(@Nonnull
                                                                         UserSearchQuery query,
                                                                         @Nullable
                                                                         java.lang.Boolean local)

UserService.searchAllUsers(UserSearchQuery, Boolean)

Parameters:

query - Searching query containing complicated information like title, location, company...

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

Returns:

a Stream of users found by query

See Also:

Search Users

searchAllUsers

@API(status=EXPERIMENTAL)
java.util.stream.Stream<UserV2> searchAllUsers(@Nonnull
                                                                         UserSearchQuery query,
                                                                         @Nullable
                                                                         java.lang.Boolean local,
                                                                         @Nonnull
                                                                         StreamPaginationAttribute pagination)

UserService.searchAllUsers(UserSearchQuery, Boolean, StreamPaginationAttribute)

Parameters:

query - Searching query containing complicated information like title, location, company...

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

pagination - The chunkSize and totalSize for pagination.

Returns:

a Stream of users found by query

See Also:

Search Users

followUser

void followUser(@Nonnull
                java.util.List<java.lang.Long> followerIds,
                @Nonnull
                java.lang.Long userId)

Make a list of users to start following a specific user. UserService.followUser(List, Long)

Parameters:

followerIds - List of ids of the followers.

userId - The id of the user to be followed.

See Also:

Follow User

unfollowUser

void unfollowUser(@Nonnull
                  java.util.List<java.lang.Long> followerIds,
                  @Nonnull
                  java.lang.Long userId)

Make a list of users to stop following a specific user. UserService.unfollowUser(List, Long)

Parameters:

followerIds - List of the ids of the followers.

userId - The id of the user to be unfollowed.

See Also:

Unfollow User