UpdateConversationDTO
in package
Class UpdateConversationDTO
Data Transfer Object for updating existing conversations. This DTO does not extend AbstractBaseDto because Conversations API requires multipart format which differs from other Canvas APIs.
Table of Contents
Properties
- $filter : array<string|int, string>|null
- Used when generating "visible" in the API response
- $filterMode : string|null
- Used when generating "visible" in the API response
- $scope : string|null
- Used when generating "visible" in the API response
- $starred : bool|null
- Whether the conversation is starred
- $subscribed : bool|null
- Whether the user is subscribed to the conversation
- $workflowState : string|null
- The workflow state of the conversation (read, unread, archived)
Methods
- __construct() : mixed
- Constructor
- toApiArray() : array<int, array<string, string>>
- Convert the DTO to Canvas API multipart format
Properties
$filter
Used when generating "visible" in the API response
public
array<string|int, string>|null
$filter
= null
$filterMode
Used when generating "visible" in the API response
public
string|null
$filterMode
= null
$scope
Used when generating "visible" in the API response
public
string|null
$scope
= null
$starred
Whether the conversation is starred
public
bool|null
$starred
= null
$subscribed
Whether the user is subscribed to the conversation
public
bool|null
$subscribed
= null
$workflowState
The workflow state of the conversation (read, unread, archived)
public
string|null
$workflowState
= null
Methods
__construct()
Constructor
public
__construct([array<string, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string, mixed> = []
toApiArray()
Convert the DTO to Canvas API multipart format
public
toApiArray() : array<int, array<string, string>>