edu.ksu.canvas.interfaces

Interface CommunicationChannelWriter

All Superinterfaces:

CanvasWriter<CommunicationChannel,CommunicationChannelWriter>

All Known Implementing Classes:

CommunicationChannelImpl

public interface CommunicationChannelWriter
extends CanvasWriter<CommunicationChannel,CommunicationChannelWriter>

Method Summary

Modifier and Type	Method and Description
Optional<CommunicationChannel>	createCommunicationChannel(CreateCommunicationChannelOptions options) Adds a communication channel to a Canvas user.
Optional<CommunicationChannel>	deleteCommunicationChannel(CommunicationChannel cc) Delete a communication channel from Canvas

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

writeAsCanvasUser, writeAsSisUser

Method Detail

createCommunicationChannel

Optional<CommunicationChannel> createCommunicationChannel(CreateCommunicationChannelOptions options)
                                                   throws IOException

Adds a communication channel to a Canvas user.

Parameters:

options - The communication channel to create. Must contain user ID and address.

Returns:

The created communication channel object if creation was successful

Throws:

IOException - When there is an error communicating with Canvas

deleteCommunicationChannel

Optional<CommunicationChannel> deleteCommunicationChannel(CommunicationChannel cc)
                                                   throws IOException

Delete a communication channel from Canvas

Parameters:

cc - The communication channel record to delete. Must contain User ID and communication channel ID.

Returns:

The now deleted communication channel record

Throws:

IOException - When there is an error communicating with Canvas