ChatManager (sakai-chat-api 21.0 API)

All Superinterfaces:: EntitySummary

public interface ChatManager
extends EntitySummary

Author:: andersjb

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPLICATION_ID` The type string for this application: should not change over time as it may be stored in various parts of persistent entities.
`static String`	`CHAT`
`static String`	`CHAT_TOOL_ID`
`static String`	`REF_TYPE_CHANNEL`
`static String`	`REF_TYPE_MESSAGE` The Reference type for a messgae.
`static String`	`REFERENCE_ROOT` This string starts the references to resources in this service.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Date`	`calculateDateByOffset(int offset)` Returns a Date object that is the offset number of days before the current date
`int`	`countChannelMessages(ChatChannel channel)` Deprecated. use `getChannelMessagesCount(ChatChannel, String, Date)`
`ChatChannel`	`createNewChannel(String context, String title, boolean placementDefaultChannel, boolean checkAuthz, String placement)` Creates a new ChatChannel but doesn't put it in the database.
`ChatMessage`	`createNewMessage(ChatChannel channel, String owner)` creates an unsaved Chat Message
`void`	`deleteChannel(ChatChannel channel)` deletes the channel from the database.
`void`	`deleteChannelMessages(ChatChannel channel)` delete all Chat Messages in a given channel
`void`	`deleteMessage(ChatMessage message)` delete a Chat Message
`boolean`	`getCanCreateChannel(String context)` Returns whether or not the user has permissions to create a new channel in the given context
`boolean`	`getCanDelete(ChatChannel channel)` Returns whether or not the user has permissions to delete this channel
`boolean`	`getCanDelete(ChatMessage message)` Returns whether or not the user has permissions to delete this message
`boolean`	`getCanDeleteAnyMessage(String context)` Returns whether or not the user has permissions to delete any messages in this context
`boolean`	`getCanEdit(ChatChannel channel)` Returns whether or not the user has permissions to edit this channel
`boolean`	`getCanPostMessage(ChatChannel channel)` Returns whether or not the user can post messages in this channel
`boolean`	`getCanReadMessage(ChatChannel channel)` Returns whether or not the user can read messages in this channel
`List<ChatMessage>`	`getChannelMessages(ChatChannel channel, String context, Date date, int start, int max, boolean sortAsc)` gets all the messages from the Channel after the passed date, limited to returning the the default maximum number of messages (100), use `getChannelMessagesCount(ChatChannel, String, Date)` to find the total number of messages
`int`	`getChannelMessagesCount(ChatChannel channel, String context, Date date)` Gets the count of all the messages from the Channel after the passed date
`ChatChannel`	`getChatChannel(String chatChannelId)` gets one chat room
`List<ChatChannel>`	`getContextChannels(String context, boolean lazy)` gets the rooms associated with the context
`List<ChatChannel>`	`getContextChannels(String contextId, String defaultNewTitle, String placement)` Gets the rooms associated with the context If no rooms are found, one is created with the passed title
`ChatChannel`	`getDefaultChannel(String contextId, String placement)` Returns the context's default channel, or null if none.
`String`	`getLabel()` Returns label used for entity producer
`ChatMessage`	`getMessage(String chatMessageId)` gets the message with the id
`MessageDateString`	`getMessageDateString(ChatMessage msg)` Get different date strings based on given ChatMessage::messageDate
`int`	`getMessagesMax()`
`int`	`getPollInterval()` Get pollInterval (in milliseconds) from properties
`List<SimpleUser>`	`getPresentUsers(String siteId, String channelId)` Get all online users in given siteId and chat channel id
`String`	`getSessionKey()` Get session key (ussage_session_id:session_user_id) from current session
`String`	`getUserTimeZone()` Get user timezone from preferencesService.
`Map<String,Object>`	`handleChatData(String siteId, String channelId, String sessionKey)` - Update heartbeat for current user - Get undelivered (latest) messages - Get online users - Get removed messages
`boolean`	`isMaintainer(String context)` Returns whether or not the user is a site maintainer in this context
`void`	`makeDefaultContextChannel(ChatChannel channel, String placement)` Makes the passed channel the default in the channel's context
`void`	`migrateMessage(String sql, Object[] values)` Insert migrated message data
`void`	`sendMessage(ChatMessage entry)` sends the message out to the other clients
`void`	`updateChannel(ChatChannel channel, boolean checkAuthz)` updates the channel back into the database
`void`	`updateMessage(ChatMessage message)` saves a Chat Message

Methods inherited from interface org.sakaiproject.entity.api.EntitySummary
getSummarizableReference, getSummary, summarizableToolIds

- Field Detail
  - APPLICATION_ID
```
static final String APPLICATION_ID
```
    The type string for this application: should not change over time as it may be stored in various parts of persistent entities.
    
    See Also:
    
    Constant Field Values
  - REFERENCE_ROOT
```
static final String REFERENCE_ROOT
```
    This string starts the references to resources in this service.
    
    See Also:
    
    Constant Field Values
  - REF_TYPE_CHANNEL
```
static final String REF_TYPE_CHANNEL
```
    See Also:
    
    Constant Field Values
  - CHAT
```
static final String CHAT
```
    See Also:
    
    Constant Field Values
  - REF_TYPE_MESSAGE
```
static final String REF_TYPE_MESSAGE
```
    The Reference type for a messgae.
    
    See Also:
    
    Constant Field Values
  - CHAT_TOOL_ID
```
static final String CHAT_TOOL_ID
```
    See Also:
    
    Constant Field Values
- Method Detail
  - createNewChannel
```
ChatChannel createNewChannel(String context,
                             String title,
                             boolean placementDefaultChannel,
                             boolean checkAuthz,
                             String placement)
                      throws PermissionException
```
    Creates a new ChatChannel but doesn't put it in the database. To persist the channel, call updateChannel().
    
    Parameters:
    
    context - Id of what the channel is linked to
    
    title - String the title of the channel
    
    placementDefaultChannel - boolean to set this as the default channel in the context
    
    checkAuthz - boolean indicating if we should check for authorization before creating the channel
    
    placement - String id of the tool placement
    
    Returns:
    
    ChatChannel the new un-saved channel
    
    Throws:
    
    PermissionException
  - updateChannel
```
void updateChannel(ChatChannel channel,
                   boolean checkAuthz)
            throws PermissionException
```
    updates the channel back into the database
    
    Parameters:
    
    channel - ChatChannel
    
    checkAuthz - boolean indicating if we should check for authorization before updating
    
    Throws:
    
    PermissionException
  - deleteChannel
```
void deleteChannel(ChatChannel channel)
            throws PermissionException
```
    deletes the channel from the database. It also removes the ChatMessages
    
    Parameters:
    
    channel -
    
    Throws:
    
    PermissionException
  - getChatChannel
```
ChatChannel getChatChannel(String chatChannelId)
```
    gets one chat room
    
    Parameters:
    
    chatChannelId - Id
    
    Returns:
    
    ChatChannel
  - getChannelMessages
```
List<ChatMessage> getChannelMessages(ChatChannel channel,
                                     String context,
                                     Date date,
                                     int start,
                                     int max,
                                     boolean sortAsc)
                              throws PermissionException
```
    gets all the messages from the Channel after the passed date, limited to returning the the default maximum number of messages (100), use getChannelMessagesCount(ChatChannel, String, Date) to find the total number of messages
    
    Parameters:
    
    channel - the ChatChannel to get messages for
    
    context - [OPTIONAL] Context of channel and messages to return (only used if the channel is null)
    
    date - [OPTIONAL] Date that the messages need to be newer than, includes all messages if null
    
    start - The item to start on (supports paging)
    
    max - The maximum number of items to return, uses the default maximum if above the default max or < 0, returns none if set to 0
    
    sortAsc - Boolean to sort the records in ascending order
    
    Returns:
    
    List of ChatMessages
    
    Throws:
    
    PermissionException
  - getChannelMessagesCount
```
int getChannelMessagesCount(ChatChannel channel,
                            String context,
                            Date date)
```
    Gets the count of all the messages from the Channel after the passed date
    
    Parameters:
    
    channel - the ChatChannel to get messages for
    
    context - [OPTIONAL] Context of channel and messages to return (only used if the channel is null)
    
    date - [OPTIONAL] Date that the messages need to be newer than, includes all messages if null
    
    Returns:
    
    the count of ChatMessages
  - countChannelMessages
```
int countChannelMessages(ChatChannel channel)
```
    Deprecated. use getChannelMessagesCount(ChatChannel, String, Date)
    
    Get the number of messages in a given chat channel
    
    Parameters:
    
    channel - ChatChannel to find the number of messages
    
    Returns:
    
    int the number of messages in the passed channel
  - createNewMessage
```
ChatMessage createNewMessage(ChatChannel channel,
                             String owner)
                      throws PermissionException
```
    creates an unsaved Chat Message
    
    Parameters:
    
    ChatChannel - the channel that the new message will be in
    
    String - the owner of the message
    
    Returns:
    
    ChatMessage
    
    Throws:
    
    PermissionException
  - updateMessage
```
void updateMessage(ChatMessage message)
```
    saves a Chat Message
    
    Parameters:
    
    ChatMessage - the message to update
  - deleteMessage
```
void deleteMessage(ChatMessage message)
            throws PermissionException
```
    delete a Chat Message
    
    Parameters:
    
    ChatMessage - the message to delete
    
    Throws:
    
    PermissionException
  - deleteChannelMessages
```
void deleteChannelMessages(ChatChannel channel)
                    throws PermissionException
```
    delete all Chat Messages in a given channel
    
    Parameters:
    
    ChatChannel - the channel to delete all messages from
    
    Throws:
    
    PermissionException
  - getMessage
```
ChatMessage getMessage(String chatMessageId)
```
    gets the message with the id
    
    Parameters:
    
    chatMessageId - Id
    
    Returns:
    
    ChatMessage
  - sendMessage
```
void sendMessage(ChatMessage entry)
```
    sends the message out to the other clients
    
    Parameters:
    
    entry - ChatMessage
  - getContextChannels
```
List<ChatChannel> getContextChannels(String context,
                                     boolean lazy)
```
    gets the rooms associated with the context
    
    Parameters:
    
    context - Site the channel is in
    
    lazy - boolean to load the messages lazily or not
    
    Returns:
    
    List of ChatChannel
  - getContextChannels
```
List<ChatChannel> getContextChannels(String contextId,
                                     String defaultNewTitle,
                                     String placement)
```
    Gets the rooms associated with the context If no rooms are found, one is created with the passed title
    
    Parameters:
    
    contextId - Id
    
    defaultNewTitle - String the default name of a new ChatChannel
    
    placement -
    
    Returns:
    
    List of ChatChannel
  - getDefaultChannel
```
ChatChannel getDefaultChannel(String contextId,
                              String placement)
```
    Returns the context's default channel, or null if none.
    
    Parameters:
    
    contextId -
    
    placement -
    
    Returns:
    
    the Channel
  - getCanDelete
```
boolean getCanDelete(ChatMessage message)
```
    Returns whether or not the user has permissions to delete this message
  - getCanDelete
```
boolean getCanDelete(ChatChannel channel)
```
    Returns whether or not the user has permissions to delete this channel
  - getCanDeleteAnyMessage
```
boolean getCanDeleteAnyMessage(String context)
```
    Returns whether or not the user has permissions to delete any messages in this context
  - getCanEdit
```
boolean getCanEdit(ChatChannel channel)
```
    Returns whether or not the user has permissions to edit this channel
  - getCanCreateChannel
```
boolean getCanCreateChannel(String context)
```
    Returns whether or not the user has permissions to create a new channel in the given context
  - getCanReadMessage
```
boolean getCanReadMessage(ChatChannel channel)
```
    Returns whether or not the user can read messages in this channel
  - getCanPostMessage
```
boolean getCanPostMessage(ChatChannel channel)
```
    Returns whether or not the user can post messages in this channel
  - isMaintainer
```
boolean isMaintainer(String context)
```
    Returns whether or not the user is a site maintainer in this context
  - makeDefaultContextChannel
```
void makeDefaultContextChannel(ChatChannel channel,
                               String placement)
```
    Makes the passed channel the default in the channel's context
    
    Parameters:
    
    channel -
    
    placement -
  - calculateDateByOffset
```
Date calculateDateByOffset(int offset)
```
    Returns a Date object that is the offset number of days before the current date
    
    Parameters:
    
    offset - Difference in days from current date
    
    Returns:
    
    a Date
  - getLabel
```
String getLabel()
```
    Returns label used for entity producer
  - migrateMessage
```
void migrateMessage(String sql,
                    Object[] values)
```
    Insert migrated message data
    
    Parameters:
    
    sql - sql statement to run
    
    values - Object[] of data to bind into the sql statement
  - getMessagesMax
```
int getMessagesMax()
```
    Returns:
    
    the max number of messages that are returned from storage
  - getPresentUsers
```
List<SimpleUser> getPresentUsers(String siteId,
                                 String channelId)
```
    Get all online users in given siteId and chat channel id
    
    Parameters:
    
    siteId -
    
    channelId -
    
    Returns:
  - handleChatData
```
Map<String,Object> handleChatData(String siteId,
                                  String channelId,
                                  String sessionKey)
```
    - Update heartbeat for current user - Get undelivered (latest) messages - Get online users - Get removed messages
    
    Parameters:
    
    siteId -
    
    channelId -
    
    sessionKey -
    
    Returns:
  - getPollInterval
```
int getPollInterval()
```
    Get pollInterval (in milliseconds) from properties
    
    Returns:
  - getSessionKey
```
String getSessionKey()
```
    Get session key (ussage_session_id:session_user_id) from current session
    
    Returns:
  - getMessageDateString
```
MessageDateString getMessageDateString(ChatMessage msg)
```
    Get different date strings based on given ChatMessage::messageDate
    
    Parameters:
    
    msg -
    
    Returns:
  - getUserTimeZone
```
String getUserTimeZone()
```
    Get user timezone from preferencesService. This method is almost a duplicate from BasicTimeService.getUserTimezoneLocale. Would be great if the preferencesService returns it directly
    
    Returns:

Interface ChatManager

Field Summary

Method Summary

Methods inherited from interface org.sakaiproject.entity.api.EntitySummary

Field Detail

APPLICATION_ID

REFERENCE_ROOT

REF_TYPE_CHANNEL

CHAT

REF_TYPE_MESSAGE

CHAT_TOOL_ID

Method Detail

createNewChannel

updateChannel

deleteChannel

getChatChannel

getChannelMessages

getChannelMessagesCount

countChannelMessages

createNewMessage

updateMessage

deleteMessage

deleteChannelMessages

getMessage

sendMessage

getContextChannels

getContextChannels

getDefaultChannel

getCanDelete

getCanDelete

getCanDeleteAnyMessage

getCanEdit

getCanCreateChannel

getCanReadMessage

getCanPostMessage

isMaintainer

makeDefaultContextChannel

calculateDateByOffset

getLabel

migrateMessage

getMessagesMax

getPresentUsers

handleChatData

getPollInterval

getSessionKey

getMessageDateString

getUserTimeZone