edu.ksu.canvas.interfaces

Interface ExternalToolWriter

All Superinterfaces:

CanvasWriter<ExternalTool,ExternalToolWriter>

All Known Implementing Classes:

ExternalToolImpl

public interface ExternalToolWriter
extends CanvasWriter<ExternalTool,ExternalToolWriter>

Method Summary

Modifier and Type	Method and Description
Optional<ExternalTool>	createExternalToolInAccount(String accountId, ExternalTool tool) Create an External tool in the specified Canvas account
Optional<ExternalTool>	createExternalToolInCourse(String courseId, ExternalTool tool) Create an External tool in the specified Canvas course
Optional<ExternalTool>	deleteExternalToolInAccount(String accountId, Integer toolId) Delete an external tool from an account.
Optional<ExternalTool>	deleteExternalToolInCourse(String courseId, Integer toolId) Delete an external tool from a course.
Optional<ExternalTool>	editExternalToolInAccount(String accountId, ExternalTool tool) Modify the settings of an external tool associated with an account
Optional<ExternalTool>	editExternalToolInCourse(String courseId, ExternalTool tool) Modify the settings of an external tool associated with a course

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

writeAsCanvasUser, writeAsSisUser

Method Detail

createExternalToolInCourse

Optional<ExternalTool> createExternalToolInCourse(String courseId,
                                                  ExternalTool tool)
                                           throws IOException

Create an External tool in the specified Canvas course

Parameters:

courseId - Canvas ID or sis_course_id:[SIS ID] for the course to create the tool in

tool - The tool to create. Must have name, privacy level, consumer key, shared secret and either url or domain

Returns:

The newly created external tool with the Canvas assigned ID

Throws:

IOException - if there is an error communicating with Canvas

createExternalToolInAccount

Optional<ExternalTool> createExternalToolInAccount(String accountId,
                                                   ExternalTool tool)
                                            throws IOException

Create an External tool in the specified Canvas account

Parameters:

accountId - Canvas ID or sis_account_id:[SIS ID] for the account to create the tool in

tool - The tool to create. Must have name, privacy level, consumer key, shared secret and either url or domain

Returns:

The newly created external tool with the Canvas assigned ID

Throws:

IOException - if there is an error communicating with Canvas

editExternalToolInCourse

Optional<ExternalTool> editExternalToolInCourse(String courseId,
                                                ExternalTool tool)
                                         throws IOException

Modify the settings of an external tool associated with a course

Parameters:

courseId - Canvas ID or sis_course_id:[SIS ID] for the course

tool - The tool with settings to be modified. Tool ID must be present

Returns:

The updated tool object

Throws:

IOException - if there is an error communicating with Canvas

editExternalToolInAccount

Optional<ExternalTool> editExternalToolInAccount(String accountId,
                                                 ExternalTool tool)
                                          throws IOException

Modify the settings of an external tool associated with an account

Parameters:

accountId - Canvas ID or sis_account_id:[SIS ID] for the account that contains the tool

tool - The tool with settings to be modified. Tool ID must be present

Returns:

The updated tool object

Throws:

IOException - if there is an error communicating with Canvas

deleteExternalToolInCourse

Optional<ExternalTool> deleteExternalToolInCourse(String courseId,
                                                  Integer toolId)
                                           throws IOException

Delete an external tool from a course.

Parameters:

courseId - Canvas course ID or sis_course_id:[SIS ID] for the course to delete the tool from

toolId - The Canvas ID of the tool to delete

Returns:

The deleted tool. Should have a workflow state of "deleted"

Throws:

IOException - if there is an error communicating with Canvas

deleteExternalToolInAccount

Optional<ExternalTool> deleteExternalToolInAccount(String accountId,
                                                   Integer toolId)
                                            throws IOException

Delete an external tool from an account.

Parameters:

accountId - Canvas account ID or sis_account_id:[SIS ID] for the account to delete the tool from

toolId - Canvas ID of the tool to delete

Returns:

The deleted tool. Should have a workflow state of "deleted"

Throws:

IOException - if there is an error communicating with Canvas