UVACanvasAccess
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
UVACanvasAccess.Structures.Calendar.UserReservationCalendarEvent Class Reference

Represents a user appointment within a TimeSlotCalendarEvent of an appointment group. More...

Inheritance diagram for UVACanvasAccess.Structures.Calendar.UserReservationCalendarEvent:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.Calendar.UserReservationCalendarEvent:
Collaboration graph
[legend]

Public Member Functions

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

 

Properties

ulong AppointmentGroupId [get]
 The id of the appointment group this event belongs to.
 
string AppointmentGroupUrl [get]
 The API url of the appointment group this event belongs to.
 
bool? CanManageAppointmentGroup [get]
 
User User [get]
 The user who made the reservation.
 
- Properties inherited from UVACanvasAccess.Structures.Calendar.BasicCalendarEvent
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.
 
CalendarStateWorkflowState [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< CalendarEventChildEvents [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

Represents a user appointment within a TimeSlotCalendarEvent of an appointment group.

Member Function Documentation

◆ ToPrettyString()

override string UVACanvasAccess.Structures.Calendar.UserReservationCalendarEvent.ToPrettyString ( )
inlinevirtual

Returns a pretty, formatted string representation of the object.

Returns
The formatted string.

Reimplemented from UVACanvasAccess.Structures.Calendar.BasicCalendarEvent.


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