Schedule Class

Represents time schedule settings of different objects

Definition

Namespace: TCX.Configuration
Assembly: 3cxpscomcpp2 (in 3cxpscomcpp2.dll) Version: 20.0.1
C#
public sealed class Schedule : Dictionary<DayOfWeek, SchedulePeriodsOfDay>
Inheritance
Object    DictionaryDayOfWeek, SchedulePeriodsOfDay    Schedule

Remarks

encapsulates management of legacy implementation which ises direct references to HoursRange objects

Constructors

Schedule(RuleHours) Initial value of HoursType
Schedule(RuleHoursType) This constructor initializes HoursType basing on RuleHoursType

Properties

HolidaysActivity Specifies desired handling of holidays
Is not interpreted by IsActiveTime(DateTime, Schedule, Schedule) or IsActiveTime(DateTime, Schedule)
HoursType Type of schedule. It defines how schedule should be interpreted. Interpretation of this field depends on context where Schedule is defined.

for any office hours/break time schedules defined for DN object generic rule is:
if HoursType is set to OfficeHours or OutOfOfficeHours this schedule is referencing the schedule defined for Tenant (office hours/break time)

For ExternalLineRule - OfficeHours or OutOfOfficeHours references Tenant office schedule

For the property AwayRoute, office hours are defined by DN as described above.

IgnoreHolidays Applicable only for OfficeHours ignored otherwise
Item provides collection of periods for the specific day

Methods

Add(DayOfWeek, SchedulePeriodOfDay) Adds period to a specific day of the week
Add(DayOfWeek, TimeSpan, TimeSpan) adds period to the specified day of the week
Equals Equality of Schedule Expensive operation.
(Overrides ObjectEquals(Object))
GetHashCode hashcode on ordered keys/values Expensive operation.
(Overrides ObjectGetHashCode)
IsActiveTime(DateTime, Schedule)IsActiveTime(DateTime, Schedule, Schedule) this method does not provide difinedBy information.
IsActiveTime(DateTime, Schedule, Schedule) if schedule have OfficeHours type it references some other "parent" schedule which should define the exact set of time ranges This method allows to combine check of "inherited" schedules and return result from the first which defines exact time ranges
ToString string presentation of Schedule data
(Overrides ObjectToString)

See Also