Package org.exoplatform.chat.services

Interface ChatService

public interface ChatService

Field Summary

Fields

Modifier and Type	Field	Description
static String	BIP
static String	DESKTOP_NOTIFICATION
static String	DO_NOT_NOTIFY_ME_ON_ROOM
static String	EXTERNAL_PREFIX
static String	NOTIFY_ME_EVEN_NOT_DISTURB
static String	NOTIFY_ME_ON_ROOM_KEY_WORD
static String	NOTIFY_ME_ON_ROOM_NORMAL
static String	NOTIFY_ME_WHEN_MENTION
static String	ON_SITE
static String	SPACE_PREFIX
static String	TEAM_PREFIX
static String	TYPE_DELETED
static String	TYPE_EDITED
static String	TYPE_ROOM_EXTERNAL
static String	TYPE_ROOM_SPACE
static String	TYPE_ROOM_TEAM
static String	TYPE_ROOM_USER
static String	USER_AVATAR_URL

Method Summary

Modifier and Type	Method	Description
void	delete(String room, String user, String messageId)
void	deleteTeamRoom(String roomId, String user)	Delete a Team Room by its corresponding ID. Nothing happen if : the roomId doesn't exists the roomId doesn't correspond to a Team Room the specified user is not the owner of the Team Room
void	edit(String room, String user, String messageId, String message)
List<RoomBean>	getExistingRooms(String user, boolean withPublic, boolean isAdmin, NotificationService notificationService, TokenService tokenService)
String	getExternalRoom(String identifier)
MessageBean	getMessage(String roomId, String messageId)
int	getNumberOfMessages()
int	getNumberOfRooms()
String	getRoom(List<String> users)
RoomsBean	getRooms(String user, String filter, boolean withUsers, boolean withSpaces, boolean withPublic, boolean withOffline, boolean isAdmin, NotificationService notificationService, TokenService tokenService)
RoomsBean	getRooms(String user, List<String> onlineUsers, String filter, boolean withUsers, boolean withSpaces, boolean withPublic, boolean withOffline, boolean isAdmin, int limit, NotificationService notificationService, TokenService tokenService)
String	getSpaceRoom(String space)
String	getSpaceRoomByName(String name)
String	getTeamCreator(String room)
String	getTeamRoom(String team, String user)
RoomBean	getTeamRoomById(String roomId)	Retrieve a Room by its ID
List<RoomBean>	getTeamRoomsByName(String teamName)	Get rooms by name
String	getTypeRoomChat(String roomId)
RoomsBean	getUserRooms(String user, List<String> onlineUsers, String filter, int offset, int limit, NotificationService notificationService, TokenService tokenService)
RoomsBean	getUserRooms(String user, List<String> onlineUsers, String filter, int offset, int limit, NotificationService notificationService, TokenService tokenService, String roomType)
boolean	isMemberOfRoom(String username, String roomId)
boolean	isRoomEnabled(String room)
String	read(String user, String room)
String	read(String user, String room, boolean isTextOnly, Long fromTimestamp)
String	read(String user, String room, boolean isTextOnly, Long fromTimestamp, Long toTimestamp, int limit)
String	save(String message, String user, String room, String isSystem, String options)
void	setRoomEnabled(String room, boolean enabled)
void	setRoomMeetingStatus(String room, boolean start, String startTime)
void	setRoomName(String room, String name)
void	write(String message, String user, String room, String isSystem)
void	write(String clientId, String message, String user, String room, String isSystem, String options)

Field Detail

SPACE_PREFIX

static final String SPACE_PREFIX

See Also:

Constant Field Values

TEAM_PREFIX

static final String TEAM_PREFIX

See Also:

Constant Field Values

EXTERNAL_PREFIX

static final String EXTERNAL_PREFIX

See Also:

Constant Field Values

TYPE_ROOM_USER

static final String TYPE_ROOM_USER

See Also:

Constant Field Values

TYPE_ROOM_SPACE

static final String TYPE_ROOM_SPACE

See Also:

Constant Field Values

TYPE_ROOM_TEAM

static final String TYPE_ROOM_TEAM

See Also:

Constant Field Values

TYPE_ROOM_EXTERNAL

static final String TYPE_ROOM_EXTERNAL

See Also:

Constant Field Values

TYPE_DELETED

static final String TYPE_DELETED

See Also:

Constant Field Values

TYPE_EDITED

static final String TYPE_EDITED

See Also:

Constant Field Values

DESKTOP_NOTIFICATION

static final String DESKTOP_NOTIFICATION

See Also:

Constant Field Values

ON_SITE

static final String ON_SITE

See Also:

Constant Field Values

BIP

static final String BIP

See Also:

Constant Field Values

NOTIFY_ME_WHEN_MENTION

static final String NOTIFY_ME_WHEN_MENTION

See Also:

Constant Field Values

NOTIFY_ME_EVEN_NOT_DISTURB

static final String NOTIFY_ME_EVEN_NOT_DISTURB

See Also:

Constant Field Values

NOTIFY_ME_ON_ROOM_KEY_WORD

static final String NOTIFY_ME_ON_ROOM_KEY_WORD

See Also:

Constant Field Values

DO_NOT_NOTIFY_ME_ON_ROOM

static final String DO_NOT_NOTIFY_ME_ON_ROOM

See Also:

Constant Field Values

NOTIFY_ME_ON_ROOM_NORMAL

static final String NOTIFY_ME_ON_ROOM_NORMAL

See Also:

Constant Field Values

USER_AVATAR_URL

static final String USER_AVATAR_URL

See Also:

Constant Field Values

Method Detail

write

void write(String message,
           String user,
           String room,
           String isSystem)

write

void write(String clientId,
           String message,
           String user,
           String room,
           String isSystem,
           String options)

save

String save(String message,
            String user,
            String room,
            String isSystem,
            String options)

delete

void delete(String room,
            String user,
            String messageId)

deleteTeamRoom

void deleteTeamRoom(String roomId,
                    String user)

Delete a Team Room by its corresponding ID.
Nothing happen if :

• the roomId doesn't exists
• the roomId doesn't correspond to a Team Room
• the specified user is not the owner of the Team Room

Parameters:

roomId - the team room ID to delete

user - the owner of the team room

edit

void edit(String room,
          String user,
          String messageId,
          String message)

read

String read(String user,
            String room)

read

String read(String user,
            String room,
            boolean isTextOnly,
            Long fromTimestamp)

read

String read(String user,
            String room,
            boolean isTextOnly,
            Long fromTimestamp,
            Long toTimestamp,
            int limit)

getMessage

MessageBean getMessage(String roomId,
                       String messageId)

getSpaceRoom

String getSpaceRoom(String space)

getSpaceRoomByName

String getSpaceRoomByName(String name)

getTeamRoom

String getTeamRoom(String team,
                   String user)

getExternalRoom

String getExternalRoom(String identifier)

getTeamCreator

String getTeamCreator(String room)

setRoomName

void setRoomName(String room,
                 String name)

isRoomEnabled

boolean isRoomEnabled(String room)

setRoomEnabled

void setRoomEnabled(String room,
                    boolean enabled)

setRoomMeetingStatus

void setRoomMeetingStatus(String room,
                          boolean start,
                          String startTime)

isMemberOfRoom

boolean isMemberOfRoom(String username,
                       String roomId)

getTeamRoomsByName

List<RoomBean> getTeamRoomsByName(String teamName)

Get rooms by name

Parameters:

teamName -

Returns:

getTeamRoomById

RoomBean getTeamRoomById(String roomId)

Retrieve a Room by its ID

Parameters:

roomId - the ID of the room

Returns:

the room or null if the room doesn't exists

getRoom

String getRoom(List<String> users)

getTypeRoomChat

String getTypeRoomChat(String roomId)

getExistingRooms

List<RoomBean> getExistingRooms(String user,
                                boolean withPublic,
                                boolean isAdmin,
                                NotificationService notificationService,
                                TokenService tokenService)

getRooms

RoomsBean getRooms(String user,
                   String filter,
                   boolean withUsers,
                   boolean withSpaces,
                   boolean withPublic,
                   boolean withOffline,
                   boolean isAdmin,
                   NotificationService notificationService,
                   TokenService tokenService)

getRooms

RoomsBean getRooms(String user,
                   List<String> onlineUsers,
                   String filter,
                   boolean withUsers,
                   boolean withSpaces,
                   boolean withPublic,
                   boolean withOffline,
                   boolean isAdmin,
                   int limit,
                   NotificationService notificationService,
                   TokenService tokenService)

getUserRooms

RoomsBean getUserRooms(String user,
                       List<String> onlineUsers,
                       String filter,
                       int offset,
                       int limit,
                       NotificationService notificationService,
                       TokenService tokenService)

getUserRooms

RoomsBean getUserRooms(String user,
                       List<String> onlineUsers,
                       String filter,
                       int offset,
                       int limit,
                       NotificationService notificationService,
                       TokenService tokenService,
                       String roomType)

getNumberOfRooms

int getNumberOfRooms()

getNumberOfMessages

int getNumberOfMessages()