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

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

Inheritance diagram for UVACanvasAccess.Structures.Files.Folder:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.Files.Folder:
Collaboration graph
[legend]

Public Member Functions

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

 

Properties

string ContextType [get]
 The context of the folder; e.g. course, group, user, etc.
 
ulong ContextId [get]
 The id of the folder context. Folder.ContextType determines the type of this id.
 
uint FilesCount [get]
 The number of files in the folder.
 
int? Position [get]
 The visual position of this folder relative to other folders in the same parent folder.
 
DateTime UpdatedAt [get]
 When the folder was last updated.
 
string FoldersUrl [get]
 The URL to this folder.
 
string FilesUrl [get]
 The URL to the files within this folder.
 
string FullName [get]
 The full path of this folder.
 
DateTime? LockAt [get]
 When the folder is set to lock.
 
ulong Id [get]
 The folder id.
 
uint FoldersCount [get]
 The number of folders in the folder.
 
string Name [get]
 The name of the folder.
 
ulong? ParentFolderId [get]
 The id of the folder's parent folder, if it exists.
 
DateTime CreatedAt [get]
 When the folder was created.
 
DateTime? UnlockAt [get]
 When the folder is set to unlock.
 
bool? Hidden [get]
 Whether or not the folder is hidden.
 
bool? HiddenForUser [get]
 Whether or not the folder is hidden for its owner.
 
bool? Locked [get]
 Whether or not the folder is locked.
 
bool? LockedForUser [get]
 Whether or not the folder is locked for its owner.
 
bool? ForSubmissions [get]
 Whether or not the folder is designated for assignment submissions.
 

Detailed Description

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

Member Function Documentation

◆ ToPrettyString()

string UVACanvasAccess.Structures.Files.Folder.ToPrettyString ( )
inline

Returns a pretty, formatted string representation of the object.

Returns
The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.


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