qisdk / com.aldebaran.qi.sdk.object.conversation / Discuss

Discuss

interface Discuss

Action to make the robot able to converse with a human using content from QiChat topics.

Since
1

Types

Async

interface Async

OnBookmarkReachedListener

Listener for bookmarkReached signal

interface OnBookmarkReachedListener

OnFallbackReplyFoundForListener

Listener for fallbackReplyFoundFor signal

interface OnFallbackReplyFoundForListener

OnFocusedTopicChangedListener

Listener for focusedTopic property changed event

interface OnFocusedTopicChangedListener

OnHeardListener

Listener for heard signal

interface OnHeardListener

OnHearingChangedListener

Listener for hearing property changed event

interface OnHearingChangedListener

OnLatestInputUtteranceChangedListener

Listener for latestInputUtterance property changed event

interface OnLatestInputUtteranceChangedListener

OnLatestOutputUtteranceChangedListener

Listener for latestOutputUtterance property changed event

interface OnLatestOutputUtteranceChangedListener

OnListeningChangedListener

Listener for listening property changed event

interface OnListeningChangedListener

OnNoPhraseRecognizedListener

Listener for noPhraseRecognized signal

interface OnNoPhraseRecognizedListener

OnNoReplyFoundForListener

Listener for noReplyFoundFor signal

interface OnNoReplyFoundForListener

OnNormalReplyFoundForListener

Listener for normalReplyFoundFor signal

interface OnNormalReplyFoundForListener

OnSayingChangedListener

Listener for saying property changed event

interface OnSayingChangedListener

OnStartedListener

Listener for started signal

interface OnStartedListener

Functions

addOnBookmarkReachedListener

Add a OnBookmarkReachedListener

abstract fun addOnBookmarkReachedListener(onBookmarkReachedListener: OnBookmarkReachedListener!): Unit

addOnFallbackReplyFoundForListener

Add a OnFallbackReplyFoundForListener

abstract fun addOnFallbackReplyFoundForListener(onFallbackReplyFoundForListener: OnFallbackReplyFoundForListener!): Unit

addOnFocusedTopicChangedListener

Add a property changed listener for focusedTopic

abstract fun addOnFocusedTopicChangedListener(onFocusedTopicChangedListener: OnFocusedTopicChangedListener!): Unit

addOnHeardListener

Add a OnHeardListener

abstract fun addOnHeardListener(onHeardListener: OnHeardListener!): Unit

addOnHearingChangedListener

Add a property changed listener for hearing

abstract fun addOnHearingChangedListener(onHearingChangedListener: OnHearingChangedListener!): Unit

addOnLatestInputUtteranceChangedListener

Add a property changed listener for latestInputUtterance

abstract fun addOnLatestInputUtteranceChangedListener(onLatestInputUtteranceChangedListener: OnLatestInputUtteranceChangedListener!): Unit

addOnLatestOutputUtteranceChangedListener

Add a property changed listener for latestOutputUtterance

abstract fun addOnLatestOutputUtteranceChangedListener(onLatestOutputUtteranceChangedListener: OnLatestOutputUtteranceChangedListener!): Unit

addOnListeningChangedListener

Add a property changed listener for listening

abstract fun addOnListeningChangedListener(onListeningChangedListener: OnListeningChangedListener!): Unit

addOnNoPhraseRecognizedListener

Add a OnNoPhraseRecognizedListener

abstract fun addOnNoPhraseRecognizedListener(onNoPhraseRecognizedListener: OnNoPhraseRecognizedListener!): Unit

addOnNoReplyFoundForListener

Add a OnNoReplyFoundForListener

abstract fun addOnNoReplyFoundForListener(onNoReplyFoundForListener: OnNoReplyFoundForListener!): Unit

addOnNormalReplyFoundForListener

Add a OnNormalReplyFoundForListener

abstract fun addOnNormalReplyFoundForListener(onNormalReplyFoundForListener: OnNormalReplyFoundForListener!): Unit

addOnSayingChangedListener

Add a property changed listener for saying

abstract fun addOnSayingChangedListener(onSayingChangedListener: OnSayingChangedListener!): Unit

addOnStartedListener

Add a OnStartedListener

abstract fun addOnStartedListener(onStartedListener: OnStartedListener!): Unit

async

abstract fun async(): Async!

bookmarkStatus

Obtain an object to observe and act on the given state of Bookmark during the action execution.

abstract fun bookmarkStatus(bookmark: Bookmark!): BookmarkStatus!

concept

Get the content of the concept with the given name that can be converted to a string This works with both static and dynamic concepts. (For a primer on static and dynamic concepts, please refer to the QiChat documentation)

abstract fun concept(conceptName: String!): PhraseSet!

dynamicConcept

Retrieve the dynamic concept with the given name This works only with dynamic concepts. (For a primer on static and dynamic concepts, please refer to the QiChat documentation)

abstract fun dynamicConcept(conceptName: String!): EditablePhraseSet!

focusedTopicRecommendations

Obtain a list of possible human utterances for the currently focused topic of this running Discuss action

abstract fun focusedTopicRecommendations(): PhraseSet!

getFocusedTopic

Exposes the property focusedTopic value

abstract fun getFocusedTopic(): Topic!

getHearing

Exposes the property hearing value

abstract fun getHearing(): Boolean!

getLatestInputUtterance

Exposes the property latestInputUtterance value

abstract fun getLatestInputUtterance(): Phrase!

getLatestOutputUtterance

Exposes the property latestOutputUtterance value

abstract fun getLatestOutputUtterance(): Phrase!

getListening

Exposes the property listening value

abstract fun getListening(): Boolean!

getSaying

Exposes the property saying value

abstract fun getSaying(): Phrase!

getTopics

Exposes the property topics value

abstract fun getTopics(): MutableList<Topic!>!

globalRecommendations

Obtain a list of possible human utterances for this running Discuss action as whole

abstract fun globalRecommendations(): PhraseSet!

goToBookmarkedOutputUtterance

Make the robot execute the interaction at the given Bookmark, regardless of whether the Bookmark would be emitted

abstract fun goToBookmarkedOutputUtterance(bookmark: Bookmark!): Boolean!

goToBookmarkedOutputUtteranceIfBookmarkIsReachable

Make the robot execute the interaction at the given Bookmark, only if the Bookmark can be emitted.

abstract fun goToBookmarkedOutputUtteranceIfBookmarkIsReachable(bookmark: Bookmark!): Unit

removeAllOnBookmarkReachedListeners

Remove all OnBookmarkReachedListener

abstract fun removeAllOnBookmarkReachedListeners(): Unit

removeAllOnFallbackReplyFoundForListeners

Remove all OnFallbackReplyFoundForListener

abstract fun removeAllOnFallbackReplyFoundForListeners(): Unit

removeAllOnFocusedTopicChangedListeners

Remove all focusedTopic changed listeners

abstract fun removeAllOnFocusedTopicChangedListeners(): Unit

removeAllOnHeardListeners

Remove all OnHeardListener

abstract fun removeAllOnHeardListeners(): Unit

removeAllOnHearingChangedListeners

Remove all hearing changed listeners

abstract fun removeAllOnHearingChangedListeners(): Unit

removeAllOnLatestInputUtteranceChangedListeners

Remove all latestInputUtterance changed listeners

abstract fun removeAllOnLatestInputUtteranceChangedListeners(): Unit

removeAllOnLatestOutputUtteranceChangedListeners

Remove all latestOutputUtterance changed listeners

abstract fun removeAllOnLatestOutputUtteranceChangedListeners(): Unit

removeAllOnListeningChangedListeners

Remove all listening changed listeners

abstract fun removeAllOnListeningChangedListeners(): Unit

removeAllOnNoPhraseRecognizedListeners

Remove all OnNoPhraseRecognizedListener

abstract fun removeAllOnNoPhraseRecognizedListeners(): Unit

removeAllOnNoReplyFoundForListeners

Remove all OnNoReplyFoundForListener

abstract fun removeAllOnNoReplyFoundForListeners(): Unit

removeAllOnNormalReplyFoundForListeners

Remove all OnNormalReplyFoundForListener

abstract fun removeAllOnNormalReplyFoundForListeners(): Unit

removeAllOnSayingChangedListeners

Remove all saying changed listeners

abstract fun removeAllOnSayingChangedListeners(): Unit

removeAllOnStartedListeners

Remove all OnStartedListener

abstract fun removeAllOnStartedListeners(): Unit

removeOnBookmarkReachedListener

Remove a OnBookmarkReachedListener

abstract fun removeOnBookmarkReachedListener(onBookmarkReachedListener: OnBookmarkReachedListener!): Unit

removeOnFallbackReplyFoundForListener

Remove a OnFallbackReplyFoundForListener

abstract fun removeOnFallbackReplyFoundForListener(onFallbackReplyFoundForListener: OnFallbackReplyFoundForListener!): Unit

removeOnFocusedTopicChangedListener

Remove a property changed listener for focusedTopic

abstract fun removeOnFocusedTopicChangedListener(onFocusedTopicChangedListener: OnFocusedTopicChangedListener!): Unit

removeOnHeardListener

Remove a OnHeardListener

abstract fun removeOnHeardListener(onHeardListener: OnHeardListener!): Unit

removeOnHearingChangedListener

Remove a property changed listener for hearing

abstract fun removeOnHearingChangedListener(onHearingChangedListener: OnHearingChangedListener!): Unit

removeOnLatestInputUtteranceChangedListener

Remove a property changed listener for latestInputUtterance

abstract fun removeOnLatestInputUtteranceChangedListener(onLatestInputUtteranceChangedListener: OnLatestInputUtteranceChangedListener!): Unit

removeOnLatestOutputUtteranceChangedListener

Remove a property changed listener for latestOutputUtterance

abstract fun removeOnLatestOutputUtteranceChangedListener(onLatestOutputUtteranceChangedListener: OnLatestOutputUtteranceChangedListener!): Unit

removeOnListeningChangedListener

Remove a property changed listener for listening

abstract fun removeOnListeningChangedListener(onListeningChangedListener: OnListeningChangedListener!): Unit

removeOnNoPhraseRecognizedListener

Remove a OnNoPhraseRecognizedListener

abstract fun removeOnNoPhraseRecognizedListener(onNoPhraseRecognizedListener: OnNoPhraseRecognizedListener!): Unit

removeOnNoReplyFoundForListener

Remove a OnNoReplyFoundForListener

abstract fun removeOnNoReplyFoundForListener(onNoReplyFoundForListener: OnNoReplyFoundForListener!): Unit

removeOnNormalReplyFoundForListener

Remove a OnNormalReplyFoundForListener

abstract fun removeOnNormalReplyFoundForListener(onNormalReplyFoundForListener: OnNormalReplyFoundForListener!): Unit

removeOnSayingChangedListener

Remove a property changed listener for saying

abstract fun removeOnSayingChangedListener(onSayingChangedListener: OnSayingChangedListener!): Unit

removeOnStartedListener

Remove a OnStartedListener

abstract fun removeOnStartedListener(onStartedListener: OnStartedListener!): Unit

run

Start the discussion The robot starts to listen, react and talk using the content of the loaded topics If the robot is in a language different from the action language, the robot language will be changed.

abstract fun run(): String!

scopeRecommendations

Obtain a list of possible human utterances for the current scope of this running Discuss action

abstract fun scopeRecommendations(): PhraseSet!

setOnBookmarkReachedListener

Set a OnBookmarkReachedListener

abstract fun setOnBookmarkReachedListener(onBookmarkReachedListener: OnBookmarkReachedListener!): Unit

setOnFallbackReplyFoundForListener

Set a OnFallbackReplyFoundForListener

abstract fun setOnFallbackReplyFoundForListener(onFallbackReplyFoundForListener: OnFallbackReplyFoundForListener!): Unit

setOnFocusedTopicChangedListener

Set a property changed listener for focusedTopic

abstract fun setOnFocusedTopicChangedListener(onFocusedTopicChangedListener: OnFocusedTopicChangedListener!): Unit

setOnHeardListener

Set a OnHeardListener

abstract fun setOnHeardListener(onHeardListener: OnHeardListener!): Unit

setOnHearingChangedListener

Set a property changed listener for hearing

abstract fun setOnHearingChangedListener(onHearingChangedListener: OnHearingChangedListener!): Unit

setOnLatestInputUtteranceChangedListener

Set a property changed listener for latestInputUtterance

abstract fun setOnLatestInputUtteranceChangedListener(onLatestInputUtteranceChangedListener: OnLatestInputUtteranceChangedListener!): Unit

setOnLatestOutputUtteranceChangedListener

Set a property changed listener for latestOutputUtterance

abstract fun setOnLatestOutputUtteranceChangedListener(onLatestOutputUtteranceChangedListener: OnLatestOutputUtteranceChangedListener!): Unit

setOnListeningChangedListener

Set a property changed listener for listening

abstract fun setOnListeningChangedListener(onListeningChangedListener: OnListeningChangedListener!): Unit

setOnNoPhraseRecognizedListener

Set a OnNoPhraseRecognizedListener

abstract fun setOnNoPhraseRecognizedListener(onNoPhraseRecognizedListener: OnNoPhraseRecognizedListener!): Unit

setOnNoReplyFoundForListener

Set a OnNoReplyFoundForListener

abstract fun setOnNoReplyFoundForListener(onNoReplyFoundForListener: OnNoReplyFoundForListener!): Unit

setOnNormalReplyFoundForListener

Set a OnNormalReplyFoundForListener

abstract fun setOnNormalReplyFoundForListener(onNormalReplyFoundForListener: OnNormalReplyFoundForListener!): Unit

setOnSayingChangedListener

Set a property changed listener for saying

abstract fun setOnSayingChangedListener(onSayingChangedListener: OnSayingChangedListener!): Unit

setOnStartedListener

Set a OnStartedListener

abstract fun setOnStartedListener(onStartedListener: OnStartedListener!): Unit

topicStatus

Obtain an object to observe and act on the given state of a Topic during the action execution.

abstract fun topicStatus(topic: Topic!): TopicStatus!

variable

Obtain access to the variable with the given name

abstract fun variable(varName: String!): QiChatVariable!