C# Class Engage.Dnn.Booking.Appointment

Inheritance: IEditableObject

Mostra file Open project: EngageSoftware/Engage-Booking Class Usage Examples

Private Properties

Property	Type	Description
Appointment	System
Appointment	System
Fill	Appointment
Insert	void
Update	void

Public Methods

Method	Description
Accept ( int revisingUserId ) : void	Accepts this Appointment.
ApproveByKey ( System.Guid actionKey ) : Appointment	Accepts or declines an Appointment via the given actionKey.
BeginEdit ( ) : void	Begins an edit on an object.
CanCreateAt ( int moduleId, System.DateTime start, System.DateTime end, int max ) : bool	Determines whether an Appointment can be created at the specified start time until the specified end time.
CancelEdit ( ) : void	Discards changes since the last M:System.ComponentModel.IEditableObject.BeginEdit call.
Create ( int moduleId, int appointmentTypeId, string title, string description, string notes, string address1, string address2, string city, int regionId, string postalCode, string phone, string additionalAddressInfo, string contactStreet, string contactPhone, string requestorName, PhoneType requestorPhoneType, string requestorPhone, string requestorEmail, PhoneType requestorAltPhoneType, string requestorAltPhone, System.DateTime start, System.DateTime end, System.TimeSpan timeZoneOffset, int numberOfParticipants, GroupGender participantGender, bool isPresenterSpecial, string participantInstructions, int numberOfSpecialParticipants, string custom1, string custom2, string custom3, string custom4, string custom5, string custom6, string custom7, string custom8, string custom9, string custom10, bool isAccepted ) : Appointment	Creates the specified Appointment.
Decline ( int revisingUserId ) : void	Declines this Appointment.
Delete ( int appointmentId ) : void	Deletes the specified appointment id.
EndEdit ( ) : void	Pushes changes since the last M:System.ComponentModel.IEditableObject.BeginEdit or M:System.ComponentModel.IBindingList.AddNew call into the underlying object.
Load ( int appointmentId ) : Appointment	Loads the Appointment with the specified appointmentId.
Save ( int revisingUser ) : void	Saves this event.
ToICal ( ) : string	Creates an iCal representation of this appointment.

Private Methods

Method	Description
Appointment ( ) : System	Prevents a default instance of the Appointment class from being created.
Appointment ( int moduleId, int appointmentTypeId, string title, string description, string notes, string address1, string address2, string city, int regionId, string postalCode, string phone, string additionalAddressInfo, string contactStreet, string contactPhone, string requestorName, PhoneType requestorPhoneType, string requestorPhone, string requestorEmail, PhoneType requestorAltPhoneType, string requestorAltPhone, System.DateTime start, System.DateTime end, System.TimeSpan timeZoneOffset, int numberOfParticipants, GroupGender participantGender, bool isPresenterSpecial, string participantInstructions, int numberOfSpecialParticipants, string custom1, string custom2, string custom3, string custom4, string custom5, string custom6, string custom7, string custom8, string custom9, string custom10, bool isAccepted ) : System	Initializes a new instance of the Appointment class.
Fill ( IDataRecord appointmentRecord ) : Appointment	Fills an Appointment with the data in the specified appointmentRecord.
Insert ( int revisingUserId ) : void	Inserts this event.
Update ( int revisingUser ) : void	Updates this event.

Method Details

Accept() public method

Accepts this Appointment.

public Accept ( int revisingUserId ) : void
revisingUserId	int	The ID of the user accepting the .
return	void

ApproveByKey() public static method

Accepts or declines an Appointment via the given actionKey.

public static ApproveByKey ( System.Guid actionKey ) : Appointment
actionKey	System.Guid	The key the corresponds to accepting or declining a specific .
return	Appointment

BeginEdit() public method

Begins an edit on an object.

public BeginEdit ( ) : void
return	void

CanCreateAt() public static method

Determines whether an Appointment can be created at the specified start time until the specified end time.

public static CanCreateAt ( int moduleId, System.DateTime start, System.DateTime end, int max ) : bool
moduleId	int	The ID of the module in which the appointment is to be created.
start	System.DateTime	The start of the new .
end	System.DateTime	The end of the new .
max	int	The maximum appointments allowed for the specified time range
return	bool

CancelEdit() public method

Discards changes since the last M:System.ComponentModel.IEditableObject.BeginEdit call.

public CancelEdit ( ) : void
return	void

Create() public static method

Creates the specified Appointment.

public static Create ( int moduleId, int appointmentTypeId, string title, string description, string notes, string address1, string address2, string city, int regionId, string postalCode, string phone, string additionalAddressInfo, string contactStreet, string contactPhone, string requestorName, PhoneType requestorPhoneType, string requestorPhone, string requestorEmail, PhoneType requestorAltPhoneType, string requestorAltPhone, System.DateTime start, System.DateTime end, System.TimeSpan timeZoneOffset, int numberOfParticipants, GroupGender participantGender, bool isPresenterSpecial, string participantInstructions, int numberOfSpecialParticipants, string custom1, string custom2, string custom3, string custom4, string custom5, string custom6, string custom7, string custom8, string custom9, string custom10, bool isAccepted ) : Appointment
moduleId	int	The module ID.
appointmentTypeId	int	The appointment type ID of this appointment.
title	string	The title of this appointment.
description	string	The description.
notes	string	The notes.
address1	string	The address1.
address2	string	The address2.
city	string	The city of the appointment.
regionId	int	The region id.
postalCode	string	The postal code.
phone	string	The phone number.
additionalAddressInfo	string	The additional address info.
contactStreet	string	The contact street.
contactPhone	string	The contact phone.
requestorName	string	Name of the requestor.
requestorPhoneType	PhoneType	Type of the requestor phone.
requestorPhone	string	The requestor phone.
requestorEmail	string	The requestor email.
requestorAltPhoneType	PhoneType	Type of the requestor alt phone.
requestorAltPhone	string	The requestor alt phone.
start	System.DateTime	The start of the appointment.
end	System.DateTime	The end of the appointment.
timeZoneOffset	System.TimeSpan	The time zone offset.
numberOfParticipants	int	The number of participants.
participantGender	GroupGender	The participant gender.
isPresenterSpecial	bool	The participant flag.
participantInstructions	string	The participant instructions.
numberOfSpecialParticipants	int	The number of special participants.
custom1	string	The first custom field.
custom2	string	The second custom field.
custom3	string	The third custom field.
custom4	string	The fourth custom field.
custom5	string	The fifth custom field.
custom6	string	The sixth custom field.
custom7	string	The seventh custom field.
custom8	string	The eighth custom field.
custom9	string	The ninth custom field.
custom10	string	The tenth custom field.
isAccepted	bool	nullif the has not bee accepted or declined yet, /// otherwise true for an accepted appointment, or false for a declined appointment.
return	Appointment

Decline() public method

Declines this Appointment.

public Decline ( int revisingUserId ) : void
revisingUserId	int	The ID of the user declining the .
return	void

Delete() public static method

Deletes the specified appointment id.

public static Delete ( int appointmentId ) : void
appointmentId	int	The appointment id.
return	void

EndEdit() public method

Pushes changes since the last M:System.ComponentModel.IEditableObject.BeginEdit or M:System.ComponentModel.IBindingList.AddNew call into the underlying object.

public EndEdit ( ) : void
return	void

Load() public static method

Loads the Appointment with the specified appointmentId.

public static Load ( int appointmentId ) : Appointment
appointmentId	int	The ID of the to load.
return	Appointment

Save() public method

Saves this event.

public Save ( int revisingUser ) : void
revisingUser	int	The user who is saving this event.
return	void

ToICal() public method

Creates an iCal representation of this appointment.

public ToICal ( ) : string
return	string