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

The newest version!

package edu.ksu.canvas.interfaces;

import edu.ksu.canvas.model.User;
import edu.ksu.canvas.requestOptions.GetUsersInAccountOptions;
import edu.ksu.canvas.requestOptions.GetUsersInCourseOptions;

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

public interface UserReader extends CanvasReader {
    /**
     * Retrieve a list of users in a course
     * @param options API options for this API call
     * @return List of users in a course
     * @throws IOException When there is an error communicating with Canvas
     */
    List getUsersInCourse(GetUsersInCourseOptions options) throws IOException;

    /**
     * Retrieve a specific user details from Canvas by user identifier
     * @param userIdentifier The object holding a user identifier value, for example:
     *    Numeric Canvas user ID
     *    A string like "sis_integration_id:123" to query by SIS integration ID
     *    A string like "sis_user_id:ABC" to query by SIS ID
     *    The special string "self" that the Canvas API interprets as "the currently logged in user"
     * @return The User returned by Canvas or an empty Optional
     * @throws IOException When there is an error communicating with Canvas
     */
     Optional showUserDetails(String userIdentifier) throws IOException;

    /**
     * Retrieve a list of all users for an account.
     * @param options API options for this call.  Acceptable options are:
     *  
     *    search_term - what is being used to search for users
     *    sort - what order the users are coming back in;
     *                acceptable values here are username, email, sis_id and
     *                last_login
     *    order - what order the users are coming back in;
     *                acceptable values here are asc and desc
     *  
     * @return List of users in an account
     * @throws IOException When there is an error communicating with Canvas
     */
     List getUsersInAccount(GetUsersInAccountOptions options) throws IOException;
}