Represents a folder on the Canvas server. Folders contain CanvasFiles. More...

Inheritance diagram for UVACanvasAccess.Structures.Files.Folder:

Collaboration diagram for UVACanvasAccess.Structures.Files.Folder:

Public Member Functions
string	ToPrettyString ()
	Returns a pretty, formatted string representation of the object.

Properties
string	ContextType `[get]`
	The context of the folder; e.g. course, group, user, etc. More...

ulong	ContextId `[get]`
	The id of the folder context. Folder.ContextType determines the type of this id. More...

uint	FilesCount `[get]`
	The number of files in the folder. More...

int?	Position `[get]`
	The visual position of this folder relative to other folders in the same parent folder. More...

DateTime	UpdatedAt `[get]`
	When the folder was last updated. More...

string	FoldersUrl `[get]`
	The URL to this folder. More...

string	FilesUrl `[get]`
	The URL to the files within this folder. More...

string	FullName `[get]`
	The full path of this folder. More...

DateTime?	LockAt `[get]`
	When the folder is set to lock. More...

ulong	Id `[get]`
	The folder id. More...

uint	FoldersCount `[get]`
	The number of folders in the folder. More...

string	Name `[get]`
	The name of the folder. More...

ulong?	ParentFolderId `[get]`
	The id of the folder's parent folder, if it exists. More...

DateTime	CreatedAt `[get]`
	When the folder was created. More...

DateTime?	UnlockAt `[get]`
	When the folder is set to unlock. More...

bool?	Hidden `[get]`
	Whether or not the folder is hidden. More...

bool?	HiddenForUser `[get]`
	Whether or not the folder is hidden for its owner. More...

bool?	Locked `[get]`
	Whether or not the folder is locked. More...

bool?	LockedForUser `[get]`
	Whether or not the folder is locked for its owner. More...

bool?	ForSubmissions `[get]`
	Whether or not the folder is designated for assignment submissions. More...

Detailed Description

Represents a folder on the Canvas server. Folders contain CanvasFiles.

Property Documentation

◆ ContextId

ulong UVACanvasAccess.Structures.Files.Folder.ContextId

get

The id of the folder context. Folder.ContextType determines the type of this id.

◆ ContextType

string UVACanvasAccess.Structures.Files.Folder.ContextType

get

The context of the folder; e.g. course, group, user, etc.

◆ CreatedAt

DateTime UVACanvasAccess.Structures.Files.Folder.CreatedAt

get

When the folder was created.

◆ FilesCount

uint UVACanvasAccess.Structures.Files.Folder.FilesCount

get

The number of files in the folder.

◆ FilesUrl

string UVACanvasAccess.Structures.Files.Folder.FilesUrl

get

The URL to the files within this folder.

◆ FoldersCount

uint UVACanvasAccess.Structures.Files.Folder.FoldersCount

get

The number of folders in the folder.

◆ FoldersUrl

string UVACanvasAccess.Structures.Files.Folder.FoldersUrl

get

The URL to this folder.

◆ ForSubmissions

bool? UVACanvasAccess.Structures.Files.Folder.ForSubmissions

get

Whether or not the folder is designated for assignment submissions.

◆ FullName

string UVACanvasAccess.Structures.Files.Folder.FullName

get

The full path of this folder.

◆ Hidden

bool? UVACanvasAccess.Structures.Files.Folder.Hidden

get

Whether or not the folder is hidden.

◆ HiddenForUser

bool? UVACanvasAccess.Structures.Files.Folder.HiddenForUser

get

Whether or not the folder is hidden for its owner.

◆ Id

ulong UVACanvasAccess.Structures.Files.Folder.Id

get

The folder id.

◆ LockAt

DateTime? UVACanvasAccess.Structures.Files.Folder.LockAt

get

When the folder is set to lock.

◆ Locked

bool? UVACanvasAccess.Structures.Files.Folder.Locked

get

Whether or not the folder is locked.

◆ LockedForUser

bool? UVACanvasAccess.Structures.Files.Folder.LockedForUser

get

Whether or not the folder is locked for its owner.

◆ Name

string UVACanvasAccess.Structures.Files.Folder.Name

get

The name of the folder.

◆ ParentFolderId

ulong? UVACanvasAccess.Structures.Files.Folder.ParentFolderId

get

The id of the folder's parent folder, if it exists.

◆ Position

int? UVACanvasAccess.Structures.Files.Folder.Position

get

The visual position of this folder relative to other folders in the same parent folder.

◆ UnlockAt

DateTime? UVACanvasAccess.Structures.Files.Folder.UnlockAt

get

When the folder is set to unlock.

◆ UpdatedAt

DateTime UVACanvasAccess.Structures.Files.Folder.UpdatedAt

get

When the folder was last updated.

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

UVACanvasAccess/Structures/Files/Folder.cs

Public Member Functions

Properties