edu.ksu.canvas.interfaces

Interface ConversationReader

All Superinterfaces:

CanvasReader<Conversation,ConversationReader>

All Known Implementing Classes:

ConversationImpl

public interface ConversationReader
extends CanvasReader<Conversation,ConversationReader>

Method Summary

Modifier and Type	Method and Description
Optional<Conversation>	getSingleConversation(GetSingleConversationOptions options) Get a single conversation from Canvas

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getSingleConversation

Optional<Conversation> getSingleConversation(GetSingleConversationOptions options)
                                      throws IOException

Get a single conversation from Canvas

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