edu.ksu.canvas.requestOptions

Class AddMessageToConversationOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.AddMessageToConversationOptions

public class AddMessageToConversationOptions
extends BaseOptions

Field Summary

Fields inherited from class edu.ksu.canvas.requestOptions.BaseOptions

optionsMap

Constructor Summary

Constructors

Constructor and Description
AddMessageToConversationOptions(Integer conversationId, String body) Create parameters to add a message.

Method Summary

Modifier and Type	Method and Description
AddMessageToConversationOptions	attachmentIds(List<Integer> attachmentIds) IDs of files to attach to this message.
Integer	getConversationId()
AddMessageToConversationOptions	includedMessages(List<Integer> messages) List of message IDs from this conversation to send to recipients of the new message.
AddMessageToConversationOptions	mediaCommentId(Integer mediaCommentId) Associate an audio or video file with this message
AddMessageToConversationOptions	mediaCommentType(CreateConversationOptions.MediaCommentType type) Set the type of media associated with this message
AddMessageToConversationOptions	recipients(List<String> recipients) Recipients to add to the conversation.
AddMessageToConversationOptions	userNote(Boolean userNote) Adds a faculty journal entry for each recipient if: - User making call has permission - Recipient is a student - Faculty journals are enabled on the account

Methods inherited from class edu.ksu.canvas.requestOptions.BaseOptions

addEnumList, addNumberList, addSingleItem, addStringList, getOptionsMap

Methods inherited from class java.lang.Object

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

Constructor Detail

AddMessageToConversationOptions

public AddMessageToConversationOptions(Integer conversationId,
                                       String body)

Create parameters to add a message. Conversation ID and message body are required.

Parameters:

conversationId - The ID of the Conversation to add a message to

body - The contents of the message

Method Detail

getConversationId

public Integer getConversationId()

attachmentIds

public AddMessageToConversationOptions attachmentIds(List<Integer> attachmentIds)

IDs of files to attach to this message. The files must have been previously uploaded to the sender's "conversation attachments" folder.

Parameters:

attachmentIds - IDs of files to attach to conversation

Returns:

This object to allow adding more options

mediaCommentId

public AddMessageToConversationOptions mediaCommentId(Integer mediaCommentId)

Associate an audio or video file with this message

Parameters:

mediaCommentId - Media comment ID of media to associate

Returns:

This object to allow adding more options

mediaCommentType

public AddMessageToConversationOptions mediaCommentType(CreateConversationOptions.MediaCommentType type)

Set the type of media associated with this message

Parameters:

type - Type of media

Returns:

This object to allow adding more options

recipients

public AddMessageToConversationOptions recipients(List<String> recipients)

Recipients to add to the conversation. Defaults to all users currently participating

Parameters:

recipients - User IDs of users to include in this message

Returns:

This object to allow adding more options

includedMessages

public AddMessageToConversationOptions includedMessages(List<Integer> messages)

List of message IDs from this conversation to send to recipients of the new message. Only has an effect on new users being added to the conversation via the "recipients" method.

Parameters:

messages - List of message IDs

Returns:

This object to allow adding more options

userNote

public AddMessageToConversationOptions userNote(Boolean userNote)

Adds a faculty journal entry for each recipient if: - User making call has permission - Recipient is a student - Faculty journals are enabled on the account

Parameters:

userNote - Whether to add faculty journals to conversations

Returns:

This object to allow adding more options