edu.ksu.canvas.interfaces.FileReader 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

The newest version!

package edu.ksu.canvas.interfaces;

import edu.ksu.canvas.model.File;

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

/**
 * This is just used for getting a file after it's been uploaded at the moment.
 */
public interface FileReader extends CanvasReader {

    /**
     * This is used primarily when you have a redirect after you've uploaded a file.
     * @param url The URL of the file that has been uploaded.
     * @return The file object wrapped in an optional.
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getFile(String url) throws IOException;
}