Interface IAppointmentMatrix

Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public interface IAppointmentMatrix

Properties

Agenda

Declaration
TextRow Agenda { get; }
Property Value
Type Description
TextRow

AppointmentText

Declaration
TextRow AppointmentText { get; }
Property Value
Type Description
TextRow

BookingType

Declaration
BookingType BookingType { get; }
Property Value
Type Description
BookingType

CurrentAppointmentRow

Declaration
AppointmentRow CurrentAppointmentRow { get; }
Property Value
Type Description
AppointmentRow

CustomFields

Declaration
EntityCustomFieldsHelper CustomFields { get; }
Property Value
Type Description
EntityCustomFieldsHelper

ExtraFields

Declaration
EntityExtraFieldsHelper ExtraFields { get; }
Property Value
Type Description
EntityExtraFieldsHelper

ForceChildProcessing

Declaration
bool ForceChildProcessing { get; }
Property Value
Type Description
bool

InnerRemovedMatrix

Declaration
KeyedMatrix<ParticipantInfo, RecurrenceDate, AppointmentRow> InnerRemovedMatrix { get; }
Property Value
Type Description
KeyedMatrix<ParticipantInfo, RecurrenceDate, AppointmentRow>

InternalNotes

Declaration
TextRow InternalNotes { get; }
Property Value
Type Description
TextRow

IsBooking

Declaration
bool IsBooking { get; }
Property Value
Type Description
bool

IsBookingMaster

Declaration
bool IsBookingMaster { get; }
Property Value
Type Description
bool

IsDeleted

Declaration
bool IsDeleted { get; }
Property Value
Type Description
bool

IsDirty

Is the object dirty?

Declaration
bool IsDirty { get; }
Property Value
Type Description
bool

IsExternalInvitation

Declaration
bool IsExternalInvitation { get; }
Property Value
Type Description
bool

IsRecurring

Declaration
bool IsRecurring { get; }
Property Value
Type Description
bool

MainBooking

Returns Main or Current Appointment entity.

Declaration
Appointment MainBooking { get; }
Property Value
Type Description
Appointment

MainBookingRow

Declaration
AppointmentRow MainBookingRow { get; }
Property Value
Type Description
AppointmentRow

Ownership

Declaration
AppointmentMatrix.OwnershipIndex Ownership { get; }
Property Value
Type Description
AppointmentMatrix.OwnershipIndex

PublishHelper

Declaration
EntityPublishHelper PublishHelper { get; }
Property Value
Type Description
EntityPublishHelper

Recurrence

Declaration
RecurrenceInfo Recurrence { get; set; }
Property Value
Type Description
RecurrenceInfo

RecurrenceUpdateMode

Declaration
RecurrenceUpdateMode RecurrenceUpdateMode { get; }
Property Value
Type Description
RecurrenceUpdateMode

SendMailFunction

Declaration
AppointmentMatrix.SendMails SendMailFunction { get; set; }
Property Value
Type Description
AppointmentMatrix.SendMails

SendNewInvitations

Declaration
List<ParticipantInfo> SendNewInvitations { get; }
Property Value
Type Description
List<ParticipantInfo>

SendPushMessageToOurself

If true, we will also send push messages to logged in user if specified as recipient If false, we will filter out logged in user

Declaration
bool SendPushMessageToOurself { get; set; }
Property Value
Type Description
bool

Task

Declaration
TaskRow Task { get; }
Property Value
Type Description
TaskRow

Title

Declaration
TextRow Title { get; }
Property Value
Type Description
TextRow

UdefHelper

Declaration
EntityUdefHelper UdefHelper { get; }
Property Value
Type Description
EntityUdefHelper

VisibleForHelper

Declaration
EntityVisibleForHelper VisibleForHelper { get; }
Property Value
Type Description
EntityVisibleForHelper

Methods

AcceptAsync(ParticipantInfo, CancellationToken)

Accept all occurrences of the appointment for the participant. If only one occurrence exist, then only this one is accepted (not a recurring booking appointment)

Declaration
Task AcceptAsync(ParticipantInfo participantInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo participantInfo

Participant that accepts all occurrences of the appointment
CancellationToken cancellationToken
Returns
Type Description
Task

AcceptAsync(int, RecurrenceUpdateMode, CancellationToken)

Accept all occurrences for the current appointment. If only one occurrence exist, then only this one is accepted (not a recurring booking appointment). The result of the rejection is saved to the database.

Declaration
Task AcceptAsync(int appointmentId, RecurrenceUpdateMode recurrenceUpdateMode, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int appointmentId

AppointmentId of Invitation or Assignment to be set to accepted.
RecurrenceUpdateMode recurrenceUpdateMode

How recurrence updates should be handled
CancellationToken cancellationToken
Returns
Type Description
Task

AcceptAsync(CancellationToken)

Accept all occurrences for the current appointment. If only one occurrence exist, then only this one is accepted (not a recurring booking appointment)

Declaration
Task AcceptAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

AcceptRejectedAppointmentAsync(ParticipantInfo, RecurrenceDate, CancellationToken)

Booking owner can accept that a participant has rejected an invitation. The rejected invitation will then NOT appear in the booking owner's Invitation dialog anymore.

Declaration
Task AcceptRejectedAppointmentAsync(ParticipantInfo participantInfo, RecurrenceDate date, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo participantInfo

Participant that accepts the appointment
RecurrenceDate date

The date of the accepted appointment
CancellationToken cancellationToken
Returns
Type Description
Task

AcceptRejectedAppointmentAsync(CancellationToken)

Booking owner can accept that a participant has rejected an invitation. The rejected invitation will then NOT appear in the booking owner's Invitation dialog anymore.

Declaration
Task AcceptRejectedAppointmentAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

AcceptWithEmailConfirmationAsync(CancellationToken)

... ... send emails

Declaration
Task AcceptWithEmailConfirmationAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

AddDateAsync(CancellationToken, params RecurrenceDate[])

Add a date to the repeating appointment. Nothing will be performed if RecurrenceUpdateMode is OnlyThis.

Declaration
Task AddDateAsync(CancellationToken cancellationToken, params RecurrenceDate[] dates)
Parameters
Type Name Description
CancellationToken cancellationToken
RecurrenceDate[] dates

Date to add to the repeating appointment.
Returns
Type Description
Task

AddDateAsync(CancellationToken, params DateTime[])

Add a date to the repeating appointment. Nothing will be performed if RecurrenceUpdateMode is OnlyThis.

Declaration
Task AddDateAsync(CancellationToken cancellationToken, params DateTime[] dates)
Parameters
Type Name Description
CancellationToken cancellationToken
DateTime[] dates

Date to add to the repeating appointment.
Returns
Type Description
Task

AddParticipantAsync(CancellationToken, params ParticipantInfo[])

Declaration
Task AddParticipantAsync(CancellationToken cancellationToken, params ParticipantInfo[] participants)
Parameters
Type Name Description
CancellationToken cancellationToken
ParticipantInfo[] participants
Returns
Type Description
Task

AssignToAsync(ParticipantInfo, CancellationToken)

Assign the booking to the participant given as parameter. If booking is a recurrence then the participant is assigned as booking owner for all instances.

Declaration
Task AssignToAsync(ParticipantInfo participantInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo participantInfo

Participant to assign the booking to (will become the owner)
CancellationToken cancellationToken
Returns
Type Description
Task

AssignToExternalOrganizerAsync(ParticipantInfo, CancellationToken)

Assign the booking to the participant given as parameter. If booking is a recurrence then the participant is assigned as booking owner for all instances.

Declaration
Task AssignToExternalOrganizerAsync(ParticipantInfo newOwner, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo newOwner

Participant to assign the booking to (will become the owner)
CancellationToken cancellationToken
Returns
Type Description
Task

CalculateDaysAsync(CancellationToken)

Calculate the days according the the recurrence pattern described.
Nothing will be performed if RecurrenceUpdateMode is OnlyThis.

Declaration
Task CalculateDaysAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

CancelAsync(ParticipantInfo, CancellationToken)

Declaration
Task CancelAsync(ParticipantInfo participantInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo participantInfo
CancellationToken cancellationToken
Returns
Type Description
Task

DeleteAsync()

Delete items in the appointment matrix.

Declaration
Task DeleteAsync()
Returns
Type Description
Task

DeleteUnusedInvitationMatrixAsync(bool, CancellationToken)

Declaration
Task DeleteUnusedInvitationMatrixAsync(bool allowCheckOnMainBooking = false, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool allowCheckOnMainBooking
CancellationToken cancellationToken
Returns
Type Description
Task

DeleteWithEmailAsync(CancellationToken)

Declaration
Task DeleteWithEmailAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

DemandOwnership(OwnershipIndex)

Demand that the logged in user has the the required ownership requested.
If the required is less than the Ownership, a SoSentryException is thrown.

Declaration
void DemandOwnership(AppointmentMatrix.OwnershipIndex minimumRequiredOwnership)
Parameters
Type Name Description
AppointmentMatrix.OwnershipIndex minimumRequiredOwnership

The mimimum required ownership index required.

EmailWasQueued()

Declaration
bool EmailWasQueued()
Returns
Type Description
bool

GetAllAppointmentRowsAsync(CancellationToken)

Declaration
IAsyncEnumerable<AppointmentRow> GetAllAppointmentRowsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerable<AppointmentRow>

GetDates()

Declaration
RecurrenceDate[] GetDates()
Returns
Type Description
RecurrenceDate[]

GetIncludedAppointmentRowsAsync(CancellationToken)

Declaration
IAsyncEnumerable<AppointmentRow> GetIncludedAppointmentRowsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerable<AppointmentRow>

GetInnerMatrixAsync(CancellationToken)

Declaration
Task<KeyedMatrix<ParticipantInfo, RecurrenceDate, AppointmentRow>> GetInnerMatrixAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<KeyedMatrix<ParticipantInfo, RecurrenceDate, AppointmentRow>>

GetLinksHelperAsync(CancellationToken)

Declaration
Task<ActivityLinksHelper> GetLinksHelperAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ActivityLinksHelper>

GetMailBodyFromMailBodyAsync(TemplateVariables, string, ParticipantInfo)

Declaration
Task<string> GetMailBodyFromMailBodyAsync(TemplateVariables templateVariables, string mailBody, ParticipantInfo participant)
Parameters
Type Name Description
TemplateVariables templateVariables
string mailBody
ParticipantInfo participant
Returns
Type Description
Task<string>

GetParticipantFullNameAsync(ParticipantInfo, CancellationToken)

Declaration
Task<string> GetParticipantFullNameAsync(ParticipantInfo info, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo info
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetParticipants()

Declaration
ParticipantInfo[] GetParticipants()
Returns
Type Description
ParticipantInfo[]

GetRemovedAppointmentRows()

Declaration
IEnumerable<AppointmentRow> GetRemovedAppointmentRows()
Returns
Type Description
IEnumerable<AppointmentRow>

GetTemplateVariablesAsync(CancellationToken)

Declaration
Task<TemplateVariables> GetTemplateVariablesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TemplateVariables>

HasOwnership(OwnershipIndex)

Determine if the logged in user has the the required ownershiprequested.
If the required is the same or larger than the Ownership, true is returned.

Declaration
bool HasOwnership(AppointmentMatrix.OwnershipIndex minimumRequiredOwnership)
Parameters
Type Name Description
AppointmentMatrix.OwnershipIndex minimumRequiredOwnership

The mimimum required ownership index required.
Returns
Type Description
bool

True if minimumRequiredOwnership is the same or larger than the Ownership.

HasParticipant(ParticipantInfo)

Declaration
bool HasParticipant(ParticipantInfo participant)
Parameters
Type Name Description
ParticipantInfo participant
Returns
Type Description
bool

MoveAsync(DateTime, CancellationToken)

Declaration
Task MoveAsync(DateTime newStartTime, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime newStartTime
CancellationToken cancellationToken
Returns
Type Description
Task

RejectAsync(ParticipantInfo, RecurrenceDate, string, CancellationToken)

Rejects the appointment for the provided participant at the given date

Declaration
Task RejectAsync(ParticipantInfo participantInfo, RecurrenceDate date, string rejectReason, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo participantInfo

Participant that rejects the appointment
RecurrenceDate date

The date of the rejected appointment
string rejectReason

Text that explains why he/she can not attend
CancellationToken cancellationToken
Returns
Type Description
Task

RejectAsync(ParticipantInfo, string, CancellationToken)

Rejects all occurrences of the appointment for the participant. If only one occurrence exist, then only this one is rejected (not a recurring booking appointment)

Declaration
Task RejectAsync(ParticipantInfo participantInfo, string rejectReason, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo participantInfo

Participant that rejects all occurrences of the appointment
string rejectReason

Text that explains why he/she can not attend
CancellationToken cancellationToken
Returns
Type Description
Task

RejectAsync(string, CancellationToken)

Rejects all occurrences for the current appointment. If only one occurrence exist, then only this one is rejected (not a recurring booking appointment)

Declaration
Task RejectAsync(string rejectReason, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string rejectReason

Text that explains why he/she can not attend
CancellationToken cancellationToken
Returns
Type Description
Task

RejectWithEmailConfirmationAsync(string, CancellationToken)

Rejects all occurrences for the current appointment. If only one occurrence exist, then only this one is rejected (not a recurring booking appointment)

Declaration
Task RejectWithEmailConfirmationAsync(string rejectReason, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string rejectReason

Text that explains why he/she can not attend
CancellationToken cancellationToken
Returns
Type Description
Task

RemoveDateAsync(CancellationToken, params RecurrenceDate[])

Add a date to the repeating appointment. Nothing will be performed if RecurrenceUpdateMode is OnlyThis.

Declaration
Task RemoveDateAsync(CancellationToken cancellationToken, params RecurrenceDate[] dates)
Parameters
Type Name Description
CancellationToken cancellationToken
RecurrenceDate[] dates

Date to add to the repeating appointment.
Returns
Type Description
Task

RemoveDateAsync(CancellationToken, params DateTime[])

Remove a date from the repeating appointment. Nothing will be performed if RecurrenceUpdateMode is OnlyThis.

Declaration
Task RemoveDateAsync(CancellationToken cancellationToken, params DateTime[] dates)
Parameters
Type Name Description
CancellationToken cancellationToken
DateTime[] dates

Date to remove from the repeating appointment.
Returns
Type Description
Task

RemoveParticipantAsync(CancellationToken, params ParticipantInfo[])

Used to remove participants from a booking

Declaration
Task RemoveParticipantAsync(CancellationToken cancellationToken, params ParticipantInfo[] participants)
Parameters
Type Name Description
CancellationToken cancellationToken
ParticipantInfo[] participants

List of ParticipantInfo
Returns
Type Description
Task

SaveAsync()

Declaration
Task SaveAsync()
Returns
Type Description
Task

SetDatesAsync(CancellationToken, params RecurrenceDate[])

Set the dates for the repeating appointment. Nothing will be performed if RecurrenceUpdateMode is OnlyThis.

Declaration
Task SetDatesAsync(CancellationToken cancellationToken, params RecurrenceDate[] dates)
Parameters
Type Name Description
CancellationToken cancellationToken
RecurrenceDate[] dates

Dates to set on the repeating appointment.
Returns
Type Description
Task

SetInvitationMailBody(string, string, string)

Declaration
void SetInvitationMailBody(string emailBody, string subject, string templateLanguage)
Parameters
Type Name Description
string emailBody
string subject
string templateLanguage

SetModifiedAppointmentFields(AppointmentRow)

Declaration
void SetModifiedAppointmentFields(AppointmentRow row)
Parameters
Type Name Description
AppointmentRow row

SetParticipantsAsync(CancellationToken, params ParticipantInfo[])

Declaration
Task SetParticipantsAsync(CancellationToken cancellationToken, params ParticipantInfo[] participants)
Parameters
Type Name Description
CancellationToken cancellationToken
ParticipantInfo[] participants
Returns
Type Description
Task

SetSeenAsync(CancellationToken)

Sets an appointment Invitation or Assignment to seen.

Declaration
Task SetSeenAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Remarks

Set Seen (Booking or Assignment) or MovedSeen (Booking) depending on the previous status of the Appointment

SetSendMailToParticipants(bool)

Set if e-mails are going to be sent to participants that are marked receive mails, using default e-mail options for the logged in user.

Declaration
void SetSendMailToParticipants(bool sendEmailToParticipants)
Parameters
Type Name Description
bool sendEmailToParticipants

True if e-mails are going to be sent to participants that are marked receive mails.

SetSendMailToParticipants(bool, string, string, string, bool, string, string, string, bool, string)

Set if e-mails are going to be sent to participants that are marked receive mails, with provided mail server options.

Declaration
void SetSendMailToParticipants(bool sendEmailToParticipants, string imapServer, string imapUser, string imapPassword, bool imapSSL, string smtpServer, string smtpUser, string smtpPassword, bool smtpSSL, string sentFolder)
Parameters
Type Name Description
bool sendEmailToParticipants

True if e-mails are going to be sent to participants that are marked receive mails.
string imapServer

Name/IP with optional port (i.e. server:port)of the IMAP server for storing e-mail in the sent items folder.
string imapUser

User-name to use when authenticating against the IMAP server for storing e-mail in the sent items folder.
string imapPassword

Password to use when authenticating against the IMAP server for storing e-mail in the sent items folder.
bool imapSSL

Use secure connection.
string smtpServer

Name/IP with optional port (i.e. server:port)of the SMTP server for sending e-mail.
string smtpUser

User-name to use when authenticating against the SMTP server for sending e-mail.
string smtpPassword

Password to use when authenticating against the SMT server for sending e-mail.
bool smtpSSL

Use secure connection.
string sentFolder

SetSendMailToParticipants(bool, string, string, string, string, string, string)

Set if e-mails are going to be sent to participants that are marked receive mails, with provided mail server options.

Declaration
void SetSendMailToParticipants(bool sendEmailToParticipants, string imapServer, string imapUser, string imapPassword, string smtpServer, string smtpUser, string smtpPassword)
Parameters
Type Name Description
bool sendEmailToParticipants

True if e-mails are going to be sent to participants that are marked receive mails.
string imapServer

Name/IP with optional port (i.e. server:port)of the IMAP server for storing e-mail in the sent items folder.
string imapUser

User-name to use when authenticating against the IMAP server for storing e-mail in the sent items folder.
string imapPassword

Password to use when authenticating against the IMAP server for storing e-mail in the sent items folder.
string smtpServer

Name/IP with optional port (i.e. server:port)of the SMTP server for sending e-mail.
string smtpUser

User-name to use when authenticating against the SMTP server for sending e-mail.
string smtpPassword

Name/IP with optional port (i.e. server:port)of the SMTP server for sending e-mail.

SetSendMailToParticipantsAsync(bool, bool)

Declaration
Task SetSendMailToParticipantsAsync(bool sendEmailToParticipants, bool setupConnections)
Parameters
Type Name Description
bool sendEmailToParticipants
bool setupConnections
Returns
Type Description
Task

UpdateParticipantInfoAsync(ParticipantInfo, CancellationToken)

Updates data regarding mail sending for the participant

Declaration
Task UpdateParticipantInfoAsync(ParticipantInfo participant, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ParticipantInfo participant

Participant to update data for.
CancellationToken cancellationToken
Returns
Type Description
Task

ValidateDaysAsync(CancellationToken)

Declaration
Task ValidateDaysAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

Extension Methods