edu.ksu.canvas.interfaces

Interface UserWriter

All Superinterfaces:

CanvasWriter<User,UserWriter>

All Known Implementing Classes:

UserImpl

public interface UserWriter
extends CanvasWriter<User,UserWriter>

Method Summary

Modifier and Type	Method and Description
Optional<User>	createUser(User user) Create a new user in Canvas
Optional<User>	createUser(User user, CreateUserOptions options) Create a new user in Canvas
Optional<User>	updateUser(User user) Update user information

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

writeAsCanvasUser, writeAsSisUser

Method Detail

createUser

Optional<User> createUser(User user)
                   throws InvalidOauthTokenException,
                          IOException

Create a new user in Canvas

Parameters:

user - user data for creating user account

Returns:

The newly created user

Throws:

InvalidOauthTokenException - When the supplied OAuth token is not valid

IOException - When there is an error communicating with Canvas

createUser

Optional<User> createUser(User user,
                          CreateUserOptions options)
                   throws InvalidOauthTokenException,
                          IOException

Create a new user in Canvas

Parameters:

user - user data for creating user account

options - the options for the user creation

Returns:

The newly created user

Throws:

InvalidOauthTokenException - When the supplied OAuth token is not valid

IOException - When there is an error communicating with Canvas

updateUser

Optional<User> updateUser(User user)
                   throws InvalidOauthTokenException,
                          IOException

Update user information

Parameters:

user - The user object with updated data to push to Canvas

Returns:

The updated user

Throws:

InvalidOauthTokenException - When the supplied OAuth token is not valid

IOException - When there is an error communicating with Canvas