UVACanvasAccess.Builders.AppointmentGroupBuilder Class Reference

A class used to create or edit appointment groups using the builder pattern. When all desired fields are set, call Post to execute the operation. More...

Public Member Functions
AppointmentGroupBuilder	WithSubContextCodes (IEnumerable< EventContext > subContexts)
	The subcontexts this group should be linked to. More...
AppointmentGroupBuilder	WithDescription (string description)
	The description of this group. More...
AppointmentGroupBuilder	WithLocationName (string location)
	The name of the location of this group. More...
AppointmentGroupBuilder	WithLocationAddress (string address)
	The address of the location of this group. More...
AppointmentGroupBuilder	Published ()
	Irreversibly publish this group. More...
AppointmentGroupBuilder	WithMaxParticipants (uint participants)
	The maximum amount of participants per appointment. More...
AppointmentGroupBuilder	WithMaxAppointments (uint appointments)
	The maximum amount of appointments any participant may schedule. More...
AppointmentGroupBuilder	WithMinAppointments (uint appointments)
	The minimum amount of appointments any participant must schedule. More...
AppointmentGroupBuilder	AddTimeSlot (DateTime start, DateTime end)
	Add one time slot to the appointment group that can be scheduled by participants. More...
AppointmentGroupBuilder	WithProtectedVisibility (bool @protected=true)
	Whether the participants in this group should have protected or private visibility. More...
Task< AppointmentGroup >	Post ()
	Performs the operation. More...

Detailed Description

A class used to create or edit appointment groups using the builder pattern. When all desired fields are set, call Post to execute the operation.

Member Function Documentation

AddTimeSlot()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.AddTimeSlot ( DateTime  start, DateTime  end  )

inline

Add one time slot to the appointment group that can be scheduled by participants.

Parameters

start	The beginning of the time slot.
end	The end of the time slot.

Returns

This builder.

Post()

Task<AppointmentGroup> UVACanvasAccess.Builders.AppointmentGroupBuilder.Post ( )

inline

Performs the operation.

Returns

The newly created or edited appointment group.

Published()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.Published ( )

inline

Irreversibly publish this group.

Returns

This builder.

WithDescription()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.WithDescription ( string  description )

inline

The description of this group.

Returns

This builder.

WithLocationAddress()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.WithLocationAddress ( string  address )

inline

The address of the location of this group.

Returns

This builder.

WithLocationName()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.WithLocationName ( string  location )

inline

The name of the location of this group.

Returns

This builder.

WithMaxAppointments()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.WithMaxAppointments ( uint  appointments )

inline

The maximum amount of appointments any participant may schedule.

Returns

This builder.

WithMaxParticipants()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.WithMaxParticipants ( uint  participants )

inline

The maximum amount of participants per appointment.

Returns

This builder.

WithMinAppointments()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.WithMinAppointments ( uint  appointments )

inline

The minimum amount of appointments any participant must schedule.

Returns

This builder.

WithProtectedVisibility()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.WithProtectedVisibility ( bool @  protected = true )

inline

Whether the participants in this group should have protected or private visibility.

Returns

This builder.

WithSubContextCodes()

AppointmentGroupBuilder UVACanvasAccess.Builders.AppointmentGroupBuilder.WithSubContextCodes ( IEnumerable< EventContext >  subContexts )

inline

The subcontexts this group should be linked to.

Returns

This builder.

---

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

• UVACanvasAccess/Builders/AppointmentGroupBuilder.cs