Manual Reference Source Test
import ScheduleModel from 'clinical6/src/models/reminder/Schedule.js'
public class | source

ScheduleModel

Direct Subclass:

Schedule

Model representing an Schedule.

Constructor Summary

Public Constructor
public

constructor(response: Object)

Member Summary

Public Members
public
public
public
public
public

enabled: *

public
public
public
public
public
public
public
public
public
public
public
public

Public Constructors

public constructor(response: Object) source

Params:

NameTypeAttributeDescription
response Object

JSON formatted response of an schedule.

response.id Number

The schedule id value

response.active_time_start String

Active start time for the rule

response.active_time_end String

Active end time for the rule

response.created_at String

Date in which the schedule was created

response.days_of_week String

Comma delimited list from 0 - 6 for days of week.

response.enabled Boolean

Whether or not the schedule is enabled

response.end_date String

Date in which the schedule ends

response.exception_days String

Days that the rule should not apply, ie: 'holidays'

response.relative_schedule String

In combination with the relative_unit, determines the schedule starting from the start date in which the scheduleable will occur. Example: relative_schedule = [1 ,5, 10], relative_unit = days means that day 1, day 5 and day 10 the scheduleable will be triggered (Comma delimited String)

response.relative_unit String

Must be: 'days', 'weeks', or 'months'

response.skip_exceptions Boolean

Whether or not the schedule has skip exceptions

response.start_date String

Date in which the schedule starts

response.start_date_offset Number

Number of units from the start_date

response.start_date_offset_unit String

Unit used by start_date_offset, ie: 'day'

response.time String

Time must be military format with dd:dd like "10:00"

response.timezone String

Timezone like "UTC"

response.updated_at String

Date in which the schedule was updated

Public Members

public activeTimeEnd: String source

public activeTimeStart: String source

public createdAt: String source

public daysOfWeek: String source

public enabled: * source

public endDate: String source

public exceptionDays: String source

public id: Number source

public relativeSchedule: String source

public relativeUnit: String source

public skipExceptions: * source

public startDate: String source

public startDateOffset: Number source

public startDateOffsetUnit: String source

public time: String source

public updatedAt: String source