UVACanvasAccess
Public Member Functions | Properties | List of all members
UVACanvasAccess.Structures.Appointments.AppointmentGroup Class Reference

Represents an appointment group. More...

Inheritance diagram for UVACanvasAccess.Structures.Appointments.AppointmentGroup:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.Appointments.AppointmentGroup:
Collaboration graph
[legend]

Public Member Functions

IAsyncEnumerable< UserStreamUserParticipants ()
 Stream the list of participants in this appointment group. More...
 
IAsyncEnumerable< GroupStreamGroupParticipants ()
 Stream the list of group participants in this appointment group. More...
 
string ToPrettyString ()
 Returns a pretty, formatted string representation of the object.
 

Properties

ulong Id [get]
 The appointment group id. More...
 
string Title [get]
 The title. More...
 
DateTime StartAt [get]
 When the appointment group begins. More...
 
DateTime EndAt [get]
 When the appointment group ends. More...
 
string Description [get]
 The description. More...
 
string LocationName [get]
 The location at which the appointment group takes place. More...
 
string LocationAddress [get]
 The address of the location. More...
 
uint? ParticipantCount [get]
 The participant count. More...
 
IEnumerable< AppointmentReservedTimes [get]
 The set of reserved appointments. More...
 
IEnumerable< EventContextContextCodes [get]
 The set of event contexts. More...
 
IEnumerable< EventContextSubContextCodes [get]
 The set of sub-event contexts. More...
 
string WorkflowState [get]
 The state of the appointment group. More...
 
bool? RequiringAction [get]
 Whether or not the appointment group requires action from attendees. More...
 
uint AppointmentsCount [get]
 The amount of appointments. More...
 
IEnumerable< TimeSlotCalendarEventAppointments [get]
 The list of appointments, in the form of calendar events. More...
 
IEnumerable< TimeSlotCalendarEventNewAppointments [get]
 The list of new appointments, in the form of calendar events. More...
 
uint? MaxAppointmentsPerParticipant [get]
 The max appointments per participant. More...
 
uint? MinAppointmentsPerParticipant [get]
 The minimum appointments per participant. More...
 
uint? ParticipantsPerAppointment [get]
 The amount of participants per appointment. More...
 
string ParticipantVisibility [get]
 The participant visibility. More...
 
string ParticipantType [get]
 The participant type. More...
 
string Url [get]
 The url. More...
 
string HtmlUrl [get]
 The url to the web interface. More...
 
DateTime CreatedAt [get]
 The creation date. More...
 
DateTime UpdatedAt [get]
 The update date. More...
 

Detailed Description

Represents an appointment group.

Member Function Documentation

◆ StreamGroupParticipants()

IAsyncEnumerable<Group> UVACanvasAccess.Structures.Appointments.AppointmentGroup.StreamGroupParticipants ( )
inline

Stream the list of group participants in this appointment group.

Returns
The stream of groups.

◆ StreamUserParticipants()

IAsyncEnumerable<User> UVACanvasAccess.Structures.Appointments.AppointmentGroup.StreamUserParticipants ( )
inline

Stream the list of participants in this appointment group.

Returns
The stream of users.

Property Documentation

◆ Appointments

IEnumerable<TimeSlotCalendarEvent> UVACanvasAccess.Structures.Appointments.AppointmentGroup.Appointments
get

The list of appointments, in the form of calendar events.

◆ AppointmentsCount

uint UVACanvasAccess.Structures.Appointments.AppointmentGroup.AppointmentsCount
get

The amount of appointments.

◆ ContextCodes

IEnumerable<EventContext> UVACanvasAccess.Structures.Appointments.AppointmentGroup.ContextCodes
get

The set of event contexts.

◆ CreatedAt

DateTime UVACanvasAccess.Structures.Appointments.AppointmentGroup.CreatedAt
get

The creation date.

◆ Description

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.Description
get

The description.

◆ EndAt

DateTime UVACanvasAccess.Structures.Appointments.AppointmentGroup.EndAt
get

When the appointment group ends.

◆ HtmlUrl

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.HtmlUrl
get

The url to the web interface.

◆ Id

ulong UVACanvasAccess.Structures.Appointments.AppointmentGroup.Id
get

The appointment group id.

◆ LocationAddress

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.LocationAddress
get

The address of the location.

◆ LocationName

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.LocationName
get

The location at which the appointment group takes place.

◆ MaxAppointmentsPerParticipant

uint? UVACanvasAccess.Structures.Appointments.AppointmentGroup.MaxAppointmentsPerParticipant
get

The max appointments per participant.

◆ MinAppointmentsPerParticipant

uint? UVACanvasAccess.Structures.Appointments.AppointmentGroup.MinAppointmentsPerParticipant
get

The minimum appointments per participant.

◆ NewAppointments

IEnumerable<TimeSlotCalendarEvent> UVACanvasAccess.Structures.Appointments.AppointmentGroup.NewAppointments
get

The list of new appointments, in the form of calendar events.

◆ ParticipantCount

uint? UVACanvasAccess.Structures.Appointments.AppointmentGroup.ParticipantCount
get

The participant count.

◆ ParticipantsPerAppointment

uint? UVACanvasAccess.Structures.Appointments.AppointmentGroup.ParticipantsPerAppointment
get

The amount of participants per appointment.

◆ ParticipantType

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.ParticipantType
get

The participant type.

◆ ParticipantVisibility

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.ParticipantVisibility
get

The participant visibility.

◆ RequiringAction

bool? UVACanvasAccess.Structures.Appointments.AppointmentGroup.RequiringAction
get

Whether or not the appointment group requires action from attendees.

◆ ReservedTimes

IEnumerable<Appointment> UVACanvasAccess.Structures.Appointments.AppointmentGroup.ReservedTimes
get

The set of reserved appointments.

◆ StartAt

DateTime UVACanvasAccess.Structures.Appointments.AppointmentGroup.StartAt
get

When the appointment group begins.

◆ SubContextCodes

IEnumerable<EventContext> UVACanvasAccess.Structures.Appointments.AppointmentGroup.SubContextCodes
get

The set of sub-event contexts.

◆ Title

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.Title
get

The title.

◆ UpdatedAt

DateTime UVACanvasAccess.Structures.Appointments.AppointmentGroup.UpdatedAt
get

The update date.

◆ Url

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.Url
get

The url.

◆ WorkflowState

string UVACanvasAccess.Structures.Appointments.AppointmentGroup.WorkflowState
get

The state of the appointment group.


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