edu.ksu.canvas.requestOptions

Class GetSingleConversationOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetSingleConversationOptions

public class GetSingleConversationOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetSingleConversationOptions.FilterMode

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetSingleConversationOptions(Integer conversationId)

Method Summary

Modifier and Type	Method and Description
GetSingleConversationOptions	autoMarkAsRead(Boolean markAsRead) If true, unread conversations will be automatically marked as read.
GetSingleConversationOptions	filterMode(GetSingleConversationOptions.FilterMode filterMode) Used when setting the "visible" field in the response.
GetSingleConversationOptions	filters(List<String> filters) Used when setting the "visible" field in the response.
Integer	getConversationId()

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

GetSingleConversationOptions

public GetSingleConversationOptions(Integer conversationId)

Method Detail

getConversationId

public Integer getConversationId()

filters

public GetSingleConversationOptions filters(List<String> filters)

Used when setting the "visible" field in the response. See the "List Conversations" docs for details

Parameters:

filters - Filter strings to be applied to the visibility of conversations

Returns:

this to continue building options

filterMode

public GetSingleConversationOptions filterMode(GetSingleConversationOptions.FilterMode filterMode)

Used when setting the "visible" field in the response. See the "List Conversations" docs for details

Parameters:

filterMode - Mode to use when multiple filters are given

Returns:

this to continue building options

autoMarkAsRead

public GetSingleConversationOptions autoMarkAsRead(Boolean markAsRead)

If true, unread conversations will be automatically marked as read. Currently this defaults to true but this is planned to change to false in the future

Parameters:

markAsRead - Whether to mark conversations as read

Returns:

this to continue building options