Package 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 Details

    • listUsersByIds

      List<UserV2> listUsersByIds(@Nonnull List<Long> uidList, @Nullable Boolean local, @Nullable 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:

    • listUsersByIds

      List<UserV2> listUsersByIds(@Nonnull List<Long> uidList)
      UserService.listUsersByIds(List)
      Parameters:
      uidList - List of user ids
      Returns:
      Users found by user ids
      See Also:

    • listUsersByEmails

      List<UserV2> listUsersByEmails(@Nonnull List<String> emailList, @Nullable Boolean local, @Nullable 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:

    • listUsersByEmails

      List<UserV2> listUsersByEmails(@Nonnull List<String> emailList)
      UserService.listUsersByEmails(List)
      Parameters:
      emailList - List of emails
      Returns:
      Users found by emails
      See Also:

    • listUsersByUsernames

      List<UserV2> listUsersByUsernames(@Nonnull List<String> usernameList, @Nullable 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:

    • listUsersByUsernames

      List<UserV2> listUsersByUsernames(@Nonnull List<String> usernameList)
      UserService.listUsersByUsernames(List)
      Parameters:
      usernameList - List of usernames
      Returns:
      Users found by usernames
      See Also:

    • searchUsers

      List<UserV2> searchUsers(@Nonnull UserSearchQuery query, @Nullable 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:

    • searchUsers

      List<UserV2> searchUsers(@Nonnull UserSearchQuery query, @Nullable 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:

    • searchAllUsers

      @API(status=EXPERIMENTAL) Stream<UserV2> searchAllUsers(@Nonnull UserSearchQuery query, @Nullable 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:

    • searchAllUsers

      @API(status=EXPERIMENTAL) Stream<UserV2> searchAllUsers(@Nonnull UserSearchQuery query, @Nullable 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:

    • followUser

      void followUser(@Nonnull List<Long> followerIds, @Nonnull 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:

    • unfollowUser

      void unfollowUser(@Nonnull List<Long> followerIds, @Nonnull 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: