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

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.AccountAdmin;
import edu.ksu.canvas.requestOptions.ListAccountAdminsOptions;

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

public interface AdminReader extends CanvasReader {
    /**
     * Return a list of account admins that the current user can view or manage.
     * @param options Object encapsulating parameters to the list accounts API call
     * @return List of account admins
     * @throws IOException When there is an error communicating with Canvas
     */
    List listAccountAdmins(ListAccountAdminsOptions options) throws IOException;
}