UVACanvasAccess
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
UVACanvasAccess.Structures.Reports.Report Class Reference
Inheritance diagram for UVACanvasAccess.Structures.Reports.Report:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.Reports.Report:
Collaboration graph
[legend]

Public Member Functions

Task< ReportRefresh ()
 Fetches the status of this report using Api.GetReportStatus.
 
string ToPrettyString ()
 Returns a pretty, formatted string representation of the object.
 

Properties

ulong Id [get]
 The report id.
 
string ReportType [get]
 The type, or title, of the report.
 
string FileUrl [get]
 If the report is complete; the url from which the report can be downloaded.
 
FileAttachment Attachment [get]
 If the report is complete, the FileAttachment instance representing the complete report file.
 
string Status [get]
 The report status.
 
DateTime? CreatedAt [get]
 When the report was created.
 
DateTime? StartedAt [get]
 When the report was started.
 
DateTime? EndedAt [get]
 When the report was completed.
 
Dictionary< string, JToken > Parameters [get]
 The optional set of parameters provided to this report.
 
double? Progress [get]
 The report progress, out of 100.
 
ulong? CurrentLine [get]
 The current line size of the report.
 

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.


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