SDK Reference · Method

interruptConversation

Interrupts current Conversation processing and redirects execution to a specified module.

Declaration

public func interruptConversation(goTo moduleID: String) -> STResult

Overview

Requires initialization. If the Conversation is already idle or stopping, the method returns .success as a no-op. Otherwise the request is delegated to the Conversation manager.

moduleID should identify the Conversation module where execution is intended to continue.

Design guidance

Interruption is a controlled redirection mechanism, not merely another form of stop. If the application expects the Conversation to continue, redirect to an appropriate executable/resumable module rather than treating the Conversation end boundary as a temporary interruption target.

Redirecting execution

Supply a valid destination module ID from the loaded Conversation. Interrupting is a control request; use callbacks to observe the subsequent module transition.

Parameters

moduleID — String Refer to the method-specific behavior and usage example for how this parameter is used.

Usage example

_ = conversation.interruptConversation(goTo: "cm.pr.processUserRequest")

Result handling

This method returns an STResult. Check the returned value for success or failure.