Inheritance diagram for UVACanvasAccess.Structures.Reports.Report:

Collaboration diagram for UVACanvasAccess.Structures.Reports.Report:

Public Member Functions
Task< Report >	Refresh ()
	Fetches the status of this report using Api.GetReportStatus. More...

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

Properties
ulong	Id `[get]`
	The report id. More...

string	ReportType `[get]`
	The type, or title, of the report. More...

string	FileUrl `[get]`
	If the report is complete; the url from which the report can be downloaded. More...

FileAttachment	Attachment `[get]`
	If the report is complete, the FileAttachment instance representing the complete report file. More...

string	Status `[get]`
	The report status. More...

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

DateTime?	StartedAt `[get]`
	When the report was started. More...

DateTime?	EndedAt `[get]`
	When the report was completed. More...

Dictionary< string, JToken >	Parameters `[get]`
	The optional set of parameters provided to this report. More...

double?	Progress `[get]`
	The report progress, out of 100. More...

ulong?	CurrentLine `[get]`
	The current line size of the report. More...

Member Function Documentation

◆ Refresh()

Task<Report> UVACanvasAccess.Structures.Reports.Report.Refresh ( )

inline

Fetches the status of this report using Api.GetReportStatus.

Returns: A task containing the updated Report instance.

◆ ToPrettyString()

string UVACanvasAccess.Structures.Reports.Report.ToPrettyString ( )

inline

Returns a pretty, formatted string representation of the object.

Returns: The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

Property Documentation

◆ Attachment

FileAttachment UVACanvasAccess.Structures.Reports.Report.Attachment

get

If the report is complete, the FileAttachment instance representing the complete report file.

◆ CreatedAt

DateTime? UVACanvasAccess.Structures.Reports.Report.CreatedAt

get

When the report was created.

◆ CurrentLine

ulong? UVACanvasAccess.Structures.Reports.Report.CurrentLine

get

The current line size of the report.

◆ EndedAt

DateTime? UVACanvasAccess.Structures.Reports.Report.EndedAt

get

When the report was completed.

◆ FileUrl

string UVACanvasAccess.Structures.Reports.Report.FileUrl

get

If the report is complete; the url from which the report can be downloaded.

◆ Id

ulong UVACanvasAccess.Structures.Reports.Report.Id

get

The report id.

◆ Parameters

Dictionary<string, JToken> UVACanvasAccess.Structures.Reports.Report.Parameters

get

The optional set of parameters provided to this report.

◆ Progress

double? UVACanvasAccess.Structures.Reports.Report.Progress

get

The report progress, out of 100.

◆ ReportType

string UVACanvasAccess.Structures.Reports.Report.ReportType

get

The type, or title, of the report.

◆ StartedAt

DateTime? UVACanvasAccess.Structures.Reports.Report.StartedAt

get

When the report was started.

◆ Status

string UVACanvasAccess.Structures.Reports.Report.Status

get

The report status.

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

UVACanvasAccess/Structures/Reports/Report.cs

Public Member Functions

Properties