C# Class Engage.Dnn.Booking.AppointmentSqlDataProvider

A SQL implementation of data access for the Appointment and related types

Afficher le fichier Open project: EngageSoftware/Engage-Booking Class Usage Examples

Méthodes publiques

Méthode	Description
AcceptAppointment ( int appointmentId, int revisingUserId ) : void	Accepts or declines the Appointment with the given appointmentId.
ApproveByKey ( System.Guid actionKey ) : IDataReader	Accepts or declines an Appointment via the given actionKey.
ClearQueuedEmail ( int queueId ) : void	Clears a queued email.
DeclineAppointment ( int appointmentId, int revisingUserId ) : void	Accepts or declines the Appointment with the given appointmentId.
DeleteAppointment ( int appointmentId ) : void	Deletes the appointment with the given appointmentId.
DeleteAppointmentType ( int appointmentTypeId ) : void	Deletes the type of the appointment.
GetAppointment ( int appointmentId ) : IDataReader	Gets the appointment with the given appointmentId.
GetAppointmentType ( int appointmentTypeId, int moduleId ) : IDataReader	Gets the appointment type with the given appointmentTypeId and moduleId.
GetAppointments ( int moduleId, bool isAccepted, string sortExpression, int pageSize, int pageIndex ) : IDataReader	Gets a page of the appointments for a given moduleId.
GetAppointments ( int moduleId, string sortExpression, int pageSize, int pageIndex ) : IDataReader	Gets a page of the appointments for a given moduleId.
GetAppointmentsByDateRange ( int moduleId, System.DateTime startDateTime, System.DateTime endDateTime ) : DataTable	Gets all appointments within a given date range.
GetConcurrentAppointments ( int moduleId, System.DateTime startDateTime, System.DateTime endDateTime ) : IDataReader	Gets the concurrent appointments.
InsertAppointment ( Appointment appointment, int revisingUserId ) : IDataReader	Inserts the given appointment into the ol' database.
InsertAppointmentType ( AppointmentType appointmentType, int revisingUserId, int moduleId ) : void	Inserts an appointmentType into SkyNet Central Repository (The database)
QueueEmail ( int portalId, string toList, string subject, string body, string attachment ) : void	Queues an email.
UpdateAppointment ( Appointment appointment, int revisingUserId ) : void	Updates the given appointment's record.
UpdateAppointmentType ( AppointmentType appointmentType, int revisingUserId ) : void	Updates the type of the appointment.

Private Methods

Méthode	Description
GetAppointmentTypes ( int moduleId ) : IDataReader
GetQueuedEmails ( ) : IDataReader

Method Details

AcceptAppointment() public static méthode

Accepts or declines the Appointment with the given appointmentId.

public static AcceptAppointment ( int appointmentId, int revisingUserId ) : void
appointmentId	int	The ID of the to accept or decline.
revisingUserId	int	The ID of the user setting the acceptance the .
Résultat	void

ApproveByKey() public static méthode

Accepts or declines an Appointment via the given actionKey.

public static ApproveByKey ( System.Guid actionKey ) : IDataReader
actionKey	System.Guid	The key the corresponds to accepting or declining a specific .
Résultat	IDataReader

ClearQueuedEmail() public static méthode

Clears a queued email.

public static ClearQueuedEmail ( int queueId ) : void
queueId	int	The queueId.
Résultat	void

DeclineAppointment() public static méthode

Accepts or declines the Appointment with the given appointmentId.

public static DeclineAppointment ( int appointmentId, int revisingUserId ) : void
appointmentId	int	The ID of the to accept or decline.
revisingUserId	int	The ID of the user setting the acceptance the .
Résultat	void

DeleteAppointment() public static méthode

Deletes the appointment with the given appointmentId.

public static DeleteAppointment ( int appointmentId ) : void
appointmentId	int	The ID of the appointment to delete.
Résultat	void

DeleteAppointmentType() public static méthode

Deletes the type of the appointment.

public static DeleteAppointmentType ( int appointmentTypeId ) : void
appointmentTypeId	int	The appointment type id.
Résultat	void

GetAppointment() public static méthode

Gets the appointment with the given appointmentId.

public static GetAppointment ( int appointmentId ) : IDataReader
appointmentId	int	The ID of the appointment to retrieve.
Résultat	IDataReader

GetAppointmentType() public static méthode

Gets the appointment type with the given appointmentTypeId and moduleId.

public static GetAppointmentType ( int appointmentTypeId, int moduleId ) : IDataReader
appointmentTypeId	int	The ID of the appointment type.
moduleId	int	The module id.
Résultat	IDataReader

GetAppointments() public static méthode

Gets a page of the appointments for a given moduleId.

public static GetAppointments ( int moduleId, bool isAccepted, string sortExpression, int pageSize, int pageIndex ) : IDataReader
moduleId	int	The ID of the module to which the appointments belong.
isAccepted	bool	/// true to retrieve only accepted appointments, /// false to retrieve only declines appointments, /// or null to retrieve only those appointments which have been neither accepted nor declined. /// Use to retrieve appointments without regard to the IsAccepted field. ///
sortExpression	string	A comma-delimited list of the columns by which to sort.
pageSize	int	Size of the page, or null to retrieve all appointments.
pageIndex	int	Index of the page, or null to retrieve all appointments.
Résultat	IDataReader

GetAppointments() public static méthode

Gets a page of the appointments for a given moduleId.

public static GetAppointments ( int moduleId, string sortExpression, int pageSize, int pageIndex ) : IDataReader
moduleId	int	The ID of the module to which the appointments belong.
sortExpression	string	A comma-delimited list of the columns by which to sort.
pageSize	int	Size of the page, or null to retrieve all appointments.
pageIndex	int	Index of the page, or null to retrieve all appointments.
Résultat	IDataReader

GetAppointmentsByDateRange() public static méthode

Gets all appointments within a given date range.

public static GetAppointmentsByDateRange ( int moduleId, System.DateTime startDateTime, System.DateTime endDateTime ) : DataTable
moduleId	int	The ID of the module to which the appointments belong.
startDateTime	System.DateTime	The beginning datetime of the range.
endDateTime	System.DateTime	The ending datetime of the range.
Résultat	System.Data.DataTable

GetConcurrentAppointments() public static méthode

Gets the concurrent appointments.

public static GetConcurrentAppointments ( int moduleId, System.DateTime startDateTime, System.DateTime endDateTime ) : IDataReader
moduleId	int	The module id.
startDateTime	System.DateTime	The start date time.
endDateTime	System.DateTime	The end date time.
Résultat	IDataReader

InsertAppointment() public static méthode

Inserts the given appointment into the ol' database.

public static InsertAppointment ( Appointment appointment, int revisingUserId ) : IDataReader
appointment	Appointment	The appointment to insert.
revisingUserId	int	The ID of the user inserting.
Résultat	IDataReader

InsertAppointmentType() public static méthode

Inserts an appointmentType into SkyNet Central Repository (The database)

public static InsertAppointmentType ( AppointmentType appointmentType, int revisingUserId, int moduleId ) : void
appointmentType	AppointmentType	The appointment type.
revisingUserId	int	The revising user id.
moduleId	int	The module id.
Résultat	void

QueueEmail() public static méthode

Queues an email.

public static QueueEmail ( int portalId, string toList, string subject, string body, string attachment ) : void
portalId	int	The current portalId.
toList	string	The comma-or-semicolon-delimited list of email address(es) to which the email should be sent.
subject	string	The subject.
body	string	The HTML body.
attachment	string	The attachment.
Résultat	void

UpdateAppointment() public static méthode

Updates the given appointment's record.

public static UpdateAppointment ( Appointment appointment, int revisingUserId ) : void
appointment	Appointment	The appointment to update.
revisingUserId	int	The ID of the user making this update.
Résultat	void

UpdateAppointmentType() public static méthode

Updates the type of the appointment.

public static UpdateAppointmentType ( AppointmentType appointmentType, int revisingUserId ) : void
appointmentType	AppointmentType	Type of the appointment.
revisingUserId	int	The revising user id.
Résultat	void