edu.ksu.canvas.interfaces.CommunicationChannelWriter 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 java.io.IOException;
import java.util.Optional;

import edu.ksu.canvas.model.CommunicationChannel;
import edu.ksu.canvas.requestOptions.CreateCommunicationChannelOptions;

public interface CommunicationChannelWriter extends CanvasWriter {

    /**
     * Adds a communication channel to a Canvas user.
     * @param options The communication channel to create. Must contain user ID and address.
     * @return The created communication channel object if creation was successful
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional createCommunicationChannel(CreateCommunicationChannelOptions options) throws IOException;

    /**
     * Delete a communication channel from Canvas
     * @param cc The communication channel record to delete. Must contain User ID and communication channel ID.
     * @return The now deleted communication channel record
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional deleteCommunicationChannel(CommunicationChannel cc) throws IOException;
}