Package sfs3.client.entities.managers

Interface IUserManager

All Known Implementing Classes:
SFSUserManager
public interface IUserManager
The IUserManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer User entities.

In the SmartFoxServer 3 client API this interface is implemented by the SFSUserManager class. Read the class description for additional informations.

See Also:

  • Method Details

    • containsUserName

      boolean containsUserName(String userName)
      Indicates whether a user exists in the local users list or not from the name.
      Parameters:
      userName - The name of the user whose presence in the users list is to be tested.
      Returns:
      true if the passed user exists in the users list.
      See Also:

    • containsUserId

      boolean containsUserId(int userId)
      Indicates whether a user exists in the local users list or not from the id.
      Parameters:
      userId - The id of the user whose presence in the users list is to be tested.
      Returns:
      true if the passed user exists in the users list.
      See Also:

    • containsUser

      boolean containsUser(User user)
      Indicates whether a user exists in the local users list or not.
      Parameters:
      user - The User object representing the user whose presence in the users list is to be tested.
      Returns:
      true if the passed user exists in the users list.

    • getUserByName

      User getUserByName(String userName)
      Retrieves a User object from its name property.
      Parameters:
      userName - The name of the user to be found.
      Returns:
      The User object representing the user, or null if no user with the passed name exists in the local users list.
      See Also:

    • getUserById

      User getUserById(int userId)
      Retrieves a User object from its id property.
      Parameters:
      userId - The id of the user to be found.
      Returns:
      The User object representing the user, or null if no user with the passed id exists in the local users list.
      See Also:

    • addUser

      void addUser(User user)
      Internal

    • removeUser

      void removeUser(User user)
      Internal

    • removeUserById

      void removeUserById(int id)
      Internal

    • getUserCount

      int getUserCount()
      Returns the total number of users in the local users list.

    • getUserList

      List<User> getUserList()
      Get the whole list of users inside the Rooms joined by the client.
      Returns:
      The list of User objects representing the users in the local users list.

    • getSmartFox

      ISmartFox getSmartFox()
      Internal