Documentation

CreateGroupCategoryDTO extends AbstractBaseDto

in package

• CanvasLMS
• Dto
• GroupCategories

Data Transfer Object for creating a group category in Canvas LMS.

Table of Contents

Properties

$autoLeader  : string|null

Assigns group leaders automatically Values: 'first', 'random', null

$courseId  : int|null

Course ID for creating group category in course context

$createGroupCount  : int|null

Create this number of groups

$groupLimit  : int|null

Limit the maximum number of users in each group Requires self signup

$name  : string|null

Name of the group category (required)

$nonCollaborative  : bool|null

Can only be set by users with Differentiation Tag permissions If true, groups will only be visible to users with manage permission

$selfSignup  : string|null

Allow students to sign up for a group themselves Values: 'enabled', 'restricted', null

$sisGroupCategoryId  : string|null

The unique SIS identifier

$splitGroupCount  : string|null

(Deprecated) Create groups and evenly distribute students

$apiPropertyName  : string

The name of the property in the API

Methods

__construct()  : mixed

BaseDto constructor.

toApiArray()  : array<string|int, array{name: string, contents: string}>

Convert DTO to API-compatible array format

toArray()  : array<string|int, mixed>

Convert the DTO to an array