Type Definitions

callbackArchActionAskForSlot(ArchActionAskForSlot)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect ask for slot action instance such as ArchActionAskForSlot#setSpeechToTextEngineByNameAsync and ArchActionAskForSlot#setSpeechToTextEngineByIdAsync

Parameters:

Name	Type	Description
ArchActionAskForSlot	ArchActionAskForSlot	the Architect supported language settings instance.

callbackArchActionCallBotConnector(ArchActionCallBotConnector)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect Call Bot Connector action instance such as ArchActionCallBotConnector#setBotByIdAsync

Parameters:

Name	Type	Description
ArchActionCallBotConnector	ArchActionCallBotConnector	the Architect Call Bot Connector action instance.

callbackArchActionCallCommonModule(ArchActionCallCommonModule)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect call common module instance such as ArchActionCallCommonModule#setCommonModuleFlowByIdAsync

Parameters:

Name	Type	Description
ArchActionCallCommonModule	ArchActionCallCommonModule	the Architect call common module instance.

callbackArchActionCallData(ArchActionCallData)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect call data action instance such as ArchActionCallData#setDataActionByIdAsync

Parameters:

Name	Type	Description
ArchActionCallData	ArchActionCallData	the Architect call data action instance.

callbackArchActionCallDataSecure(ArchActionCallDataSecure)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect call secure action instance such as ArchActionCallDataSecure#setDataSecureActionByIdAsync or ArchActionCallDataSecure#setDataSecureActionByNameAsync.

Parameters:

Name	Type	Description
ArchActionCallDataSecure	ArchActionCallDataSecure	the Architect call secure action instance.

callbackArchActionCallDialogEngineBot(ArchActionCallDialogEngineBot) → {any}

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect Call Dialog Engine Bot action instance such as ArchActionCallDialogEngineBot#setDialogEngineBotByIdAsync

Parameters:

Name	Type	Description
ArchActionCallDialogEngineBot	ArchActionCallDialogEngineBot	the Architect Call Dialog Engine Bot action instance.

Returns:

any

callbackArchActionCallLexBot(ArchActionCallLexBot) → {any}

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect Call Lex Bot action instance such as ArchActionCallLexBot#setLexBotAliasByIdAsync

Parameters:

Name	Type	Description
ArchActionCallLexBot	ArchActionCallLexBot	the Architect Call Lex Bot action instance.

Returns:

any

callbackArchActionCallLexV2Bot(ArchActionCallLexV2Bot) → {any}

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect Call LexV2 Bot action instance such as ArchActionCallLexV2Bot#setLexBotAliasByIdAsync

Parameters:

Name	Type	Description
ArchActionCallLexV2Bot	ArchActionCallLexV2Bot	the Architect Call Lex Bot action instance.

Returns:

any

callbackArchActionCallNuanceMixBot(ArchActionCallNuanceMixBot) → {any}

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect Call NuanceMixBot action instance such as ArchActionCallNuanceMixBot#setBotByIdAsync

Parameters:

Name	Type	Description
ArchActionCallNuanceMixBot	ArchActionCallNuanceMixBot	the Architect Call NuanceMixBot action instance.

Returns:

any

callbackArchActionCreateCallback(archActionCreateCallback)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect create callback instance such as ArchActionCreateCallback#setScriptByNameAsync or ArchActionCreateCallback#setScriptByIdAsync.

Parameters:

Name	Type	Description
archActionCreateCallback	ArchActionCreateCallback	the Architect create callback action instance.

callbackArchActionDataTableLookup(ArchActionDataTableLookup)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect data table lookup action instance such as ArchActionDataTableLookup#setDataTableByIdAsync

Parameters:

Name	Type	Description
ArchActionDataTableLookup	ArchActionDataTableLookup	the Architect base data table instance.

callbackArchActionEvaluateSchedule(ArchActionEvaluateSchedule)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect schedule instance such as ArchActionEvaluateSchedule#setScheduleByNameAsync

Parameters:

Name	Type	Description
ArchActionEvaluateSchedule	ArchActionEvaluateSchedule	the Architect get schedule instance.

callbackArchActionEvaluateScheduleGroup(ArchActionEvaluateScheduleGroup)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect schedule instance such as ArchActionEvaluateScheduleGroup#setScheduleGroupByNameAsync

Parameters:

Name	Type	Description
ArchActionEvaluateScheduleGroup	ArchActionEvaluateScheduleGroup	the Architect get schedule instance.

callbackArchActionGetResponse(ArchActionGetResponse)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect response instance such as ArchActionGetResponse#setResponseByIdAsync

Parameters:

Name	Type	Description
ArchActionGetResponse	ArchActionGetResponse	the Architect get response instance.

callbackArchActionSetScreenPop(archActionSetScreenPop)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect set screen pop instance such as ArchActionSetScreenPop#setScriptByNameAsync or ArchActionSetScreenPop#setScriptByIdAsync.

Parameters:

Name	Type	Description
archActionSetScreenPop	ArchActionSetScreenPop	the Architect set screen pop action instance.

callbackArchActionShowKnowledgeArticle(ArchActionShowKnowledgeArticle)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect Show Knowledge Article instance such as ArchActionShowKnowledgeArticle#setLiteralByKnowledgeBaseDocumentNameAsync

Parameters:

Name	Type	Description
ArchActionShowKnowledgeArticle	ArchActionShowKnowledgeArticle	the Architect Show Knowledge Article instance.

callbackArchActionTransferToAcd(archArchActionTransferToAcd)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect transfer to ACD action instance such as ArchActionTransferToAcd#addLiteralBySkillNameAsync or ArchActionTransferToAcd#setLiteralByQueueNameAsync

Parameters:

Name	Type	Description
archArchActionTransferToAcd	ArchActionTransferToAcd	the Architect transfer to ACD action instance.

callbackArchActionTransferToVoicemail(archActionTransferToVoicemail)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect transfer to voicemail action instance such as ArchActionTransferToVoicemail#setTargetUserLiteralByUserIdAsync, ArchActionTransferToVoicemail#setTargetUserLiteralByUserNameAsync, ArchActionTransferToVoicemail#setTargetQueueLiteralByQueueIdAsync or ArchActionTransferToVoicemail#setTargetQueueLiteralByQueueNameAsync

Parameters:

Name	Type	Description
archActionTransferToVoicemail	ArchActionTransferToVoicemail	the Architect transfer to voicemail action instance.

callbackArchBaseActionDataAction(ArchBaseActionDataAction)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect call data action instance such as ArchActionCallData#setDataActionByIdAsync

Parameters:

Name	Type	Description
ArchBaseActionDataAction	ArchBaseActionDataAction	the Architect base data action instance.

callbackArchBaseActionDialogflow(ArchBaseActionDialogflow) → {any}

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect Base Dialogflow action instance such as ArchActionCallDialogflowBot#setDialogflowAgentByNameAsync

Parameters:

Name	Type	Description
ArchBaseActionDialogflow	ArchBaseActionDialogflow	the Architect Base Dialogflow action instance.

Returns:

any

callbackArchBaseActionSchedule(ArchBaseActionSchedule)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect schedule instance such as ArchBaseActionSchedule#setScheduleByNameAsync

Parameters:

Name	Type	Description
ArchBaseActionSchedule	ArchBaseActionSchedule	the Architect get schedule instance.

callbackArchBaseFlow(archBaseFlow)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect base flow instance such as ArchFactoryFlows#loadFlowByFlowNameAsync

Parameters:

Name	Type	Description
archBaseFlow	ArchBaseFlow	the Architect flow object.

callbackArchBasePrompt(archBasePrompt)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect base prompt instance such as ArchFactoryPrompts#getPromptByPromptNameAsync

Parameters:

Name	Type	Description
archBasePrompt	ArchBasePrompt	the Architect prompt instance which will be either an ArchPromptUser or ArchPromptSystem instance.

callbackArchBaseSkillValuePairs(archBaseSkillValuePairs)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect skill value pairs instance such as ArchBaseSkillValuePairs#addLiteralBySkillIdAsync or ArchBaseSkillValuePairs#addLiteralBySkillNameAsync

Parameters:

Name	Type	Description
archBaseSkillValuePairs	ArchBaseSkillValuePairs	the Architect skill value pairs instance.

callbackArchFlowBot(archFlowBot)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect bot flow such as ArchFactoryFlows#createFlowBotAsync

Parameters:

Name	Type	Description
archFlowBot	ArchFlowBot	the Architect bot flow.

callbackArchFlowCommonModule(archFlowCommonModule)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect common module flow such as ArchFactoryFlows#createFlowCommonModuleAsync

Parameters:

Name	Type	Description
archFlowCommonModule	ArchFlowCommonModule	the Architect common module flow.

callbackArchFlowDigitalBot(archFlowDigitalBot)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect digital bot flow such as ArchFactoryFlows#createFlowDigitalBotAsync

Parameters:

Name	Type	Description
archFlowDigitalBot	ArchFlowDigitalBot	the Architect digital bot flow.

callbackArchFlowInboundCall(archFlowInboundCall)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect inbound call flow such as ArchFactoryFlows#createFlowInboundCallAsync

Parameters:

Name	Type	Description
archFlowInboundCall	ArchFlowInboundCall	the Architect inbound call flow.

callbackArchFlowInboundChat(archFlowInboundChat)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect inbound chat flow such as ArchFactoryFlows#createFlowInboundChatAsync

Parameters:

Name	Type	Description
archFlowInboundChat	ArchFlowInboundChat	the Architect inbound chat flow.

callbackArchFlowInboundEmail(archFlowInboundEmail)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect inbound email flow such as ArchFactoryFlows#createFlowInboundEmailAsync

Parameters:

Name	Type	Description
archFlowInboundEmail	ArchFlowInboundEmail	the Architect inbound email flow.

callbackArchFlowInboundShortMessage(archFlowInboundShortMessage)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect inbound short message flow such as ArchFactoryFlows#createFlowInboundShortMessageAsync

Parameters:

Name	Type	Description
archFlowInboundShortMessage	ArchFlowInboundShortMessage	the Architect inbound short message flow.

callbackArchFlowInfo(archFlowInfo)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect flow info instance such as ArchFlowInfoBasic#getFlowInfoAsync

Parameters:

Name	Type	Description
archFlowInfo	ArchFlowInfo	the Architect flow information object.

callbackArchFlowInfoBasic(archFlowInfoBasic)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect flow info basic instance such as ArchFactoryFlows#getFlowInfoByFlowNameAsync

Parameters:

Name	Type	Description
archFlowInfoBasic	ArchFlowInfoBasic	the Architect flow information object.

callbackArchFlowInQueueCall(archFlowInQueueCall)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect in-queue call flow such as ArchFactoryFlows#createFlowInQueueCallAsync or ArchFactoryFlows#loadFlowDefaultInQueueCallAsync.

Parameters:

Name	Type	Description
archFlowInQueueCall	ArchFlowInQueueCall	the Architect in-queue call flow.

callbackArchFlowInQueueEmail(archFlowInQueueEmail)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect in-queue email flow such as ArchFactoryFlows#createFlowInQueueEmailAsync

Parameters:

Name	Type	Description
archFlowInQueueEmail	ArchFlowInQueueCall	the Architect in-queue email flow.

callbackArchFlowInQueueShortMessage(archFlowInQueueShortMessage)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect in-queue short message flow such as ArchFactoryFlows#createFlowInQueueShortMessageAsync

Parameters:

Name	Type	Description
archFlowInQueueShortMessage	ArchFlowInQueueCall	the Architect in-queue short message flow.

callbackArchFlowOutboundCall(archFlowOutboundCall)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect outbound call flow such as ArchFactoryFlows#createFlowOutboundCallAsync

Parameters:

Name	Type	Description
archFlowOutboundCall	ArchFlowOutboundCall	the Architect outbound call flow.

callbackArchFlowSecureCall(archFlowSecureCall)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect secure call flow such as ArchFactoryFlows#createFlowSecureCallAsync

Parameters:

Name	Type	Description
archFlowSecureCall	ArchFlowSecureCall	the Architect secure call flow.

callbackArchFlowSurveyInvite(archFlowSurveyInvite)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect survey invite flow such as ArchFactoryFlows#createFlowSurveyInviteAsync

Parameters:

Name	Type	Description
archFlowSurveyInvite	ArchFlowSurveyInvite	the Architect survey invite flow.

callbackArchFlowVoicemail(archFlowVoicemail)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect voicemail flow such as ArchFactoryFlows#loadFlowDefaultVoicemailAsync

Parameters:

Name	Type	Description
archFlowVoicemail	ArchFlowVoicemail	the Architect voicemail flow.

callbackArchFlowVoiceSurvey(archFlowVoiceSurvey)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect voice survey flow such as ArchFactoryFlows#createFlowVoiceSurveyAsync

Parameters:

Name	Type	Description
archFlowVoiceSurvey	ArchFlowVoiceSurvey	the Architect voice survey flow.

callbackArchFlowWorkflow(archFlowWorkflow)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect workflow flow such as ArchFactoryFlows#createFlowWorkflowAsync

Parameters:

Name	Type	Description
archFlowWorkflow	ArchFlowWorkflow	the Architect workflow flow.

callbackArchFlowWorkitem(archFlowWorkitem)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect workitem flow such as ArchFactoryFlows#createFlowWorkitemAsync

Parameters:

Name	Type	Description
archFlowWorkitem	ArchFlowWorkitem	the Architect workitem flow.

callbackArchLoggingHook(logInfo) → {boolean}

This callback function type is invoked by Architect Scripting for logging calls when the ArchLogging#setLoggingCallback method is called.

Parameters:

Name	Type	Description
logInfo	object	logging information about the trace. More to come on this later.

Returns:

boolean -

• return true to indicate that your callback has handled the trace and Architect logging should not do its normal logging processing.

callbackArchSettingsSupportedLanguage(ArchSettingsSupportedLanguage)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect supported language settings instance such as ArchSettingsSupportedLanguage#setSpeechToTextEngineByNameAsync

Parameters:

Name	Type	Description
ArchSettingsSupportedLanguage	ArchSettingsSupportedLanguage	the Architect supported language settings instance.

callbackArchValueContactList(ArchValueContactList)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect contact list value instance such as ArchValueContactList#setLiteralByContactListIdAsync or ArchValueContactList#setLiteralByContactListNameAsync

Parameters:

Name	Type	Description
ArchValueContactList	ArchValueContactList	the Architect contact list value instance.

callbackArchValueEmergencyGroup(archValueEmergencyGroup)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect emergency group value instance such as ArchValueEmergencyGroup#setLiteralByEmergencyGroupIdAsync or ArchValueEmergencyGroup#setLiteralByEmergencyGroupNameAsync

Parameters:

Name	Type	Description
archValueEmergencyGroup	ArchValueEmergencyGroup	the Architect emergency group value instance.

callbackArchValueEmergencyGroupCollection(archValueEmergencyGroupCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect emergencyGroup collection instance such as ArchValueEmergencyGroupCollection#addLiteralByEmergencyGroupIdAsync or ArchValueEmergencyGroupCollection#addLiteralByEmergencyGroupNameAsync

Parameters:

Name	Type	Description
archValueEmergencyGroupCollection	ArchValueEmergencyGroupCollection	the Architect emergency group collection value instance.

callbackArchValueGrammar(archValueGrammar)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect grammar value instance such as ArchValueGrammar#setLiteralByGrammarIdAsync or ArchValueGrammar#setLiteralByGrammarNameAsync

Parameters:

Name	Type	Description
archValueGrammar	ArchValueGrammar	the Architect grammar value instance.

callbackArchValueGrammarCollection(archValueGrammarCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect grammar collection instance such as ArchValueGrammarCollection#addLiteralByGrammarIdAsync or ArchValueGrammarCollection#addLiteralByGrammarNameAsync

Parameters:

Name	Type	Description
archValueGrammarCollection	ArchValueGrammarCollection	the Architect grammar collection value instance.

callbackArchValueGroup(archValueGroup)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect group value instance such as ArchValueGroup#setLiteralByGroupIdAsync or ArchValueGroup#setLiteralByGroupNameAsync

Parameters:

Name	Type	Description
archValueGroup	ArchValueGroup	the Architect group value instance.

callbackArchValueGroupCollection(archValueGroupCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect group collection instance such as ArchValueGroupCollection#addLiteralByGroupIdAsync or ArchValueGroupCollection#addLiteralByGroupNameAsync

Parameters:

Name	Type	Description
archValueGroupCollection	ArchValueGroupCollection	the Architect group collection value instance.

callbackArchValueImage(archValueImage)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect image value instance such as ArchValueImage#setLiteralByImageIdAsync or ArchValueImage#setLiteralByImageNameAsync

Parameters:

Name	Type	Description
archValueImage	ArchValueImage	the Architect image value instance.

callbackArchValueKnowledgeBaseDocument(archValueKnowledgeBaseDocument)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect knowledge base document value instance such as ArchValueKnowledgeBaseDocument#setLiteralByKnowledgeBaseDocumentIdAsync or ArchValueKnowledgeBaseDocument#setLiteralByKnowledgeBaseDocumentNameAsync

Parameters:

Name	Type	Description
archValueKnowledgeBaseDocument	ArchValueKnowledgeBaseDocument	the Architect knowledge base document.

callbackArchValueKnowledgeBaseDocumentCollection(archValueKnowledgeBaseDocumentCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect knowledgeBaseDocument collection instance such as ArchValueKnowledgeBaseDocumentCollection#addLiteralByKnowledgeBaseDocumentIdAsync or ArchValueKnowledgeBaseDocumentCollection#addLiteralByKnowledgeBaseDocumentNameAsync

Parameters:

Name	Type	Description
archValueKnowledgeBaseDocumentCollection	ArchValueKnowledgeBaseDocumentCollection	the Architect knowledgeBaseDocument collection value instance.

callbackArchValueLanguageSkill(ArchValueLanguageSkill)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect languageSkill value instance such as ArchValueLanguageSkill#setLiteralByLanguageSkillIdAsync or ArchValueLanguageSkill#setLiteralByLanguageSkillNameAsync

Parameters:

Name	Type	Description
ArchValueLanguageSkill	ArchValueLanguageSkill	the Architect languageSkill value instance.

callbackArchValueLanguageSkillCollection(archValueLanguageSkillCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect languageSkill collection instance such as ArchValueLanguageSkillCollection#addLiteralByLanguageSkillIdAsync or ArchValueLanguageSkillCollection#addLiteralByLanguageSkillNameAsync

Parameters:

Name	Type	Description
archValueLanguageSkillCollection	ArchValueLanguageSkillCollection	the Architect languageSkill collection value instance.

callbackArchValuePrompt(archValuePrompt)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect prompt value instance such as ArchValuePrompt#setLiteralByPromptNameAsync

Parameters:

Name	Type	Description
archValuePrompt	ArchValuePrompt	the Architect prompt value instance.

callbackArchValuePromptCollection(archValuePromptCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect prompt collection instance such as ArchValuePromptCollection#addLiteralByPromptNameAsync

Parameters:

Name	Type	Description
archValuePromptCollection	ArchValuePromptCollection	the Architect prompt collection value instance.

callbackArchValueQueue(archValueQueue)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect queue value instance such as ArchValueQueue#setLiteralByQueueIdAsync or ArchValueQueue#setLiteralByQueueNameAsync

Parameters:

Name	Type	Description
archValueQueue	ArchValueQueue	the Architect queue value instance.

callbackArchValueQueueCollection(archValueQueueCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect queue collection instance such as ArchValueQueueCollection#addLiteralByQueueIdAsync or ArchValueQueueCollection#addLiteralByQueueNameAsync

Parameters:

Name	Type	Description
archValueQueueCollection	ArchValueQueueCollection	the Architect queue collection value instance.

callbackArchValueSchedule(archValueSchedule)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect schedule value instance such as ArchValueSchedule#setLiteralByScheduleIdAsync or ArchValueSchedule#setLiteralByScheduleNameAsync

Parameters:

Name	Type	Description
archValueSchedule	ArchValueSchedule	the Architect schedule value instance.

callbackArchValueScheduleCollection(archValueScheduleCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect schedule collection instance such as ArchValueScheduleCollection#addLiteralByScheduleIdAsync or ArchValueScheduleCollection#addLiteralByScheduleNameAsync

Parameters:

Name	Type	Description
archValueScheduleCollection	ArchValueScheduleCollection	the Architect schedule collection value instance.

callbackArchValueScheduleGroup(archValueScheduleGroup)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect schedule group value instance such as ArchValueScheduleGroup#setLiteralByScheduleGroupIdAsync or ArchValueScheduleGroup#setLiteralByScheduleGroupNameAsync

Parameters:

Name	Type	Description
archValueScheduleGroup	ArchValueScheduleGroup	the Architect schedule group value instance.

callbackArchValueScheduleGroupCollection(archValueScheduleGroupCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect schedule group collection instance such as ArchValueScheduleGroupCollection#addLiteralByScheduleGroupIdAsync or ArchValueScheduleGroupCollection#addLiteralByScheduleGroupNameAsync

Parameters:

Name	Type	Description
archValueScheduleGroupCollection	ArchValueScheduleGroupCollection	the Architect schedule group collection value instance.

callbackArchValueSkill(archValueSkill)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect skill value instance such as ArchValueSkill#setLiteralBySkillIdAsync or ArchValueSkill#setLiteralBySkillNameAsync

Parameters:

Name	Type	Description
archValueSkill	ArchValueSkill	the Architect skill value instance.

callbackArchValueSkillCollection(archValueSkillCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect skill collection instance such as ArchValueSkillCollection#addLiteralBySkillIdAsync or ArchValueSkillCollection#addLiteralBySkillNameAsync

Parameters:

Name	Type	Description
archValueSkillCollection	ArchValueSkillCollection	the Architect skill collection value instance.

callbackArchValueUser(archValueUser)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect user value instance such as ArchValueUser#setLiteralByUserIdAsync or ArchValueUser#setLiteralByUserNameAsync

Parameters:

Name	Type	Description
archValueUser	ArchValueUser	the Architect user value instance.

callbackArchValueUserCollection(archValueUserCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect user collection instance such as ArchValueUserCollection#addLiteralByUserIdAsync or ArchValueUserCollection#addLiteralByUserNameAsync

Parameters:

Name	Type	Description
archValueUserCollection	ArchValueUserCollection	the Architect user collection value instance.

callbackArchValueUtilizationLabel(archValueUtilizationLabel)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect utilization label instance such as ArchValueUtilizationLabel#setLiteralByUtilizationLabelNameAsync or ArchValueUtilizationLabel#setLiteralByUtilizationLabelIdAsync

Parameters:

Name	Type	Description
archValueUtilizationLabel	ArchValueUtilizationLabel	the Architect utilization label value instance.

callbackArchValueUtilizationLabelCollection(archValueUtilizationLabelCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect utilization label collection instance such as ArchValueUtilizationLabelCollection#addLiteralByUtilizationLabelIdAsync or ArchValueUtilizationLabelCollection#addLiteralByUtilizationLabelNameAsync

Parameters:

Name	Type	Description
archValueUtilizationLabelCollection	ArchValueUtilizationLabelCollection	the Architect utilization label collection value instance.

callbackArchValueWrapupCode(archValueWrapupCode)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect wrapup code value instance such as ArchValueWrapupCode#setLiteralByWrapupCodeIdAsync or ArchValueWrapupCode#setLiteralByWrapupCodeNameAsync

Parameters:

Name	Type	Description
archValueWrapupCode	ArchValueWrapupCode	the Architect wrapup code value instance.

callbackArchValueWrapupCodeCollection(archValueWrapupCodeCollection)

This callback function type is invoked by Architect Scripting where the callback function is passed an Architect wrapup code collection instance such as ArchValueWrapupCodeCollection#addLiteralByWrapupCodeIdAsync or ArchValueWrapupCodeCollection#addLiteralByWrapupCodeNameAsync

Parameters:

Name	Type	Description
archValueWrapupCodeCollection	ArchValueWrapupCodeCollection	the Architect wrapup code collection value instance.

callbackExportFullPath(exportFullPath)

This callback function type is invoked by Architect Scripting where the callback function is passed a string that contains the full path to a saved flow export such as ArchBaseFlow#exportToDirAsync

Parameters:

Name	Type	Description
exportFullPath	string	a string that contains the full path where the flow export was saved.

callbackExportObject(exportObject)

This callback function type is invoked by Architect Scripting where the callback function is passed a JSON object that contains flow export information such as ArchBaseFlow#exportToObjectAsync

Parameters:

Name	Type	Description
exportObject	object	a JSON object with a content property that holds the flow export contents and a fileName property that holds the file name that would be used if saved from ArchBaseFlow#exportToDirAsync.

callbackFilterClauseProperty(propertyValue, archBaseCoreObject, propertyName) → {boolean}

This callback function type is invoked by Architect Scripting where the callback function is passed a property value, property name and the ArchBaseObject instance that contains the property for the purposes of determining if this filter clause should be treated as a match or not. The function should return true if it should be treated as a match and false or nothing if not. Returning a non-boolean value will not be treated as a match.

Parameters:

Name	Type	Description
propertyValue	any	the value of the property to check.
archBaseCoreObject	ArchBaseCoreObject	the object that contains the property.
propertyName	string	the name of the property on the object being checked.

Returns:

boolean

callbackSessionEnd(archSession)

This callback is invoked by Architect Scripting when the session is about to end and is passed the ArchSession instance such as ArchSession#startWithClientIdAndSecret and ArchSession#startWithAuthToken.

Parameters:

Name	Type	Description
archSession	ArchSession	the Architect Scripting session associated with the session end callback. You can access properties like the ArchSession#endExitCode to do additional processing.

callbackSessionStart(archSession)

This callback is invoked by Architect Scripting where the callback function is passed the ArchSession instance such as ArchSession#startWithClientIdAndSecret and ArchSession#startWithAuthToken.

Parameters:

Name	Type	Description
archSession	ArchSession	the Architect Scripting session associated with the session start. There is only one instance of the Architect session in scripting so this instance is being passed in as a convenience if you want to get access to it from this parameter in code.

callbackTraverseInfo(archCallbackTraverseContext)

This callback function type is invoked by Architect Scripting where the callback function is passed a traverse info object.

Parameters:

Name	Type	Description
archCallbackTraverseContext	ArchTraverseInfo	an ArchTraverseContext object that contains a pointer to the object that matched the traverse filter as well as other contextual information about it.

callbackVoid()

This callback function type is invoked by Architect Scripting where the callback function is not given any parameters. This is the case where the function manipulates itself such as ArchBaseFlow#loadAsync

NameAndIdType

The type definition for a name and id object for creation data.

Properties:

Name	Type	Attributes	Description
name	string	<optional>
id	string	<optional>

WorkitemCreationData

The type definition for the creationData property on ArchFactoryFlows#createFlowWorkitemAsync

Properties:

Name	Type	Description
worktype	NameAndIdType