edu.ksu.canvas.interfaces

Interface TabReader

All Superinterfaces:

CanvasReader<Tab,TabReader>

All Known Implementing Classes:

TabImpl

public interface TabReader
extends CanvasReader<Tab,TabReader>

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.

Method Summary

Modifier and Type	Method and Description
List<Tab>	listAvailableCourseTabs(String courseId, boolean includeExternalTools) Lists the navigation tabs for the given course.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listAvailableCourseTabs

List<Tab> listAvailableCourseTabs(String courseId,
                                  boolean includeExternalTools)
                           throws IOException

Lists the navigation tabs for the given course.

Parameters:

courseId - identifies the course

includeExternalTools - includes external tool tabs in the results

Returns:

list of available tabs

Throws:

IOException - When there is an error communicating with Canvas