edu.ksu.canvas.interfaces

Interface ConversationWriter

All Superinterfaces:

CanvasWriter<Conversation,ConversationWriter>

All Known Implementing Classes:

ConversationImpl

public interface ConversationWriter
extends CanvasWriter<Conversation,ConversationWriter>

Method Summary

Modifier and Type	Method and Description
Optional<Conversation>	addMessage(AddMessageToConversationOptions options) Add a message to an existing conversation.
List<Conversation>	createConversation(CreateConversationOptions options) Create a new conversation with one or more recipients.
Optional<Conversation>	editConversation(Conversation conversation) Modify a conversation in Canvas.
void	markAllConversationsRead() Marks all conversations for the current user as read.

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasWriter

writeAsCanvasUser, writeAsSisUser

Method Detail

createConversation

List<Conversation> createConversation(CreateConversationOptions options)
                               throws IOException

Create a new conversation with one or more recipients. Note that if there is an existing private conversation between the sender and a recipient, that conversation will be reused and this message appended to it. A new conversation will NOT be created and the subject will not be modified. Recipients can be users, courses or groups. If courses or groups, the IDs need to be prepended with "course_" or "group_" respectively. Returns a list of conversations created.

Parameters:

options - Creation options for the conversation

Returns:

List of conversations created

Throws:

IOException - if an error happens while communicating with Canvas

markAllConversationsRead

void markAllConversationsRead()
                       throws IOException

Marks all conversations for the current user as read. There is no return from Canvas. If there is no error, we must assume it succeeded.

Throws:

IOException - if there is an error communicating with Canvas

editConversation

Optional<Conversation> editConversation(Conversation conversation)
                                 throws IOException

Modify a conversation in Canvas. Only some fields are mutable: workflow state, subscribed and starred. According to the API docs you should be able to modify the subject but it doesn't seem to work.

Parameters:

conversation - Conversation with modifications to send to Canvas

Returns:

The modified conversation object

Throws:

IOException - if there is an error communicating with Canvas

addMessage

Optional<Conversation> addMessage(AddMessageToConversationOptions options)
                           throws IOException

Add a message to an existing conversation. The returned Conversation object will only have a single message in it (the one we just added)

Parameters:

options - Parameters for the message adding method

Returns:

Conversation object with only the added message in it

Throws:

IOException - if there is an error communicating with Canvas