Extends

• ArchBaseActionSchedule

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionEvaluateScheduleGroup'.

readonly displayTypeName :string

Returns the display type name string 'ArchBaseActionSchedule'.

Overrides:

• ArchBaseActionSchedule#displayTypeName

readonly emergencyGroup :ArchValueEmergencyGroup

The emergency group to use

Inherited From:

• ArchBaseActionSchedule#emergencyGroup

evaluateNow :boolean

The evaluate now boolean to determine if the base schedule should be evaluated at execution time or a specified datetime.

Inherited From:

• ArchBaseActionSchedule#evaluateNow

readonly evaluationDateTime :ArchValueDateTime

The specific date time to use when evaluating the base schedule

Inherited From:

• ArchBaseActionSchedule#evaluationDateTime

readonly inServiceSchedules :ArchValueStringCollection

The value that will hold the variable that receives the response body fetched at runtime.

readonly isArchActionEvaluateScheduleGroup :boolean

Returns true indicating that this is an ArchActionEvaluateScheduleGroup instance.

readonly isArchBaseActionSchedule :boolean

Returns true indicating that this is an ArchBaseActionSchedule instance.

Inherited From:

• ArchBaseActionSchedule#isArchBaseActionSchedule

readonly outputClosed :ArchActionOutput

The closed output for this action

readonly outputEmergency :ArchActionOutput

The emergency output for this action

readonly outputHoliday :ArchActionOutput

The holiday output for this action

readonly outputOpen :ArchActionOutput

The open output for this action

readonly scheduleGroup :ArchValueScheduleGroup

The schedule group to use

Methods

setEmergencyGroupByIdAsync(emergencyGroupId, callbackFunctionopt) → {Promise.<ArchBaseActionSchedule>}

Sets the emergency group to use at runtime by its the emergency group id.

Parameters:

Name	Type	Attributes	Description
emergencyGroupId	string		the identifier of the emergency group.
callbackFunction	callbackArchActionEvaluateScheduleGroup	<optional>	a callback function to call if the emergency group is successfully looked up and configured on this action.

Returns:

Promise.<ArchBaseActionSchedule>

Inherited From:

• ArchBaseActionSchedule#setEmergencyGroupByIdAsync

setEmergencyGroupByNameAsync(emergencyGroupName, callbackFunctionopt) → {Promise.<ArchBaseActionSchedule>}

Sets the emergency group to use at runtime by the emergency group name.

Parameters:

Name	Type	Attributes	Description
emergencyGroupName	string		the name of the emergency group.
callbackFunction	callbackArchActionEvaluateScheduleGroup	<optional>	a callback function to call if the emergency group is successfully looked up and configured on this action.

Returns:

Promise.<ArchBaseActionSchedule>

Inherited From:

• ArchBaseActionSchedule#setEmergencyGroupByNameAsync

setScheduleGroupByIdAsync(scheduleGroupId, callbackFunctionopt) → {Promise.<ArchActionEvaluateScheduleGroup>}

This sets the schedule group to get at runtime by its identifier.

Parameters:

Name	Type	Attributes	Description
scheduleGroupId	string		the identifier of the schedule group.
callbackFunction	callbackArchActionEvaluateScheduleGroup	<optional>	a callback function to call if the schedule group is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect get schedule instance.

Returns:

Promise.<ArchActionEvaluateScheduleGroup>

setScheduleGroupByNameAsync(scheduleGroupName, callbackFunctionopt) → {Promise.<ArchActionEvaluateScheduleGroup>}

This sets the schedule group to get at runtime by its name.

Parameters:

Name	Type	Attributes	Description
scheduleGroupName	string		the name of the schedule group.
callbackFunction	callbackArchActionEvaluateScheduleGroup	<optional>	a callback function to call if the schedule group is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect get schedule instance.

Returns:

Promise.<ArchActionEvaluateScheduleGroup>