edu.ksu.canvas.interfaces

Interface ProgressReader

All Superinterfaces:

CanvasReader<Progress,ProgressReader>

All Known Implementing Classes:

ProgressImpl

public interface ProgressReader
extends CanvasReader<Progress,ProgressReader>

Method Summary

Modifier and Type	Method and Description
Optional<Progress>	getProgress(Integer progressId) Returns the progress of an asynchronous process by progress ID
Optional<Progress>	getProgress(String url) Returns the progress of an asynchronous process by progress URL

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getProgress

Optional<Progress> getProgress(String url)
                        throws IOException

Returns the progress of an asynchronous process by progress URL

Parameters:

url - The URL to query for progress

Returns:

A Progress object

Throws:

IOException - When there is an error communicating with Canvas

getProgress

Optional<Progress> getProgress(Integer progressId)
                        throws IOException

Returns the progress of an asynchronous process by progress ID

Parameters:

progressId - ID of the progress object to query

Returns:

The requested Progress object

Throws:

IOException - When there is an error communicating with Canvas