SDK Reference · Method

pauseConversation

Requests that active Conversation processing pause.

Declaration

public func pauseConversation() -> STResult

Overview

The runner must be initialized and the Conversation manager must be active. Otherwise the method returns .conversationNotInitialized or .conversationNotActive.

If the underlying manager reports that the Conversation is already paused, .conversationPaused is returned rather than being converted to .success.

Important distinction

This is an application-level request to pause Conversation processing. It should not be confused with the declarative pause module, whose resume behavior is part of the Conversation definition/runtime flow.

Pause request and notification

Pausing is a control request; use the relevant callback to observe the resulting pause state. Do not interpret request acceptance as confirmation that all processing has already paused.

Usage example

_ = conversation.pauseConversation()

Result handling

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