Represents a calendar event. More...

Inheritance diagram for UVACanvasAccess.Structures.Calendar.CalendarEvent:

[legend]

Collaboration diagram for UVACanvasAccess.Structures.Calendar.CalendarEvent:

[legend]

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

Protected Member Functions
	CalendarEvent (Api api, CalendarEventModel model)

Protected Attributes
readonly Api	Api

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

string	Title `[get]`
	The event title. More...

DateTime	StartAt `[get]`
	When the event begins. More...

DateTime	EndAt `[get]`
	When the event ends. More...

string	Type `[get]`
	The event type; 'event' or 'assignment'. More...

string	Description `[get]`
	The event description. More...

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

string	EffectiveContextCode `[get]`
	If applicable, a more specific context code under ContextCode. More...

IEnumerable< string >	AllContextCodes `[get]`
	All context codes this event is under. More...

CalendarState?	WorkflowState `[get]`

bool	Hidden `[get]`
	Whether the event is hidden from the calendar. More...

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

uint?	ChildEventsCount `[get]`
	The amount of child events. More...

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

string	Url `[get]`
	The API url for this event. More...

string	HtmlUrl `[get]`
	The Canvas web url for this event. More...

DateTime?	AllDayDate `[get]`
	The date of this event. More...

bool	AllDay `[get]`
	Whether this event is all-day. More...

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

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

Detailed Description

Represents a calendar event.

Property Documentation

◆ AllContextCodes

IEnumerable<string> UVACanvasAccess.Structures.Calendar.CalendarEvent.AllContextCodes

get

All context codes this event is under.

See also: ContextCode

◆ AllDay

bool UVACanvasAccess.Structures.Calendar.CalendarEvent.AllDay

get

Whether this event is all-day.

◆ AllDayDate

DateTime? UVACanvasAccess.Structures.Calendar.CalendarEvent.AllDayDate

get

The date of this event.

◆ ChildEvents

IEnumerable<CalendarEvent> UVACanvasAccess.Structures.Calendar.CalendarEvent.ChildEvents

get

The child events. For timeslots, these will be any reservations. For a course-level event, these will be section-level events.

◆ ChildEventsCount

uint? UVACanvasAccess.Structures.Calendar.CalendarEvent.ChildEventsCount

get

The amount of child events.

◆ ContextCode

string UVACanvasAccess.Structures.Calendar.CalendarEvent.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.

◆ CreatedAt

DateTime UVACanvasAccess.Structures.Calendar.CalendarEvent.CreatedAt

get

When the event was created.

◆ Description

string UVACanvasAccess.Structures.Calendar.CalendarEvent.Description

get

The event description.

◆ EffectiveContextCode

string UVACanvasAccess.Structures.Calendar.CalendarEvent.EffectiveContextCode

get

If applicable, a more specific context code under ContextCode.

◆ EndAt

DateTime UVACanvasAccess.Structures.Calendar.CalendarEvent.EndAt

get

When the event ends.

◆ Hidden

bool UVACanvasAccess.Structures.Calendar.CalendarEvent.Hidden

get

Whether the event is hidden from the calendar.

◆ HtmlUrl

string UVACanvasAccess.Structures.Calendar.CalendarEvent.HtmlUrl

get

The Canvas web url for this event.

◆ Id

ulong UVACanvasAccess.Structures.Calendar.CalendarEvent.Id

get

The event id.

◆ ParentEventId

string UVACanvasAccess.Structures.Calendar.CalendarEvent.ParentEventId

get

If the event has a parent, such as a timeslot or a course-level event above a section-level event, its id.

◆ StartAt

DateTime UVACanvasAccess.Structures.Calendar.CalendarEvent.StartAt

get

When the event begins.

◆ Title

string UVACanvasAccess.Structures.Calendar.CalendarEvent.Title

get

The event title.

◆ Type

string UVACanvasAccess.Structures.Calendar.CalendarEvent.Type

get

The event type; 'event' or 'assignment'.

◆ UpdatedAt

DateTime UVACanvasAccess.Structures.Calendar.CalendarEvent.UpdatedAt

get

When the event was last updated.

◆ Url

string UVACanvasAccess.Structures.Calendar.CalendarEvent.Url

get

The API url for this event.

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

UVACanvasAccess/Structures/Calendar/CalendarEvent.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties