UVACanvasAccess.Structures.Calendar.BasicCalendarEvent Class Reference

More...

Inheritance diagram for UVACanvasAccess.Structures.Calendar.BasicCalendarEvent:

Collaboration diagram for UVACanvasAccess.Structures.Calendar.BasicCalendarEvent:

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

Properties
string	LocationName [get]
	The event's location.
string	LocationAddress [get]
	The event's address.
Properties inherited from UVACanvasAccess.Structures.Calendar.CalendarEvent
ulong	Id [get]
	The event id.
string	Title [get]
	The event title.
DateTime	StartAt [get]
	When the event begins.
DateTime	EndAt [get]
	When the event ends.
string	Type [get]
	The event type; 'event' or 'assignment'.
string	Description [get]
	The event description.
string	ContextCode [get]
	The context code of the event, indicating which calendar the event belongs to. The code can begin with {'user_', 'course_', 'group_'} followed by the appropriate id.
string	EffectiveContextCode [get]
	If applicable, a more specific context code under ContextCode.
IEnumerable< string >	AllContextCodes [get]
	All context codes this event is under.
CalendarState?	WorkflowState [get]
bool	Hidden [get]
	Whether the event is hidden from the calendar.
string	ParentEventId [get]
	If the event has a parent, such as a timeslot or a course-level event above a section-level event, its id.
uint?	ChildEventsCount [get]
	The amount of child events.
IEnumerable< CalendarEvent >	ChildEvents [get]
	The child events. For timeslots, these will be any reservations. For a course-level event, these will be section-level events.
string	Url [get]
	The API url for this event.
string	HtmlUrl [get]
	The Canvas web url for this event.
DateTime?	AllDayDate [get]
	The date of this event.
bool	AllDay [get]
	Whether this event is all-day.
DateTime	CreatedAt [get]
	When the event was created.
DateTime	UpdatedAt [get]
	When the event was last updated.

Additional Inherited Members
Protected Member Functions inherited from UVACanvasAccess.Structures.Calendar.CalendarEvent
	CalendarEvent (Api api, CalendarEventModel model)
Protected Attributes inherited from UVACanvasAccess.Structures.Calendar.CalendarEvent
readonly Api	Api

Detailed Description

Member Function Documentation

ToPrettyString()

override string UVACanvasAccess.Structures.Calendar.BasicCalendarEvent.ToPrettyString ( )

inlinevirtual

Returns a pretty, formatted string representation of the object.

Returns

The formatted string.

Reimplemented from UVACanvasAccess.Structures.Calendar.CalendarEvent.

Reimplemented in UVACanvasAccess.Structures.Calendar.TimeSlotCalendarEvent, and UVACanvasAccess.Structures.Calendar.UserReservationCalendarEvent.

---

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

• UVACanvasAccess/Structures/Calendar/BasicCalendarEvent.cs