Skip to main content
Module

x/gesso/types/params.ts>GetSingleConversationParams

A TypeScript API client for Canvas LMS
Peekoe/Gesso
Latest
interface GetSingleConversationParams
import { type GetSingleConversationParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
interleavesubmissions: boolean

(Obsolete) Submissions are no longer linked to conversations. This parameter is ignored.

optional
scope: string

Allowed values: unread, starred, archived

optional
filter: string[]

Used when generating “visible” in the API response. See the explanation under the index API action

optional
filtermode: string

Allowed values: and, or, default or

optional
automarkasread: boolean

Default true. If true, unread conversations will be automatically marked as read. This will default to false in a future API release, so clients should explicitly send true if that is the desired behavior.