Represents a file present on the Canvas server. More...

Inheritance diagram for UVACanvasAccess.Structures.Files.CanvasFile:

Collaboration diagram for UVACanvasAccess.Structures.Files.CanvasFile:

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

async Task< bool >	MoveTo (ulong folderId, Api.OnDuplicate onDuplicate)

Task< bool >	MoveTo (Folder folder, Api.OnDuplicate onDuplicate)

async Task< bool >	Rename (string newName, Api.OnDuplicate onDuplicate)

async Task< CanvasFile >	CopyTo (ulong folderId, Api.OnDuplicate onDuplicate)

Task< CanvasFile >	CopyTo (Folder folder, Api.OnDuplicate onDuplicate)

Task< byte[]>	Download ()

Properties
ulong	Id `[get]`
	The file id.

string	Uuid `[get]`
	The file's UUID.

ulong	FolderId `[get]`
	The id of the folder the file is in.

string	DisplayName `[get]`
	The file name, as shown to end users on the web interface.

string	Filename `[get]`
	The file's name.

string	ContentType `[get]`
	The MIME content type of the file.

string	Url `[get]`
	The URL to the file. The file can be downloaded from this URL.

ulong?	Size `[get]`
	The file's size in bytes.

DateTime?	CreatedAt `[get]`
	When the file was created.

DateTime?	UpdatedAt `[get]`
	When the file was last updated.

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

bool	Locked `[get]`
	Whether or not the file is locked.

bool	Hidden `[get]`
	Whether or not the file is hidden.

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

bool	HiddenForUser `[get]`
	Whether or not the file is hidden for the file's owner.

string	ThumbnailUrl `[get]`
	A URL to a thumbnail of the file.

DateTime?	ModifiedAt `[get]`
	When the file was last modified.

string	MimeClass `[get]`
	A simplified ContentType.

string	MediaEntryId `[get]`
	An opaque ID used by third-party systems.

bool	LockedForUser `[get]`
	Whether or not the file is locked for the file's owner.

LockInfo	LockInfo `[get]`
	If the file is locked, a LockInfo object.

string	LockExplanation `[get]`
	If the file is locked, the reason it is locked.

string	PreviewUrl `[get]`
	If the file was submitted through a submission endpoint, a URL to the document preview.

Detailed Description

Represents a file present on the Canvas server.

Member Function Documentation

string UVACanvasAccess.Structures.Files.CanvasFile.ToPrettyString ( )

inline

Returns a pretty, formatted string representation of the object.

string UVACanvasAccess.Structures.Files.CanvasFile.DisplayName

get

The file name, as shown to end users on the web interface.

This is distinct from Filename, the file's true name on the server.

string UVACanvasAccess.Structures.Files.CanvasFile.Filename

get

The file's name.

This is distinct from DisplayName,the name shown on the web interface.

ulong UVACanvasAccess.Structures.Files.CanvasFile.Id

get

The file id.

This is distinct from the CanvasFile.Uuid

string UVACanvasAccess.Structures.Files.CanvasFile.Uuid

get

The file's UUID.

This is distinct from the CanvasFile.Id

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