UVACanvasAccess
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.
 

Properties

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

Detailed Description

Represents a Canvas account.

Distinct from a user account.

Property Documentation

◆ DefaultGroupStorageQuotaMb

ulong? UVACanvasAccess.Structures.Accounts.Account.DefaultGroupStorageQuotaMb
get

The default storage quota for groups under this account, in megabytes.

◆ 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.

◆ DefaultUserStorageQuotaMb

ulong? UVACanvasAccess.Structures.Accounts.Account.DefaultUserStorageQuotaMb
get

The default storage quota for users under this account, in megabytes.

◆ Id

ulong UVACanvasAccess.Structures.Accounts.Account.Id
get

The account id.

◆ IntegrationId

string UVACanvasAccess.Structures.Accounts.Account.IntegrationId
get

The account's integration identifier.

◆ LtiGuid

string UVACanvasAccess.Structures.Accounts.Account.LtiGuid
get

The account's LTI context identifier.

◆ Name

string UVACanvasAccess.Structures.Accounts.Account.Name
get

The account's display name.

◆ ParentAccountId

ulong? UVACanvasAccess.Structures.Accounts.Account.ParentAccountId
get

The parent account id, if it exists.

◆ RootAccountId

ulong? UVACanvasAccess.Structures.Accounts.Account.RootAccountId
get

The root account id, unless this is the root account.

◆ SisAccountId

string UVACanvasAccess.Structures.Accounts.Account.SisAccountId
get

The account's SIS identifier.

◆ SisImportId

string UVACanvasAccess.Structures.Accounts.Account.SisImportId
get

The account's SIS import id, if this account was created by SIS.

◆ Uuid

string UVACanvasAccess.Structures.Accounts.Account.Uuid
get

The account's UUID.

◆ WorkflowState

string UVACanvasAccess.Structures.Accounts.Account.WorkflowState
get

The state of the account. Either active or deleted.


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