UVACanvasAccess
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
UVACanvasAccess.Structures.Accounts.Account Class Reference

Represents a Canvas account. More...

Inheritance diagram for UVACanvasAccess.Structures.Accounts.Account:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.Accounts.Account:
Collaboration graph
[legend]

Public Member Functions

string ToPrettyString ()
 Returns a pretty, formatted string representation of the object.
Returns
The formatted string.

 

Properties

ulong Id [get]
 The account id.
 
string Name [get]
 The account's display name.
 
string Uuid [get]
 The account's UUID.
 
ulong? ParentAccountId [get]
 The parent account id, if it exists.
 
ulong? RootAccountId [get]
 The root account id, unless this is the root account.
 
ulong? DefaultUserStorageQuotaMb [get]
 The default storage quota for users under this account, in megabytes.
 
ulong? DefaultGroupStorageQuotaMb [get]
 The default storage quota for groups under this account, in megabytes.
 
string DefaultTimeZone [get]
 The default time zone for this account.
 
string SisAccountId [get]
 The account's SIS identifier.
 
string IntegrationId [get]
 The account's integration identifier.
 
string SisImportId [get]
 The account's SIS import id, if this account was created by SIS.
 
string LtiGuid [get]
 The account's LTI context identifier.
 
string WorkflowState [get]
 The state of the account. Either active or deleted.
 

Detailed Description

Represents a Canvas account.

Distinct from a user account.

Member Function Documentation

◆ ToPrettyString()

string UVACanvasAccess.Structures.Accounts.Account.ToPrettyString ( )
inline

Returns a pretty, formatted string representation of the object.

Returns
The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

Property Documentation

◆ DefaultTimeZone

string UVACanvasAccess.Structures.Accounts.Account.DefaultTimeZone
get

The default time zone for this account.

This may be in either IANA format or Ruby on Rails format.


The documentation for this class was generated from the following file: