UVACanvasAccess.Structures.SisImports.SisImport Class Reference

Represents a SIS import job. More...

Inheritance diagram for UVACanvasAccess.Structures.SisImports.SisImport:

Collaboration diagram for UVACanvasAccess.Structures.SisImports.SisImport:

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

Properties
ulong	Id [get]
	The import id.
DateTime?	CreatedAt [get]
	When the import was created.
DateTime?	EndedAt [get]
	When the import finished, if at all.
DateTime?	UpdatedAt [get]
	When the import was last updated.
SisImportState	WorkflowState [get]
	The import state.
SisImportData	Data [get]
	The import data.
SisImportStatistics	Statistics [get]
	The import statistics.
long?	Progress [get]
	The progress of the import, out of 100.
object	ErrorsAttachment [get]
	The error attachment.
User	User [get]
	The user who initiated the import.
IEnumerable< SisImportMessage >	ProcessingWarnings [get]
	Any warnings raised after the import has completed.
IEnumerable< SisImportMessage >	ProcessingErrors [get]
	Any errors raised after the import has completed.
bool?	BatchMode [get]
	Whether the import was run in batch mode.
long?	BatchModeTermId [get]
	If running in batch mode, the term id the batch was limited to.
bool?	MultiTermBatchMode [get]
	Whether multi-term batch mode is enabled.
bool?	SkipDeletes [get]
	Whether the import will skip any deletes.
bool?	OverrideSisStickiness [get]
	Whether the import will override SIS stickiness.
bool?	AddSisStickiness [get]
	Whether the import add override SIS stickiness.
bool?	ClearSisStickiness [get]
	Whether the import will remove SIS stickiness.
bool?	DiffingThresholdExceeded [get]
	Whether a diffing job failed due to an exceeded threshold.
string	DiffingDataSetIdentifier [get]
	The id of the dataset that this SIS batch diffs against.
ulong?	DiffedAgainstImportId [get]
	The id of the import that this SIS batch diffs against.
IEnumerable< object >	CsvAttachments [get]
	Attached files for processing.

Detailed Description

Represents a SIS import job.

Member Function Documentation

ToPrettyString()

string UVACanvasAccess.Structures.SisImports.SisImport.ToPrettyString ( )

inline

Returns a pretty, formatted string representation of the object.

Returns

The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

Property Documentation

BatchMode

bool? UVACanvasAccess.Structures.SisImports.SisImport.BatchMode

get

Whether the import was run in batch mode.

Normally, when the import file is missing an entry currently present in Canvas, the entry is left alone. In batch mode, it will be deleted instead.

---

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

• UVACanvasAccess/Structures/SisImports/SisImport.cs