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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

string	MimeClass `[get]`
	A simplified ContentType. More...

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

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

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

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

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

Detailed Description

Represents a file present on the Canvas server.

Member Function Documentation

◆ ToPrettyString()

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

inline

Returns a pretty, formatted string representation of the object.

Returns: The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

Property Documentation

◆ ContentType

string UVACanvasAccess.Structures.Files.CanvasFile.ContentType

get

The MIME content type of the file.

◆ CreatedAt

DateTime? UVACanvasAccess.Structures.Files.CanvasFile.CreatedAt

get

When the file was created.

◆ DisplayName

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.

◆ Filename

string UVACanvasAccess.Structures.Files.CanvasFile.Filename

get

The file's name.

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

◆ FolderId

ulong UVACanvasAccess.Structures.Files.CanvasFile.FolderId

get

The id of the folder the file is in.

◆ Hidden

bool UVACanvasAccess.Structures.Files.CanvasFile.Hidden

get

Whether or not the file is hidden.

◆ HiddenForUser

bool UVACanvasAccess.Structures.Files.CanvasFile.HiddenForUser

get

Whether or not the file is hidden for the file's owner.

◆ Id

ulong UVACanvasAccess.Structures.Files.CanvasFile.Id

get

The file id.

This is distinct from the CanvasFile.Uuid

◆ LockAt

DateTime? UVACanvasAccess.Structures.Files.CanvasFile.LockAt

get

When the file is set to lock.

◆ Locked

bool UVACanvasAccess.Structures.Files.CanvasFile.Locked

get

Whether or not the file is locked.

◆ LockedForUser

bool UVACanvasAccess.Structures.Files.CanvasFile.LockedForUser

get

Whether or not the file is locked for the file's owner.

◆ LockExplanation

string UVACanvasAccess.Structures.Files.CanvasFile.LockExplanation

get

If the file is locked, the reason it is locked.

◆ LockInfo

LockInfo UVACanvasAccess.Structures.Files.CanvasFile.LockInfo

get

If the file is locked, a LockInfo object.

◆ MediaEntryId

string UVACanvasAccess.Structures.Files.CanvasFile.MediaEntryId

get

An opaque ID used by third-party systems.

◆ MimeClass

string UVACanvasAccess.Structures.Files.CanvasFile.MimeClass

get

A simplified ContentType.

◆ ModifiedAt

DateTime? UVACanvasAccess.Structures.Files.CanvasFile.ModifiedAt

get

When the file was last modified.

◆ PreviewUrl

string UVACanvasAccess.Structures.Files.CanvasFile.PreviewUrl

get

If the file was submitted through a submission endpoint, a URL to the document preview.

◆ Size

ulong UVACanvasAccess.Structures.Files.CanvasFile.Size

get

The file's size in bytes.

◆ ThumbnailUrl

string UVACanvasAccess.Structures.Files.CanvasFile.ThumbnailUrl

get

A URL to a thumbnail of the file.

◆ UnlockAt

DateTime? UVACanvasAccess.Structures.Files.CanvasFile.UnlockAt

get

When the file is set to unlock.

◆ UpdatedAt

DateTime? UVACanvasAccess.Structures.Files.CanvasFile.UpdatedAt

get

When the file was last updated.

◆ Url

string UVACanvasAccess.Structures.Files.CanvasFile.Url

get

The URL to the file. The file can be downloaded from this URL.

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

UVACanvasAccess/Structures/Files/CanvasFile.cs

Public Member Functions

Properties