edu.ksu.canvas.interfaces.ConversationReader Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation

A native Java library to talk to the Canvas REST API

The newest version!

package edu.ksu.canvas.interfaces;

import java.io.IOException;
import java.util.Optional;

import edu.ksu.canvas.model.Conversation;
import edu.ksu.canvas.requestOptions.GetSingleConversationOptions;

public interface ConversationReader extends CanvasReader {

    /**
     * Get a single conversation from Canvas
     * @param options API options for the conversation call
     * @return The requested conversation, if it exists
     * @throws IOException if there is an error communicating with Canvas
     */
    public Optional getSingleConversation(GetSingleConversationOptions options) throws IOException;
}