Extends

• ArchBaseActionSchedule

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionEvaluateSchedule'.

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

readonly evaluateEmergencyGroup :boolean

The evaluate emergency group boolean to determine if the action should evaluate a schedule or an 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 isArchActionEvaluateSchedule :boolean

Returns true indicating that this is an ArchActionEvaluateSchedule instance.

readonly isArchBaseActionSchedule :boolean

Returns true indicating that this is an ArchBaseActionSchedule instance.

Inherited From:

• ArchBaseActionSchedule#isArchBaseActionSchedule

readonly outputActive :ArchActionOutput

The active output for this action

readonly outputInactive :ArchActionOutput

The inactive output for this action

readonly schedule :ArchValueSchedule

The schedule to use

readonly scheduleTimeZone :ArchValueString

This value must be a valid timezone identifier. The best way to get a list of these strings is to look at what is available in the Architect UI for this action. When specifying a timezone identifier, please note that this does not include the UTC offset. In the Architect UI you can see this when switching from a literal timezone selection to an expression. For example, instead of Australia/Sydney (+11:00), the literal string value you would want to set is Australia/Sydney.

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

setEvaluateEmergencyGroup(newEvaluationType)

Set the evaluate emergency group evaluation type for the Evaluate Schedule action. The string values in ArchEnums#SCHEDULE_EVALUATION_TYPES lists valid values.

Parameters:

Name	Type	Description
newEvaluationType	string	the disposition value to set

setScheduleByIdAsync(scheduleId, callbackFunctionopt) → {Promise.<ArchActionEvaluateSchedule>}

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

Parameters:

Name	Type	Attributes	Description
scheduleId	string		the identifier of the schedule.
callbackFunction	callbackArchActionEvaluateSchedule	<optional>	a callback function to call if the schedule 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.<ArchActionEvaluateSchedule>

setScheduleByNameAsync(scheduleName, callbackFunctionopt) → {Promise.<ArchActionEvaluateSchedule>}

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

Parameters:

Name	Type	Attributes	Description
scheduleName	string		the name of the schedule.
callbackFunction	callbackArchActionEvaluateSchedule	<optional>	a callback function to call if the schedule 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.<ArchActionEvaluateSchedule>