AddRecipientsDTO
in package
Class AddRecipientsDTO
Data Transfer Object for adding recipients to existing group conversations. This DTO does not extend AbstractBaseDto because Conversations API requires multipart format which differs from other Canvas APIs.
Table of Contents
Properties
- $recipients : array<string|int, string>
- An array of recipient ids to add to the conversation.
Methods
- __construct() : mixed
- Constructor
- toApiArray() : array<int, array<string, string>>
- Convert the DTO to Canvas API multipart format
Properties
$recipients
An array of recipient ids to add to the conversation.
public
array<string|int, string>
$recipients
These may be user ids or course/group ids prefixed with "course_" or "group_"
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>>