| org.sakaiproject.chat.api.ChatChannel
| ChatChannel | | public interface ChatChannel extends MessageChannel(Code) | |
ChatChannel is the extension to the MessageChanel interface for a Sakai Chat service chat channel. Messages in the ChatChannel are ChatMessages with ChatMessageHeaders.
Security is defined, see MessageChannel.
Usage Events generated:
- chat.message.channel.read - chat message resource id
- chat.message.channel.remove.any - chat message resource id
- chat.message.channel.remove.own - chat message resource id
- chat.message.channel.post - chat message resource id
|
| Method Summary | |
| public ChatMessageEdit | addChatMessage()
A (ChatMessageEdit) cover for addMessage. | | public ChatMessage | addChatMessage(List attachments, String body)
a (ChatMessage) cover for addMessage to add a new message to this channel.
Parameters:
attachments - The message header attachments, a vector of Reference objects.
Parameters:
body - The body text. | | public ChatMessageEdit | editChatMessage(String messageId)
A (ChatMessageEdit) cover for editMessage. | | public ChatMessage | getChatMessage(String messageId)
A (ChatMessage) cover for getMessage to return a specific chat channel message, as specified by message id.
Parameters:
messageId - The id of the message to get. |
| addChatMessage | | public ChatMessageEdit addChatMessage() throws PermissionException(Code) | | A (ChatMessageEdit) cover for addMessage. Add a new message to this channel. Must commitEdit() to make official, or cancelEdit() when done!
The newly added message, locked for update.
exception:
PermissionException - If the user does not have write permission to the channel. |
| addChatMessage | | public ChatMessage addChatMessage(List attachments, String body) throws PermissionException(Code) | | a (ChatMessage) cover for addMessage to add a new message to this channel.
Parameters:
attachments - The message header attachments, a vector of Reference objects.
Parameters:
body - The body text. The newly added message.
exception:
PermissionException - If the user does not have write permission to the channel. |
| editChatMessage | | public ChatMessageEdit editChatMessage(String messageId) throws IdUnusedException, PermissionException, InUseException(Code) | | A (ChatMessageEdit) cover for editMessage. Return a specific channel message, as specified by message name, locked for update. Must commitEdit() to make official, or cancelEdit() when done!
Parameters:
messageId - The id of the message to get. the Message that has the specified id.
exception:
IdUnusedException - If this name is not a defined message in this channel.
exception:
PermissionException - If the user does not have any permissions to read the message.
exception:
InUseException - if the current user does not have permission to mess with this user. |
| getChatMessage | | public ChatMessage getChatMessage(String messageId) throws IdUnusedException, PermissionException(Code) | | A (ChatMessage) cover for getMessage to return a specific chat channel message, as specified by message id.
Parameters:
messageId - The id of the message to get. the ChatMessage that has the specified id.
exception:
IdUnusedException - If this name is not a defined message in this chat channel.
exception:
PermissionException - If the user does not have any permissions to read the message. |
|
|