Represents a possible time-slot appointment within an appointment group. Actual reserved appointments within this time-slot are represented by UserReservationCalendarEvent. More...
Inheritance diagram for UVACanvasAccess.Structures.Calendar.TimeSlotCalendarEvent:
Collaboration diagram for UVACanvasAccess.Structures.Calendar.TimeSlotCalendarEvent:
Public Member Functions | |
| override string | ToPrettyString () |
| Returns a pretty, formatted string representation of the object. | |
Properties | |
| ulong | AppointmentGroupId [get] |
| The id of the appointment group this event belongs to. More... | |
| string | AppointmentGroupUrl [get] |
| The API url of the appointment group this event belongs to. More... | |
| bool? | CanManageAppointmentGroup [get] |
| string | ReserveUrl [get] |
| The API url which can be followed to reserve this time-slot. More... | |
| bool? | Reserved [get] |
| Whether this slot has been reserved. More... | |
| uint? | ParticipantsPerAppointment [get] |
| The maximum amount of participants which may reserve this slot. More... | |
| uint? | AvailableSlots [get] |
| The amount of participants which may yet reserve this slot. More... | |
| IEnumerable< UserReservationCalendarEvent > | Reservations [get] |
| Any reservations which have been made. More... | |
 Properties inherited from UVACanvasAccess.Structures.Calendar.BasicCalendarEvent | |
| string | LocationName [get] |
| The event's location. More... | |
| string | LocationAddress [get] |
| The event's address. More... | |
| Properties inherited from UVACanvasAccess.Structures.Calendar.CalendarEvent | |
| 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... | |
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 possible time-slot appointment within an appointment group. Actual reserved appointments within this time-slot are represented by UserReservationCalendarEvent.
Property Documentation
◆ AppointmentGroupId
|
get |
The id of the appointment group this event belongs to.
◆ AppointmentGroupUrl
|
get |
The API url of the appointment group this event belongs to.
◆ AvailableSlots
|
get |
The amount of participants which may yet reserve this slot.
◆ ParticipantsPerAppointment
|
get |
The maximum amount of participants which may reserve this slot.
◆ Reservations
|
get |
Any reservations which have been made.
◆ Reserved
|
get |
Whether this slot has been reserved.
◆ ReserveUrl
|
get |
The API url which can be followed to reserve this time-slot.
The documentation for this class was generated from the following file:
- UVACanvasAccess/Structures/Calendar/TimeSlotCalendarEvent.cs
