Type Definitions
-
CacheStats
-
The type definition for the cache statistics returned by
ArchSession#cacheStats.Properties:
Name Type Description idCacheSizenumber The number of unique IDs currently stored in the cache.
valueCacheSizenumber The number of unique values currently stored in the cache.
maxSizePerTypenumber The maximum number of items that can be stored for a single dependency type.
maxTotalSizenumber The maximum total size of the cache.
hitRatestring The hit rate percentage of the cache.
totalHitsnumber The total number of hits in the cache.
totalMissesnumber The total number of misses in the cache.
-
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#setSpeechToTextEngineByNameAsyncandArchActionAskForSlot#setSpeechToTextEngineByIdAsyncParameters:
Name Type Description ArchActionAskForSlotArchActionAskForSlot 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#setBotByIdAsyncParameters:
Name Type Description ArchActionCallBotConnectorArchActionCallBotConnector 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#setCommonModuleFlowByIdAsyncParameters:
Name Type Description ArchActionCallCommonModuleArchActionCallCommonModule 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#setDataActionByIdAsyncParameters:
Name Type Description ArchActionCallDataArchActionCallData 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#setDataSecureActionByIdAsyncorArchActionCallDataSecure#setDataSecureActionByNameAsync.Parameters:
Name Type Description ArchActionCallDataSecureArchActionCallDataSecure 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#setDialogEngineBotByIdAsyncParameters:
Name Type Description ArchActionCallDialogEngineBotArchActionCallDialogEngineBot 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#setLexBotAliasByIdAsyncParameters:
Name Type Description ArchActionCallLexBotArchActionCallLexBot 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#setLexBotAliasByIdAsyncParameters:
Name Type Description ArchActionCallLexV2BotArchActionCallLexV2Bot 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#setBotByIdAsyncParameters:
Name Type Description ArchActionCallNuanceMixBotArchActionCallNuanceMixBot 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#setScriptByNameAsyncorArchActionCreateCallback#setScriptByIdAsync.Parameters:
Name Type Description archActionCreateCallbackArchActionCreateCallback 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#setDataTableByIdAsyncParameters:
Name Type Description ArchActionDataTableLookupArchActionDataTableLookup 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#setScheduleByNameAsyncParameters:
Name Type Description ArchActionEvaluateScheduleArchActionEvaluateSchedule 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#setScheduleGroupByNameAsyncParameters:
Name Type Description ArchActionEvaluateScheduleGroupArchActionEvaluateScheduleGroup 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#setResponseByIdAsyncParameters:
Name Type Description ArchActionGetResponseArchActionGetResponse 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#setScriptByNameAsyncorArchActionSetScreenPop#setScriptByIdAsync.Parameters:
Name Type Description archActionSetScreenPopArchActionSetScreenPop 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#setLiteralByKnowledgeBaseDocumentNameAsyncParameters:
Name Type Description ArchActionShowKnowledgeArticleArchActionShowKnowledgeArticle 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#addLiteralBySkillNameAsyncorArchActionTransferToAcd#setLiteralByQueueNameAsyncParameters:
Name Type Description archArchActionTransferToAcdArchActionTransferToAcd 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#setTargetQueueLiteralByQueueIdAsyncorArchActionTransferToVoicemail#setTargetQueueLiteralByQueueNameAsyncParameters:
Name Type Description archActionTransferToVoicemailArchActionTransferToVoicemail 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#setDataActionByIdAsyncParameters:
Name Type Description ArchBaseActionDataActionArchBaseActionDataAction 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#setDialogflowAgentByNameAsyncParameters:
Name Type Description ArchBaseActionDialogflowArchBaseActionDialogflow 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#setScheduleByNameAsyncParameters:
Name Type Description ArchBaseActionScheduleArchBaseActionSchedule 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#loadFlowByFlowNameAsyncParameters:
Name Type Description archBaseFlowArchBaseFlow 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#getPromptByPromptNameAsyncParameters:
Name Type Description archBasePromptArchBasePrompt 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#addLiteralBySkillIdAsyncorArchBaseSkillValuePairs#addLiteralBySkillNameAsyncParameters:
Name Type Description archBaseSkillValuePairsArchBaseSkillValuePairs 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#createFlowBotAsyncParameters:
Name Type Description archFlowBotArchFlowBot 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#createFlowCommonModuleAsyncParameters:
Name Type Description archFlowCommonModuleArchFlowCommonModule 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#createFlowDigitalBotAsyncParameters:
Name Type Description archFlowDigitalBotArchFlowDigitalBot 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#createFlowInboundCallAsyncParameters:
Name Type Description archFlowInboundCallArchFlowInboundCall 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#createFlowInboundChatAsyncParameters:
Name Type Description archFlowInboundChatArchFlowInboundChat 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#createFlowInboundEmailAsyncParameters:
Name Type Description archFlowInboundEmailArchFlowInboundEmail 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#createFlowInboundShortMessageAsyncParameters:
Name Type Description archFlowInboundShortMessageArchFlowInboundShortMessage 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#getFlowInfoAsyncParameters:
Name Type Description archFlowInfoArchFlowInfo 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#getFlowInfoByFlowNameAsyncParameters:
Name Type Description archFlowInfoBasicArchFlowInfoBasic 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#createFlowInQueueCallAsyncorArchFactoryFlows#loadFlowDefaultInQueueCallAsync.Parameters:
Name Type Description archFlowInQueueCallArchFlowInQueueCall 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#createFlowInQueueEmailAsyncParameters:
Name Type Description archFlowInQueueEmailArchFlowInQueueCall 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#createFlowInQueueShortMessageAsyncParameters:
Name Type Description archFlowInQueueShortMessageArchFlowInQueueCall 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#createFlowOutboundCallAsyncParameters:
Name Type Description archFlowOutboundCallArchFlowOutboundCall 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#createFlowSecureCallAsyncParameters:
Name Type Description archFlowSecureCallArchFlowSecureCall 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#createFlowSurveyInviteAsyncParameters:
Name Type Description archFlowSurveyInviteArchFlowSurveyInvite 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#loadFlowDefaultVoicemailAsyncParameters:
Name Type Description archFlowVoicemailArchFlowVoicemail 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#createFlowVoiceSurveyAsyncParameters:
Name Type Description archFlowVoiceSurveyArchFlowVoiceSurvey 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#createFlowWorkflowAsyncParameters:
Name Type Description archFlowWorkflowArchFlowWorkflow 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#createFlowWorkitemAsyncParameters:
Name Type Description archFlowWorkitemArchFlowWorkitem the Architect workitem flow.
-
callbackArchLoggingHook(logInfo) → {boolean}
-
This callback function type is invoked by Architect Scripting for logging calls when the
ArchLogging#setLoggingCallbackmethod is called.Parameters:
Name Type Description logInfoobject 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#setSpeechToTextEngineByNameAsyncParameters:
Name Type Description ArchSettingsSupportedLanguageArchSettingsSupportedLanguage 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#setLiteralByContactListIdAsyncorArchValueContactList#setLiteralByContactListNameAsyncParameters:
Name Type Description ArchValueContactListArchValueContactList 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#setLiteralByEmergencyGroupIdAsyncorArchValueEmergencyGroup#setLiteralByEmergencyGroupNameAsyncParameters:
Name Type Description archValueEmergencyGroupArchValueEmergencyGroup 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#addLiteralByEmergencyGroupIdAsyncorArchValueEmergencyGroupCollection#addLiteralByEmergencyGroupNameAsyncParameters:
Name Type Description archValueEmergencyGroupCollectionArchValueEmergencyGroupCollection 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#setLiteralByGrammarIdAsyncorArchValueGrammar#setLiteralByGrammarNameAsyncParameters:
Name Type Description archValueGrammarArchValueGrammar 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#addLiteralByGrammarIdAsyncorArchValueGrammarCollection#addLiteralByGrammarNameAsyncParameters:
Name Type Description archValueGrammarCollectionArchValueGrammarCollection 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#setLiteralByGroupIdAsyncorArchValueGroup#setLiteralByGroupNameAsyncParameters:
Name Type Description archValueGroupArchValueGroup 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#addLiteralByGroupIdAsyncorArchValueGroupCollection#addLiteralByGroupNameAsyncParameters:
Name Type Description archValueGroupCollectionArchValueGroupCollection 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#setLiteralByImageIdAsyncorArchValueImage#setLiteralByImageNameAsyncParameters:
Name Type Description archValueImageArchValueImage 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#setLiteralByKnowledgeBaseDocumentIdAsyncorArchValueKnowledgeBaseDocument#setLiteralByKnowledgeBaseDocumentNameAsyncParameters:
Name Type Description archValueKnowledgeBaseDocumentArchValueKnowledgeBaseDocument 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#addLiteralByKnowledgeBaseDocumentIdAsyncorArchValueKnowledgeBaseDocumentCollection#addLiteralByKnowledgeBaseDocumentNameAsyncParameters:
Name Type Description archValueKnowledgeBaseDocumentCollectionArchValueKnowledgeBaseDocumentCollection 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#setLiteralByLanguageSkillIdAsyncorArchValueLanguageSkill#setLiteralByLanguageSkillNameAsyncParameters:
Name Type Description ArchValueLanguageSkillArchValueLanguageSkill 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#addLiteralByLanguageSkillIdAsyncorArchValueLanguageSkillCollection#addLiteralByLanguageSkillNameAsyncParameters:
Name Type Description archValueLanguageSkillCollectionArchValueLanguageSkillCollection the Architect languageSkill collection value instance.
-
callbackArchValuePhoneNumber(archValuePhoneNumber)
-
This callback function type is invoked by Architect Scripting where the callback function is passed an Architect phone number instance such as
ArchValuePhoneNumber#setLiteralBySmsPhoneNumberIdAsyncParameters:
Name Type Description archValuePhoneNumberArchValuePhoneNumber the Architect phone number 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#setLiteralByPromptNameAsyncParameters:
Name Type Description archValuePromptArchValuePrompt 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#addLiteralByPromptNameAsyncParameters:
Name Type Description archValuePromptCollectionArchValuePromptCollection 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#setLiteralByQueueIdAsyncorArchValueQueue#setLiteralByQueueNameAsyncParameters:
Name Type Description archValueQueueArchValueQueue 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#addLiteralByQueueIdAsyncorArchValueQueueCollection#addLiteralByQueueNameAsyncParameters:
Name Type Description archValueQueueCollectionArchValueQueueCollection 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#setLiteralByScheduleIdAsyncorArchValueSchedule#setLiteralByScheduleNameAsyncParameters:
Name Type Description archValueScheduleArchValueSchedule 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#addLiteralByScheduleIdAsyncorArchValueScheduleCollection#addLiteralByScheduleNameAsyncParameters:
Name Type Description archValueScheduleCollectionArchValueScheduleCollection 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#setLiteralByScheduleGroupIdAsyncorArchValueScheduleGroup#setLiteralByScheduleGroupNameAsyncParameters:
Name Type Description archValueScheduleGroupArchValueScheduleGroup 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#addLiteralByScheduleGroupIdAsyncorArchValueScheduleGroupCollection#addLiteralByScheduleGroupNameAsyncParameters:
Name Type Description archValueScheduleGroupCollectionArchValueScheduleGroupCollection 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#setLiteralBySkillIdAsyncorArchValueSkill#setLiteralBySkillNameAsyncParameters:
Name Type Description archValueSkillArchValueSkill 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#addLiteralBySkillIdAsyncorArchValueSkillCollection#addLiteralBySkillNameAsyncParameters:
Name Type Description archValueSkillCollectionArchValueSkillCollection 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#setLiteralByUserIdAsyncorArchValueUser#setLiteralByUserNameAsyncParameters:
Name Type Description archValueUserArchValueUser 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#addLiteralByUserIdAsyncorArchValueUserCollection#addLiteralByUserNameAsyncParameters:
Name Type Description archValueUserCollectionArchValueUserCollection 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#setLiteralByUtilizationLabelNameAsyncorArchValueUtilizationLabel#setLiteralByUtilizationLabelIdAsyncParameters:
Name Type Description archValueUtilizationLabelArchValueUtilizationLabel 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#addLiteralByUtilizationLabelIdAsyncorArchValueUtilizationLabelCollection#addLiteralByUtilizationLabelNameAsyncParameters:
Name Type Description archValueUtilizationLabelCollectionArchValueUtilizationLabelCollection 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#setLiteralByWrapupCodeIdAsyncorArchValueWrapupCode#setLiteralByWrapupCodeNameAsyncParameters:
Name Type Description archValueWrapupCodeArchValueWrapupCode 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#addLiteralByWrapupCodeIdAsyncorArchValueWrapupCodeCollection#addLiteralByWrapupCodeNameAsyncParameters:
Name Type Description archValueWrapupCodeCollectionArchValueWrapupCodeCollection 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#exportToDirAsyncParameters:
Name Type Description exportFullPathstring 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#exportToObjectAsyncParameters:
Name Type Description exportObjectobject 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 propertyValueany the value of the property to check.
archBaseCoreObjectArchBaseCoreObject the object that contains the property.
propertyNamestring 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
ArchSessioninstance such asArchSession#startWithClientIdAndSecretandArchSession#startWithAuthToken.Parameters:
Name Type Description archSessionArchSession the Architect Scripting session associated with the session end callback. You can access properties like the
ArchSession#endExitCodeto do additional processing. -
callbackSessionStart(archSession)
-
This callback is invoked by Architect Scripting where the callback function is passed the
ArchSessioninstance such asArchSession#startWithClientIdAndSecretandArchSession#startWithAuthToken.Parameters:
Name Type Description archSessionArchSession 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 infoobject.Parameters:
Name Type Description archCallbackTraverseContextArchTraverseInfo an
ArchTraverseContextobject 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 namestring <optional>
idstring <optional>
-
SessionStartOptions
-
The type definition for session start options passed to
ArchSession#startWithAuthTokenandArchSession#startWithClientIdAndSecretProperties:
Name Type Attributes Default Description cacheEnabledboolean <optional>
false Enables network value caching when set to true. With caching enabled, Architect Scripting will store the results of network object lookups such as searching for a queue named "Marketing" so that repeated searches for the same object can quickly return the cached result instead of performing a new network request. Note that enabling this feature can improve performance for repeated lookups, but may also increase Architect Scripting's memory usage.
showCacheDiagnosticsboolean <optional>
false if caching is enabled, this specifies whether to show cache usage diagnostics when the session ends.
-
StubCreationInfoType
-
The type definition for stub flow creation information
Properties:
Name Type Description divisionstring The name of the division to create the stub flow
defaultLanguagestring The default language for the stub flow
-
WorkitemCreationData
-
The type definition for the creationData property on
ArchFactoryFlows#createFlowWorkitemAsyncProperties:
Name Type Description worktypeNameAndIdType