edu.ksu.canvas.interfaces

Interface PageReader

All Superinterfaces:

CanvasReader<Page,PageReader>

All Known Implementing Classes:

PageImpl

public interface PageReader
extends CanvasReader<Page,PageReader>

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.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getCoursePage

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

Retrieve a specified page associated with a course.

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

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

Retrieve a specified page associated with a group.

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

listPagesInCourse

List<Page> listPagesInCourse(String courseId)
                      throws IOException

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

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

List<Page> listPagesInGroup(String groupId)
                     throws IOException

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

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