edu.ksu.canvas.impl

Class PageImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Page,PageReader,PageWriter>

edu.ksu.canvas.impl.PageImpl

All Implemented Interfaces:

CanvasReader<Page,PageReader>, CanvasWriter<Page,PageWriter>, PageReader, PageWriter

public class PageImpl
extends BaseImpl<Page,PageReader,PageWriter>
implements PageReader, PageWriter

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
PageImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
Optional<Page>	getCoursePage(String courseId, String pageUrl) Retrieve a specified page associated with a course.
Optional<Page>	getGroupPage(String groupId, String pageUrl) Retrieve a specified page associated with a group.
List<Page>	listPagesInCourse(String courseId) Get a list of pages in a course.
List<Page>	listPagesInGroup(String groupId) Get a list of pages in a group.
protected Type	listType()
protected Class<Page>	objectType()
Optional<Page>	updateCoursePage(Page page, String courseId) Save a course page to Canvas

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

PageImpl

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

Method Detail

getCoursePage

public Optional<Page> getCoursePage(String courseId,
                                    String pageUrl)
                             throws IOException

Description copied from interface: PageReader

Retrieve a specified page associated with a course.

Specified by:

getCoursePage in interface PageReader

Parameters:

courseId - The Canvas course ID

pageUrl - The unique URL identifier of a page within the course

Returns:

The requested Page object

Throws:

IOException - When there is an error communicating with Canvas

getGroupPage

public Optional<Page> getGroupPage(String groupId,
                                   String pageUrl)
                            throws IOException

Description copied from interface: PageReader

Retrieve a specified page associated with a group.

Specified by:

getGroupPage in interface PageReader

Parameters:

groupId - The Canvas group ID

pageUrl - The unique URL identifier of a page within the group

Returns:

The requested Page object

Throws:

IOException - When there is an error communicating with Canvas

updateCoursePage

public Optional<Page> updateCoursePage(Page page,
                                       String courseId)
                                throws IOException

Description copied from interface: PageWriter

Save a course page to Canvas

Specified by:

updateCoursePage in interface PageWriter

Parameters:

page - The page object to save

courseId - The Canvas course ID that this page is to be saved to

Returns:

The update page after saving

Throws:

IOException - When there is an error communicating with Canvas

listPagesInCourse

public List<Page> listPagesInCourse(String courseId)
                             throws IOException

Description copied from interface: PageReader

Get a list of pages in a course. NOTE: Page objects returned by this method will not have a body! The Canvas API does not return the body when calling this endpoint, allegedly for performance reasons

Specified by:

listPagesInCourse in interface PageReader

Parameters:

courseId - Canvas ID of the course

Returns:

List of Page objects (without a body)

Throws:

IOException - When there is an error communicating with Canvas

listPagesInGroup

public List<Page> listPagesInGroup(String groupId)
                            throws IOException

Description copied from interface: PageReader

Get a list of pages in a group. NOTE: Page objects returned by this method will not have a body! The Canvas API does not return the body when calling this endpoint, allegedly for performance reasons

Specified by:

listPagesInGroup in interface PageReader

Parameters:

groupId - Canvas Group ID of the group

Returns:

List of Page objects (without a body)

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Page,PageReader,PageWriter>

objectType

protected Class<Page> objectType()

Specified by:

objectType in class BaseImpl<Page,PageReader,PageWriter>