Documentation

CreateAccountDTO extends AbstractBaseDto
in package
implements DTOInterface

Data Transfer Object for creating a new Canvas account

Table of Contents

Interfaces

DTOInterface

Properties

$defaultGroupStorageQuotaMb  : int|null
The default group storage quota in megabytes
$defaultStorageQuotaMb  : int|null
The default course storage quota in megabytes
$defaultTimeZone  : string|null
The default time zone of the account
$defaultUserStorageQuotaMb  : int|null
The default user storage quota in megabytes
$integrationId  : string|null
The account's identifier in external systems
$name  : string
The name of the new sub-account
$parentAccountId  : int|null
The parent account ID (required for sub-accounts)
$sisAccountId  : string|null
The account's identifier in the Student Information System
$apiPropertyName  : string
The name of the property in the API

Methods

__construct()  : mixed
BaseDto constructor.
getDefaultGroupStorageQuotaMb()  : int|null
Get the default group storage quota in MB
getDefaultStorageQuotaMb()  : int|null
Get the default storage quota in MB
getDefaultTimeZone()  : string|null
Get the default time zone
getDefaultUserStorageQuotaMb()  : int|null
Get the default user storage quota in MB
getIntegrationId()  : string|null
Get the integration ID
getName()  : string
Get the account name
getParentAccountId()  : int|null
Get the parent account ID
getSisAccountId()  : string|null
Get the SIS account ID
setDefaultGroupStorageQuotaMb()  : self
Set the default group storage quota in MB
setDefaultStorageQuotaMb()  : self
Set the default storage quota in MB
setDefaultTimeZone()  : self
Set the default time zone
setDefaultUserStorageQuotaMb()  : self
Set the default user storage quota in MB
setIntegrationId()  : self
Set the integration ID
setName()  : self
Set the account name
setParentAccountId()  : self
Set the parent account ID
setSisAccountId()  : self
Set the SIS account ID
toApiArray()  : array<string|int, mixed>
Convert the DTO to an array for API requests
toArray()  : array<string|int, mixed>
Convert the DTO to an array

Properties

$defaultGroupStorageQuotaMb

The default group storage quota in megabytes

public int|null $defaultGroupStorageQuotaMb = null

$defaultStorageQuotaMb

The default course storage quota in megabytes

public int|null $defaultStorageQuotaMb = null

$defaultTimeZone

The default time zone of the account

public string|null $defaultTimeZone = null

$defaultUserStorageQuotaMb

The default user storage quota in megabytes

public int|null $defaultUserStorageQuotaMb = null

$integrationId

The account's identifier in external systems

public string|null $integrationId = null

$parentAccountId

The parent account ID (required for sub-accounts)

public int|null $parentAccountId = null

$sisAccountId

The account's identifier in the Student Information System

public string|null $sisAccountId = null

$apiPropertyName

The name of the property in the API

protected string $apiPropertyName = 'account'

Methods

__construct()

BaseDto constructor.

public __construct(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Tags
throws
Exception

getDefaultGroupStorageQuotaMb()

Get the default group storage quota in MB

public getDefaultGroupStorageQuotaMb() : int|null
Return values
int|null

getDefaultStorageQuotaMb()

Get the default storage quota in MB

public getDefaultStorageQuotaMb() : int|null
Return values
int|null

getDefaultTimeZone()

Get the default time zone

public getDefaultTimeZone() : string|null
Return values
string|null

getDefaultUserStorageQuotaMb()

Get the default user storage quota in MB

public getDefaultUserStorageQuotaMb() : int|null
Return values
int|null

getIntegrationId()

Get the integration ID

public getIntegrationId() : string|null
Return values
string|null

getName()

Get the account name

public getName() : string
Return values
string

getParentAccountId()

Get the parent account ID

public getParentAccountId() : int|null
Return values
int|null

getSisAccountId()

Get the SIS account ID

public getSisAccountId() : string|null
Return values
string|null

setDefaultGroupStorageQuotaMb()

Set the default group storage quota in MB

public setDefaultGroupStorageQuotaMb(int|null $defaultGroupStorageQuotaMb) : self
Parameters
$defaultGroupStorageQuotaMb : int|null
Return values
self

setDefaultStorageQuotaMb()

Set the default storage quota in MB

public setDefaultStorageQuotaMb(int|null $defaultStorageQuotaMb) : self
Parameters
$defaultStorageQuotaMb : int|null
Return values
self

setDefaultTimeZone()

Set the default time zone

public setDefaultTimeZone(string|null $defaultTimeZone) : self
Parameters
$defaultTimeZone : string|null
Return values
self

setDefaultUserStorageQuotaMb()

Set the default user storage quota in MB

public setDefaultUserStorageQuotaMb(int|null $defaultUserStorageQuotaMb) : self
Parameters
$defaultUserStorageQuotaMb : int|null
Return values
self

setIntegrationId()

Set the integration ID

public setIntegrationId(string|null $integrationId) : self
Parameters
$integrationId : string|null
Return values
self

setName()

Set the account name

public setName(string $name) : self
Parameters
$name : string
Return values
self

setParentAccountId()

Set the parent account ID

public setParentAccountId(int|null $parentAccountId) : self
Parameters
$parentAccountId : int|null
Return values
self

setSisAccountId()

Set the SIS account ID

public setSisAccountId(string|null $sisAccountId) : self
Parameters
$sisAccountId : string|null
Return values
self

toApiArray()

Convert the DTO to an array for API requests

public toApiArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

toArray()

Convert the DTO to an array

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results