stopConversation

Requests that the current Conversation stop.

Declaration

public func stopConversation() -> STResult

Overview

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

A successful request does not imply that all asynchronous stop processing has already completed.

Request versus completion

A successful request result does not, by itself, confirm that asynchronous conversation processing has stopped. Observe conversation lifecycle callbacks for the resulting state.

Usage example

_ = conversation.stopConversation()

Result handling

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

See Also

• runConversation
• pauseConversation