edu.ksu.canvas.interfaces.LoginWriter 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
Show all versions of canvas-api Show documentation
A native Java library to talk to the Canvas REST API
package edu.ksu.canvas.interfaces;
import java.io.IOException;
import java.util.Optional;
import edu.ksu.canvas.model.Login;
public interface LoginWriter extends CanvasWriter {
/**
* Write changes to a login to Canvas.
* @param login The modified login to update. Must contain account ID and login ID.
* @return The modified login object if update was successful
* @throws IOException When there is an error communicating with Canvas
*/
Optional updateLogin(Login login) throws IOException;
/**
* Delete a login from Canvas
* @param login The login record to delete. Must contain User ID and login ID.
* @return The now deleted login record
* @throws IOException When there is an error communicating with Canvas
*/
Optional deleteLogin(Login login) throws IOException;
}