edu.ksu.canvas.interfaces.RoleReader 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.Role;
import edu.ksu.canvas.requestOptions.ListRolesOptions;

import java.io.IOException;
import java.util.List;

public interface RoleReader extends CanvasReader {
    /**
     * Return a list of roles for an account.
     * @param options Object encapsulating parameters to the list accounts API call
     * @return List of roles
     * @throws IOException When there is an error communicating with Canvas
     */
    public List listRoles(ListRolesOptions options) throws IOException;
}