conversation

Source:
Functions for conversations

Methods

(async) create(opts, configopt) → {Promise.<Array.<CanvasConversation>>}

Source:
Author:
  • Gabe Abrams
Creates a Canvas conversation
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
recipientIds Array.<number> Canvas IDs for the users who will receive the message from the current user
subject string subject of the conversation
body string body of the message
courseId number <optional>
 no course the id of the course to send from. If no course is included, message is sent outside the context of the course
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
Array of Canvas Conversations https://canvas.instructure.com/doc/api/conversations.html#Conversation
Type
Promise.<Array.<CanvasConversation>>