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

Go to download

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

There is a newer version: 2.0.0

package edu.ksu.canvas.interfaces;

import java.io.IOException;
import java.util.List;

import edu.ksu.canvas.model.Tab;

/**
 * Methods to read information about 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 TabReader extends CanvasReader {

    /**
     * Lists the navigation tabs for the given course.
     *
     * @param courseId identifies the course
     * @param includeExternalTools includes external tool tabs in the results
     * @return list of available tabs
     * @throws IOException When there is an error communicating with Canvas
     */
    List listAvailableCourseTabs(String courseId, boolean includeExternalTools) throws IOException;
}