edu.ksu.canvas.impl

Class ConversationImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Conversation,ConversationReader,ConversationWriter>

edu.ksu.canvas.impl.ConversationImpl

All Implemented Interfaces:

CanvasReader<Conversation,ConversationReader>, CanvasWriter<Conversation,ConversationWriter>, ConversationReader, ConversationWriter

public class ConversationImpl
extends BaseImpl<Conversation,ConversationReader,ConversationWriter>
implements ConversationReader, ConversationWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
ConversationImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

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.
Optional<Conversation>	getSingleConversation(GetSingleConversationOptions options) Get a single conversation from Canvas
protected Type	listType()
void	markAllConversationsRead() Marks all conversations for the current user as read.
protected Class<Conversation>	objectType()

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readAsCanvasUser, readAsSisUser, withCallback

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

writeAsCanvasUser, writeAsSisUser

Constructor Detail

ConversationImpl

public ConversationImpl(String canvasBaseUrl,
                        Integer apiVersion,
                        OauthToken oauthToken,
                        RestClient restClient,
                        int connectTimeout,
                        int readTimeout,
                        Integer paginationPageSize,
                        Boolean serializeNulls)

Method Detail

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Conversation,ConversationReader,ConversationWriter>

objectType

protected Class<Conversation> objectType()

Specified by:

objectType in class BaseImpl<Conversation,ConversationReader,ConversationWriter>

getSingleConversation

public Optional<Conversation> getSingleConversation(GetSingleConversationOptions options)
                                             throws IOException

Description copied from interface: ConversationReader

Get a single conversation from Canvas

Specified by:

getSingleConversation in interface ConversationReader

Parameters:

options - API options for the conversation call

Returns:

The requested conversation, if it exists

Throws:

IOException - if there is an error communicating with Canvas

createConversation

public List<Conversation> createConversation(CreateConversationOptions options)
                                      throws IOException

Description copied from interface: ConversationWriter

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.

Specified by:

createConversation in interface ConversationWriter

Parameters:

options - Creation options for the conversation

Returns:

List of conversations created

Throws:

IOException - if an error happens while communicating with Canvas

markAllConversationsRead

public void markAllConversationsRead()
                              throws IOException

Description copied from interface: ConversationWriter

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.

Specified by:

markAllConversationsRead in interface ConversationWriter

Throws:

IOException - if there is an error communicating with Canvas

editConversation

public Optional<Conversation> editConversation(Conversation conversation)
                                        throws IOException

Description copied from interface: ConversationWriter

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.

Specified by:

editConversation in interface ConversationWriter

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

public Optional<Conversation> addMessage(AddMessageToConversationOptions options)
                                  throws IOException

Description copied from interface: ConversationWriter

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

Specified by:

addMessage in interface ConversationWriter

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