edu.ksu.canvas.requestOptions

Class CreateConversationOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.CreateConversationOptions

public class CreateConversationOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateConversationOptions.MediaCommentType
static class	CreateConversationOptions.Mode

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
CreateConversationOptions(List<String> recipients, String bodyText) Recipient list and body text are required to create a conversation.
CreateConversationOptions(String recipient, String bodyText) Convenience constructor to send to a single recipient instead of a list.

Method Summary

Modifier and Type	Method and Description
CreateConversationOptions	attachmentIds(List<Integer> attachmentIds) IDs of files to attach to this conversation.
CreateConversationOptions	forceNew(Boolean forceNew) Forces a new message to be created, even if there is an existing private conversation.
CreateConversationOptions	groupConversation(Boolean groupConversation) If specifying multiple recipients, setting this to true will turn this into a group message instead of multiple individual conversations.
CreateConversationOptions	mediaCommentId(String mediaCommentId) Associate an audio or video file with this conversation
CreateConversationOptions	mediaCommentType(CreateConversationOptions.MediaCommentType type) Set the type of media associated with this conversation
CreateConversationOptions	mode(CreateConversationOptions.Mode mode) Send messages synchronously or asynchronously.
CreateConversationOptions	subject(String subject) Set a conversation subject.
CreateConversationOptions	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

CreateConversationOptions

public CreateConversationOptions(List<String> recipients,
                                 String bodyText)

Recipient list and body text are required to create a conversation. Recipients can be either a user ID or a course/group ID if prefixed with "course_" or "group_"

Parameters:

recipients - List of IDs for users/courses/groups to start a conversation with

bodyText - The contents of the message

CreateConversationOptions

public CreateConversationOptions(String recipient,
                                 String bodyText)

Convenience constructor to send to a single recipient instead of a list. Recipient can be a user ID or a course/group if prefixed with "course_" or "group_"

Parameters:

recipient - The ID of the user/course/group to start a conversation with

bodyText - The contents of the message

Method Detail

subject

public CreateConversationOptions subject(String subject)

Set a conversation subject. If this is a private message between users who already have a conversation then that conversation and its subject will be re-used instead of creating a new one.

Parameters:

subject - The desired subject of the conversation

Returns:

This object to allow adding more options

forceNew

public CreateConversationOptions forceNew(Boolean forceNew)

Forces a new message to be created, even if there is an existing private conversation.

Parameters:

forceNew - True if a new message should be created.

Returns:

This object to allow adding more options

groupConversation

public CreateConversationOptions groupConversation(Boolean groupConversation)

If specifying multiple recipients, setting this to true will turn this into a group message instead of multiple individual conversations. Defaults to false.

Parameters:

groupConversation - Whether or not this is a group conversation.

Returns:

This object to allow adding more options

attachmentIds

public CreateConversationOptions attachmentIds(List<Integer> attachmentIds)

IDs of files to attach to this conversation. 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 CreateConversationOptions mediaCommentId(String mediaCommentId)

Associate an audio or video file with this conversation

Parameters:

mediaCommentId - Media comment ID of media to associate

Returns:

This object to allow adding more options

mediaCommentType

public CreateConversationOptions mediaCommentType(CreateConversationOptions.MediaCommentType type)

Set the type of media associated with this conversation

Parameters:

type - Type of media

Returns:

This object to allow adding more options

userNote

public CreateConversationOptions 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

mode

public CreateConversationOptions mode(CreateConversationOptions.Mode mode)

Send messages synchronously or asynchronously. Only applies if this is a bulk private message. If specified, the response is an empty array. Message sending status must be queried via the batches API

Parameters:

mode - Sync or async mode to use when sending message

Returns:

This object to allow adding more options