UserService (eXo Add-on:: Chat Client Server Common 2.3.3 API)

```
public interface UserService
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANONIM_USER`
`static String`	`PREFERRED_NOTIFICATION`
`static String`	`PREFERRED_NOTIFICATION_TRIGGER`
`static String`	`PREFERRED_ROOM_NOTIFICATION_TRIGGER`
`static String`	`STATUS_AVAILABLE`
`static String`	`STATUS_AWAY`
`static String`	`STATUS_DONOTDISTURB`
`static String`	`STATUS_INVISIBLE`
`static String`	`STATUS_OFFLINE`
`static String`	`STATUS_SPACE`
`static String`	`STATUS_TEAM`
`static String`	`SUPPORT_USER`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addFavorite(String user, String room)`
`void`	`addTeamRoom(String user, String teamRoomId)`
`void`	`addTeamUsers(String teamRoomId, List<String> users)`
`void`	`addUserEmail(String user, String email)`
`void`	`addUserFullName(String user, String fullname)`
`int`	`getNumberOfUsers()`
`RoomBean`	`getRoom(String user, String roomId)`
`List<SpaceBean>`	`getSpaces(String user)`
`String`	`getStatus(String user)`
`List<RoomBean>`	`getTeams(String user)`
`UserBean`	`getUser(String user)`
`UserBean`	`getUser(String user, boolean withFavorites)`
`NotificationSettingsBean`	`getUserDesktopNotificationSettings(String user)`
`String`	`getUserFullName(String user)`
`List<UserBean>`	`getUsers(String roomId)`
`List<UserBean>`	`getUsers(String filter, boolean fullBean)`
`List<UserBean>`	`getUsers(String roomId, String filter, int limit)`
`List<String>`	`getUsersFilterBy(String user, String room, String type)`
`List<UserBean>`	`getUsersInRoomChatOneToOne(String roomId)`
`boolean`	`isAdmin(String user)`
`boolean`	`isFavorite(String user, String targetUser)`
`void`	`removeFavorite(String user, String room)`
`void`	`removeTeamUsers(String teamRoomId, List<String> users)`
`void`	`setAsAdmin(String user, boolean isAdmin)`
`void`	`setNotificationTrigger(String user, String notifCond)`
`void`	`setPreferredNotification(String user, String notifManner)`
`void`	`setRoomNotificationTrigger(String user, String room, String notifCond, String notifConditionType, long time)`
`void`	`setSpaces(String user, List<SpaceBean> spaces)`
`String`	`setStatus(String user, String status)`
`void`	`toggleFavorite(String user, String targetUser)` Deprecated. use `addFavorite(String, String)` and `removeFavorite(String, String)` instead

Field Detail
- STATUS_AVAILABLE
```
static final String STATUS_AVAILABLE
```
  See Also:
  
  Constant Field Values
- STATUS_DONOTDISTURB
```
static final String STATUS_DONOTDISTURB
```
  See Also:
  
  Constant Field Values
- STATUS_AWAY
```
static final String STATUS_AWAY
```
  See Also:
  
  Constant Field Values
- STATUS_INVISIBLE
```
static final String STATUS_INVISIBLE
```
  See Also:
  
  Constant Field Values
- STATUS_OFFLINE
```
static final String STATUS_OFFLINE
```
  See Also:
  
  Constant Field Values
- STATUS_SPACE
```
static final String STATUS_SPACE
```
  See Also:
  
  Constant Field Values
- STATUS_TEAM
```
static final String STATUS_TEAM
```
  See Also:
  
  Constant Field Values
- ANONIM_USER
```
static final String ANONIM_USER
```
  See Also:
  
  Constant Field Values
- SUPPORT_USER
```
static final String SUPPORT_USER
```
  See Also:
  
  Constant Field Values
- PREFERRED_ROOM_NOTIFICATION_TRIGGER
```
static final String PREFERRED_ROOM_NOTIFICATION_TRIGGER
```
  See Also:
  
  Constant Field Values
- PREFERRED_NOTIFICATION
```
static final String PREFERRED_NOTIFICATION
```
  See Also:
  
  Constant Field Values
- PREFERRED_NOTIFICATION_TRIGGER
```
static final String PREFERRED_NOTIFICATION_TRIGGER
```
  See Also:
  
  Constant Field Values

Method Detail

toggleFavorite

@Deprecated
void toggleFavorite(String user,
                                String targetUser)

Deprecated. use addFavorite(String, String) and removeFavorite(String, String) instead

Parameters:: user -; targetUser -

addFavorite

void addFavorite(String user,
                 String room)

removeFavorite

void removeFavorite(String user,
                    String room)

setPreferredNotification

void setPreferredNotification(String user,
                              String notifManner)
                       throws Exception

Throws:: Exception

setNotificationTrigger

void setNotificationTrigger(String user,
                            String notifCond)
                     throws Exception

Throws:: Exception

setRoomNotificationTrigger

void setRoomNotificationTrigger(String user,
                                String room,
                                String notifCond,
                                String notifConditionType,
                                long time)
                         throws Exception

Throws:: Exception

getUserDesktopNotificationSettings

NotificationSettingsBean getUserDesktopNotificationSettings(String user)
                                                     throws org.json.JSONException

Throws:: org.json.JSONException

isFavorite

boolean isFavorite(String user,
                   String targetUser)

addUserFullName

void addUserFullName(String user,
                     String fullname)

addUserEmail

void addUserEmail(String user,
                  String email)

setSpaces

void setSpaces(String user,
               List<SpaceBean> spaces)

addTeamRoom

void addTeamRoom(String user,
                 String teamRoomId)

addTeamUsers

void addTeamUsers(String teamRoomId,
                  List<String> users)

removeTeamUsers

void removeTeamUsers(String teamRoomId,
                     List<String> users)

getTeams
```
List<RoomBean> getTeams(String user)
```

getRoom

RoomBean getRoom(String user,
                 String roomId)

getSpaces

List<SpaceBean> getSpaces(String user)

getUsersInRoomChatOneToOne

List<UserBean> getUsersInRoomChatOneToOne(String roomId)

getUsers

List<UserBean> getUsers(String roomId)

getUsers

List<UserBean> getUsers(String filter,
                        boolean fullBean)

getUsers

List<UserBean> getUsers(String roomId,
                        String filter,
                        int limit)

setStatus

String setStatus(String user,
                 String status)

setAsAdmin

void setAsAdmin(String user,
                boolean isAdmin)

isAdmin
```
boolean isAdmin(String user)
```

getStatus
```
String getStatus(String user)
```

getUserFullName
```
String getUserFullName(String user)
```

getUser
```
UserBean getUser(String user)
```

getUser

UserBean getUser(String user,
                 boolean withFavorites)

getUsersFilterBy

List<String> getUsersFilterBy(String user,
                              String room,
                              String type)

getNumberOfUsers
```
int getNumberOfUsers()
```

Interface UserService

Field Summary

Method Summary

Field Detail

STATUS_AVAILABLE

STATUS_DONOTDISTURB

STATUS_AWAY

STATUS_INVISIBLE

STATUS_OFFLINE

STATUS_SPACE

STATUS_TEAM

ANONIM_USER

SUPPORT_USER

PREFERRED_ROOM_NOTIFICATION_TRIGGER

PREFERRED_NOTIFICATION

PREFERRED_NOTIFICATION_TRIGGER

Method Detail

toggleFavorite

addFavorite

removeFavorite

setPreferredNotification

setNotificationTrigger

setRoomNotificationTrigger

getUserDesktopNotificationSettings

isFavorite

addUserFullName

addUserEmail

setSpaces

addTeamRoom

addTeamUsers

removeTeamUsers

getTeams

getRoom

getSpaces

getUsersInRoomChatOneToOne

getUsers

getUsers

getUsers

setStatus

setAsAdmin

isAdmin

getStatus

getUserFullName

getUser

getUser

getUsersFilterBy

getNumberOfUsers