Package org.exoplatform.chat.services

Interface UserDataStorage

All Known Implementing Classes:

UserMongoDataStorage

public interface UserDataStorage

User data storage

Field Summary

Fields

Modifier and Type	Field	Description
static String	NOTIFICATIONS_SETTINGS
static String	PREFERRED_NOTIFICATION
static String	PREFERRED_NOTIFICATION_TRIGGER
static String	PREFERRED_ROOM_NOTIFICATION_TRIGGER
static String	ROOM_NOTIF_TRIGGER_WHEN_KEY_WORD
static String	STATUS_AVAILABLE
static String	STATUS_AWAY
static String	STATUS_DONOTDISTURB
static String	STATUS_INVISIBLE
static String	STATUS_NONE
static String	STATUS_OFFLINE

Method Summary

Modifier and Type	Method	Description
void	addFavorite(String user, String targetUser)
void	addTeamRoom(String user, String teamRoomId)
void	addUserEmail(String user, String email)
void	addUserFullName(String user, String fullname)
default void	deleteUser(String user)
String	getExternalValue(String user)
int	getNumberOfUsers()
org.exoplatform.chat.model.RoomBean	getRoom(String user, String roomId)
List<org.exoplatform.chat.model.SpaceBean>	getSpaces(String user)
String	getStatus(String user)
List<org.exoplatform.chat.model.RoomBean>	getTeams(String user)
org.exoplatform.chat.model.UserBean	getUser(String user)
org.exoplatform.chat.model.UserBean	getUser(String user, boolean withFavorites)
org.exoplatform.chat.model.NotificationSettingsBean	getUserDesktopNotificationSettings(String user)
String	getUserFullName(String user)
List<org.exoplatform.chat.model.UserBean>	getUsers(String roomId, String filter, int limit)
List<org.exoplatform.chat.model.UserBean>	getUsers(String roomId, List<String> onlineUsers, String filter, int limit, boolean onlyOnlineUsers)
Long	getUsersCount(String roomId, String filter)
Long	getUsersCount(String roomId, String filter, boolean activeUsers)
List<String>	getUsersFilterBy(String user, String room, String type)
List<org.exoplatform.chat.model.UserBean>	getUsersInRoomChatOneToOne(String roomId)
boolean	isAdmin(String user)
boolean	isFavorite(String user, String targetUser)
void	removeFavorite(String user, String targetUser)
void	removeTeamUsers(String teamRoomId, List<String> users)
void	setAsAdmin(String user, boolean isAdmin)
default void	setEnabledUser(String user, Boolean isEnabled)
default void	setExternalUser(String user, String external)
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<org.exoplatform.chat.model.SpaceBean> spaces)
String	setStatus(String user, String status)

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_NONE

static final String STATUS_NONE

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

ROOM_NOTIF_TRIGGER_WHEN_KEY_WORD

static final String ROOM_NOTIF_TRIGGER_WHEN_KEY_WORD

See Also:

Constant Field Values

NOTIFICATIONS_SETTINGS

static final String NOTIFICATIONS_SETTINGS

See Also:

Constant Field Values

Method Detail

addFavorite

void addFavorite(String user,
                 String targetUser)

removeFavorite

void removeFavorite(String user,
                    String targetUser)

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

org.exoplatform.chat.model.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)

deleteUser

default void deleteUser(String user)

setEnabledUser

default void setEnabledUser(String user,
                            Boolean isEnabled)

setExternalUser

default void setExternalUser(String user,
                             String external)

setSpaces

void setSpaces(String user,
               List<org.exoplatform.chat.model.SpaceBean> spaces)

addTeamRoom

void addTeamRoom(String user,
                 String teamRoomId)

removeTeamUsers

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

getTeams

List<org.exoplatform.chat.model.RoomBean> getTeams(String user)

getRoom

org.exoplatform.chat.model.RoomBean getRoom(String user,
                                            String roomId)

getSpaces

List<org.exoplatform.chat.model.SpaceBean> getSpaces(String user)

getUsers

List<org.exoplatform.chat.model.UserBean> getUsers(String roomId,
                                                   String filter,
                                                   int limit)

getUsers

List<org.exoplatform.chat.model.UserBean> getUsers(String roomId,
                                                   List<String> onlineUsers,
                                                   String filter,
                                                   int limit,
                                                   boolean onlyOnlineUsers)

getUsersCount

Long getUsersCount(String roomId,
                   String filter)

getUsersCount

Long getUsersCount(String roomId,
                   String filter,
                   boolean activeUsers)

getUsersInRoomChatOneToOne

List<org.exoplatform.chat.model.UserBean> getUsersInRoomChatOneToOne(String roomId)

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)

getExternalValue

String getExternalValue(String user)

getUser

org.exoplatform.chat.model.UserBean getUser(String user)

getUser

org.exoplatform.chat.model.UserBean getUser(String user,
                                            boolean withFavorites)

getUsersFilterBy

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

getNumberOfUsers

int getNumberOfUsers()