Newer Version Available

This content describes an older version of this product. View Latest

RecurringPattern Class

Represents a global sharing class that is a required parameter for RecurringAppointmentsManager to return a pattern of appointments that recur daily, weekly, or monthly.

Namespace

FSL

Usage

RecurringPatternis a global sharing class that is a required parameter for RecurringAppointmentsManager. All properties must be complete to call the RecurringAppointmentsManager API.

Example

This example shows code for RecurringPattern and its properties.

1global class RecurringPattern {
2    global enum DaysOfWeek {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}
3    global enum FrequencyType {DAILY, WEEKLY, MONTHLY}
4    global Set<DaysOfWeek> DaysOfWeek { get; set; }
5    global FrequencyType FrequencyType { get; set; }
6    global Integer Frequency { get; set; }
7    global Integer NumberOfVisits { get; set; }
8}

Recurring Pattern Properties

RecurringPattern contains the following properties.

DaysOfWeek

The list of the days that can be used to book appointments, taken from the visiting hours operating hours.

Signature

global Set<DaysOfWeek> DaysOfWeek { get; set; }

global enum<FSL.RecurringPattern> DaysOfWeek {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}

Property Value

Type: Set<enum>

Frequency

The number of appointments to book inside the FrequencyType time frame provided.

Signature

global Integer Frequency { get; set; }

Property Value

Type: Integer

FrequencyType

The frequency of recurring appointments. Currently, only weekly frequency is supported.

Signature

global FrequencyType FrequencyType { get; set; }

Property Value

Type: Enum

NumberOfVisits

Total number of appointments to schedule.

Signature

global Integer NumberOfVisits { get; set; }

Property Value

Type: Integer