edu.ksu.canvas.impl

Class CommunicationChannelImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<CommunicationChannel,CommunicationChannelReader,CommunicationChannelWriter>

edu.ksu.canvas.impl.CommunicationChannelImpl

All Implemented Interfaces:

CanvasReader<CommunicationChannel,CommunicationChannelReader>, CanvasWriter<CommunicationChannel,CommunicationChannelWriter>, CommunicationChannelReader, CommunicationChannelWriter

public class CommunicationChannelImpl
extends BaseImpl<CommunicationChannel,CommunicationChannelReader,CommunicationChannelWriter>
implements CommunicationChannelReader, CommunicationChannelWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
CommunicationChannelImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

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
List<CommunicationChannel>	getCommunicationChannelsForUser(String userId) Retrieve a user's communication channels.
protected Type	listType()
protected Class<CommunicationChannel>	objectType()

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readAsCanvasUser, readAsSisUser, withCallback

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

writeAsCanvasUser, writeAsSisUser

Constructor Detail

CommunicationChannelImpl

public CommunicationChannelImpl(String canvasBaseUrl,
                                Integer apiVersion,
                                OauthToken oauthToken,
                                RestClient restClient,
                                int connectTimeout,
                                int readTimeout,
                                Integer paginationPageSize,
                                Boolean serializeNulls)

Method Detail

getCommunicationChannelsForUser

public List<CommunicationChannel> getCommunicationChannelsForUser(String userId)
                                                           throws IOException

Description copied from interface: CommunicationChannelReader

Retrieve a user's communication channels.

Specified by:

getCommunicationChannelsForUser in interface CommunicationChannelReader

Parameters:

userId - the id of the user to retrieve communication channels for

Returns:

List of the user's communication channels

Throws:

IOException - When there is an error communicating with Canvas

createCommunicationChannel

public Optional<CommunicationChannel> createCommunicationChannel(CreateCommunicationChannelOptions options)
                                                          throws IOException

Description copied from interface: CommunicationChannelWriter

Adds a communication channel to a Canvas user.

Specified by:

createCommunicationChannel in interface CommunicationChannelWriter

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

public Optional<CommunicationChannel> deleteCommunicationChannel(CommunicationChannel cc)
                                                          throws IOException

Description copied from interface: CommunicationChannelWriter

Delete a communication channel from Canvas

Specified by:

deleteCommunicationChannel in interface CommunicationChannelWriter

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

listType

protected Type listType()

Specified by:

listType in class BaseImpl<CommunicationChannel,CommunicationChannelReader,CommunicationChannelWriter>

objectType

protected Class<CommunicationChannel> objectType()

Specified by:

objectType in class BaseImpl<CommunicationChannel,CommunicationChannelReader,CommunicationChannelWriter>