edu.ksu.canvas.interfaces

Interface UserReader

All Superinterfaces:

CanvasReader<User,UserReader>

All Known Implementing Classes:

UserImpl

public interface UserReader
extends CanvasReader<User,UserReader>

Method Summary

Modifier and Type	Method and Description
List<User>	getUsersInAccount(GetUsersInAccountOptions options) Retrieve a list of all users for an account.
List<User>	getUsersInCourse(GetUsersInCourseOptions options) Retrieve a list of users in a course
Optional<User>	showUserDetails(String userIdentifier) Retrieve a specific user details from Canvas by user identifier

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasReader

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getUsersInCourse

List<User> getUsersInCourse(GetUsersInCourseOptions options)
                     throws IOException

Retrieve a list of users in a course

Parameters:

options - API options for this API call

Returns:

List of users in a course

Throws:

IOException - When there is an error communicating with Canvas

showUserDetails

Optional<User> showUserDetails(String userIdentifier)
                        throws IOException

Retrieve a specific user details from Canvas by user identifier

Parameters:

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"

Returns:

The User returned by Canvas or an empty Optional

Throws:

IOException - When there is an error communicating with Canvas

getUsersInAccount

List<User> getUsersInAccount(GetUsersInAccountOptions options)
                      throws IOException

Retrieve a list of all users for an account.

Parameters:

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

Returns:

List of users in an account

Throws:

IOException - When there is an error communicating with Canvas