Extends

• ArchBaseFactory

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchFactoryMenus'.

static, readonly isArchFactoryMenus :boolean

readonly logStr :string

A logging string for the Architect Factory Menus instance.

Overrides:

• ArchBaseFactory#logStr

readonly logStrTypeOnly :string

This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.

Inherited From:

• ArchBaseObject#logStrTypeOnly

Methods

addMenu(archBaseFlow, nameopt, menuAudioTTSopt, setAsStartingMenuopt) → {ArchMenu}

Adds a menu to an inbound or outbound call flow.

Parameters:

Name	Type	Attributes	Default	Description
archBaseFlow	ArchBaseFlow			the flow where the menu will be added. The flow type must support menus.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
menuAudioTTS	string	<optional>		the text to speech to set on the menu.
setAsStartingMenu	boolean	<optional>	false	whether or not the newly created menu should be set as the startup object on the flow.

Returns:

ArchMenu

addMenuChoiceFromDefinition(archDefinitionMenuChoice, archParentMenuOrSubMenu, nameopt, previousArchActionopt) → {ArchBaseMenuChoice}

Adds an menu choice instance from a menu definition to an ArchBaseMultiActionContainer such as a action output, task or state. Note that if you're looking to add an ArchMenu instance, just use the addMenu method directly since this method expects to have a parent menu or parent sub-menu which is not the case for ArchMenu instances.

Parameters:

Name	Type	Attributes	Description
archDefinitionMenuChoice	ArchDefinitionMenu		An Architect Scripting menu definition that is a menu choice such as an ArchMenuDisconnect choice and not the definition for ArchMenu or ArchMenuSubMenu.
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu		the menu or sub-menu that you want to be the parent of the newly created menu choice.
name	string	<optional>	the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
previousArchAction	ArchBaseAction	<optional>	the previous Architect action in the archBaseMultiActionContainer after which the new action should be added.

Returns:

ArchBaseMenuChoice

addMenuDialByExtension(archParentMenuOrSubMenu, nameopt, dtmfopt, extensionVariableopt, repromptTTSopt, repromptCountopt, interDigitTimeoutExpressionopt, dtmfIsGlobalopt) → {ArchMenuDialByExtension}

Adds a dial by extension menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the jump to menu should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
extensionVariable	ArchVariableString | string	<optional>		the extension data string variable to use.
repromptTTS	string	<optional>		the reprompting text to speech text.
repromptCount	number	<optional>		the number of times to reprompt. This value should be a non-negative integer.
interDigitTimeoutExpression	string	<optional>		inter digit timeout duration expression text.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuDialByExtension

addMenuDisconnect(archParentMenuOrSubMenu, nameopt, dtmfopt, dtmfIsGlobalopt) → {ArchMenuDisconnect}

Adds a disconnect menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the disconnect should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuDisconnect

addMenuJumpToMenu(archParentMenuOrSubMenu, nameopt, dtmfopt, archTargetMenuopt, dtmfIsGlobalopt) → {ArchMenuJumpToMenu}

Adds a jump to menu menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the jump to menu should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
archTargetMenu	ArchMenu | ArchMenuSubMenu	<optional>		the Architect menu to jump to.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuJumpToMenu

addMenuJumpToTask(archParentMenuOrSubMenu, nameopt, dtmfopt, archTargetTaskopt, dtmfIsGlobalopt) → {ArchMenuJumpToTask}

Adds a jump to task menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the jump to menu should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
archTargetTask	ArchTask	<optional>		the task to transfer to.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuJumpToTask

addMenuPreviousMenu(archParentMenuOrSubMenu, nameopt, dtmfopt, dtmfIsGlobalopt) → {ArchMenuPreviousMenu}

Adds a previous menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the new menu should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuPreviousMenu

addMenuRepeatMenu(archParentMenuOrSubMenu, nameopt, dtmfopt, dtmfIsGlobalopt) → {ArchMenuRepeatMenu}

Adds a repeat menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the new menu should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuRepeatMenu

addMenuReturnToAgent(archParentMenuOrSubMenu, nameopt, dtmfopt, dtmfIsGlobalopt) → {ArchMenuReturnToAgent}

Adds a return to agent menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the return to agent should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuReturnToAgent

addMenuSubMenu(archParentMenuOrSubMenu, nameopt, dtmfopt, subMenuTTSopt, dtmfIsGlobalopt) → {ArchMenuSubMenu}

Adds a sub menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the sub menu should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
subMenuTTS	string	<optional>		text to speech to use on the sub menu prompting.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuSubMenu

addMenuTask(archParentMenuOrSubMenu, nameopt, dtmfopt, subMenuTTSopt, dtmfIsGlobalopt) → {ArchMenuTask}

Adds a task menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the sub menu should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
subMenuTTS	string	<optional>		text to speech to use on the sub menu prompting.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuTask

addMenuTransferToAcd(archParentMenuOrSubMenu, nameopt, dtmfopt, preTransferTTSopt, dtmfIsGlobalopt) → {ArchMenuTransferToAcd}

Adds a transfer to ACD menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the transfer to ACD should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
preTransferTTS	string	<optional>		the pre-transfer text to speech to use.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuTransferToAcd

addMenuTransferToFlow(archParentMenuOrSubMenu, nameopt, dtmfopt, preTransferTTSopt, dtmfIsGlobalopt) → {ArchMenuTransferToFlow}

Adds a transfer to flow menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the transfer to group should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
preTransferTTS	string	<optional>		the pre-transfer text to speech to use.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuTransferToFlow

addMenuTransferToFlowSecure(archParentMenuOrSubMenu, nameopt, dtmfopt, preTransferTTSopt, dtmfIsGlobalopt) → {ArchMenuTransferToFlow}

Adds a transfer to secure flow menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the transfer to group should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
preTransferTTS	string	<optional>		the pre-transfer text to speech to use.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuTransferToFlow

addMenuTransferToGroup(archParentMenuOrSubMenu, nameopt, dtmfopt, preTransferTTSopt, dtmfIsGlobalopt) → {ArchMenuTransferToGroup}

Adds a transfer to group menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the transfer to group should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
preTransferTTS	string	<optional>		the pre-transfer text to speech to use.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuTransferToGroup

addMenuTransferToNumber(archParentMenuOrSubMenu, nameopt, dtmfopt, preTransferTTSopt, dtmfIsGlobalopt) → {ArchMenuTransferToNumber}

Adds a transfer to number menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the transfer to number should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
preTransferTTS	string	<optional>		the pre-transfer text to speech to use.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuTransferToNumber

addMenuTransferToUser(archParentMenuOrSubMenu, nameopt, dtmfopt, preTransferTTSopt, dtmfIsGlobalopt) → {ArchMenuTransferToUser}

Adds a transfer to user menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the transfer to user should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
preTransferTTS	string	<optional>		the pre-transfer text to speech to use.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuTransferToUser

addMenuTransferToVoicemail(archParentMenuOrSubMenu, nameopt, dtmfopt, preTransferTTSopt, dtmfIsGlobalopt) → {ArchMenuTransferToVoicemail}

Adds a transfer to voicemail menu choice to a parent menu or sub menu.

Parameters:

Name	Type	Attributes	Default	Description
archParentMenuOrSubMenu	ArchMenu | ArchMenuSubMenu			the parent menu or submenu where the transfer to user should be added.
name	string	<optional>		the name for the new menu. If undefined or null, a default name will be assigned.
dtmf	string | number	<optional>		the dtmf for the new menu. Valid values are integers 0 through 9, strings '0' through '9', '*' or '#'.
preTransferTTS	string	<optional>		the pre-transfer text to speech to use.
dtmfIsGlobal	boolean	<optional>	false	whether or not the dtmf on this menu, if specified, should be treated as global.

Returns:

ArchMenuTransferToVoicemail

isFilterMatch(archFilterObject) → {boolean}

Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.

Parameters:

Name	Type	Description
archFilterObject	ArchFilterObject	the object filter to use to determine if it's a match.

Returns:

boolean

Inherited From:

• ArchBaseObject#isFilterMatch

logError(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true.

Parameters:

Name	Type	Description
errorStr	string	the error string to log.

Inherited From:

• ArchBaseObject#logError

logErrorAndThrow(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true and then throws the string in the errorStr parameter.

Parameters:

Name	Type	Description
errorStr	string	the error string to log. This should be a non-blank string.

Throws:

• Throws the submitted error string.

Inherited From:

• ArchBaseObject#logErrorAndThrow

logNote(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotes is true.

Parameters:

Name	Type	Description
noteStr	string	the note string to log. This should be a non-blank string.

Inherited From:

• ArchBaseObject#logNote

logNoteVerbose(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotesVerbose is true.

Parameters:

Name	Type	Description
noteStr	string	the note string to log. This should be a non-blank string.

Inherited From:

• ArchBaseObject#logNoteVerbose

logWarning(warningStr)

Logs a warning to the logging service with a log header from this object's logStr property value when ArchLogging#logWarnings is true.

Parameters:

Name	Type	Description
warningStr	string	the warning string to log. This should be a non-blank string.

Inherited From:

• ArchBaseObject#logWarning