edu.ksu.canvas.impl

Class TabImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Tab,TabReader,TabWriter>

edu.ksu.canvas.impl.TabImpl

All Implemented Interfaces:

CanvasReader<Tab,TabReader>, CanvasWriter<Tab,TabWriter>, TabReader, TabWriter

public class TabImpl
extends BaseImpl<Tab,TabReader,TabWriter>
implements TabReader, TabWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
TabImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
List<Tab>	listAvailableCourseTabs(String courseId, boolean includeExternalTools) Lists the navigation tabs for the given course.
protected Type	listType()
protected Class<Tab>	objectType()
Optional<Tab>	updateCourseTab(UpdateCourseTabOptions options) Modifies a tab.

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readAsCanvasUser, readAsSisUser, withCallback

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

writeAsCanvasUser, writeAsSisUser

Constructor Detail

TabImpl

public TabImpl(String canvasBaseUrl,
               Integer apiVersion,
               OauthToken oauthToken,
               RestClient restClient,
               int connectTimeout,
               int readTimeout,
               Integer paginationPageSize,
               Boolean serializeNulls)

Method Detail

listAvailableCourseTabs

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

Description copied from interface: TabReader

Lists the navigation tabs for the given course.

Specified by:

listAvailableCourseTabs in interface TabReader

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

updateCourseTab

public Optional<Tab> updateCourseTab(UpdateCourseTabOptions options)
                              throws IOException

Description copied from interface: TabWriter

Modifies a tab.

Specified by:

updateCourseTab in interface TabWriter

Parameters:

options - options specifying the course, tab, and what to modify

Returns:

modified tab object

Throws:

IOException - When there is an error communicating with Canvas

objectType

protected Class<Tab> objectType()

Specified by:

objectType in class BaseImpl<Tab,TabReader,TabWriter>

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Tab,TabReader,TabWriter>