edu.ksu.canvas.interfaces.TabWriter 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.Tab;
import edu.ksu.canvas.requestOptions.UpdateCourseTabOptions;

/**
 * Methods to modify tabs, which can be applied to courses or groups.
 * 
 * See https://canvas.colorado.edu/doc/api/tabs.html for the Canvas API
 * documentation.
 */
public interface TabWriter extends CanvasWriter {

    /**
     * Modifies a tab.
     *
     * @param options options specifying the course, tab, and what to modify
     * @return modified tab object
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional updateCourseTab(UpdateCourseTabOptions options) throws IOException;
}