ConnectedUserServiceLocal (Cyclos 4.16.19 Scripting API Documentation)

All Superinterfaces:

ConnectedUserService, Service
```
public interface ConnectedUserServiceLocal
extends ConnectedUserService
```
Local interface for ConnectedUserService

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`Map<Role,Integer>`	`countConnectedUsers(Set<Role> roles, boolean forSessionData)`	Counts the connected users.
`int`	`countConnectedUsers(Role role)`	Deprecated. use `countConnectedUsers(Set, boolean)` instead
`int`	`disconnectUserAndOperators(User user)`	Disconnects a user and all his operators
`boolean`	`isOnline(BasicUser user)`	checks if this user is online.
`void`	`notifySessionsOfPermissionChange(ProductOwner productOwner)`	Notify each session belonging to the given user or group that the permissions have changed

Methods inherited from interface org.cyclos.services.users.ConnectedUserService
disconnect, disconnectBySessionTokens, getSearchData, search

- Method Detail
  - countConnectedUsers
```
@Deprecated
int countConnectedUsers(Role role)
```
    Deprecated.
    use countConnectedUsers(Set, boolean) instead
    
    Counts visible connected users with the given role
  - countConnectedUsers
```
Map<Role,Integer> countConnectedUsers(Set<Role> roles,
                                            boolean forSessionData)
```
    Counts the connected users. Only accept basic roles, as perRole.isBasic(). If roles is empty or null, returns for all basic roles. if forSessionData is true, applies the visibility constraints of the logged user. Guarantees that the returned map contains an entry for each requested role.
  - disconnectUserAndOperators
```
int disconnectUserAndOperators(User user)
```
    Disconnects a user and all his operators
  - isOnline
```
boolean isOnline(BasicUser user)
```
    checks if this user is online.
    
    Returns:
    
    true if the user is the LoggedUser; false if the loggedUser has no permission to view who's online; for other users it returns true if the requested user has a session which is not yet expired.
  - notifySessionsOfPermissionChange
```
void notifySessionsOfPermissionChange(ProductOwner productOwner)
```
    Notify each session belonging to the given user or group that the permissions have changed