edu.ksu.canvas.interfaces.ProgressReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation

A native Java library to talk to the Canvas REST API

There is a newer version: 2.0.0

package edu.ksu.canvas.interfaces;

import edu.ksu.canvas.model.Progress;

import java.io.IOException;
import java.util.Optional;

public interface ProgressReader extends CanvasReader {
    /**
     * Returns the progress of an asynchronous process by progress URL
     * @param url The URL to query for progress
     * @return A Progress object
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getProgress(String url) throws IOException;

    /**
     * Returns the progress of an asynchronous process by progress ID
     * @param progressId ID of the progress object to query
     * @return The requested Progress object
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getProgress(Integer progressId) throws IOException;
}