qisdk / com.aldebaran.qi.sdk.object.focus / Focus

Focus

interface Focus

A service tracking the current focus, and guaranteeing that only one client has the focus at the same time. The focus is required for actions to be performed on the robot. This mechanism ensures the focus owner that it can be the only one to control the robot as long as its FocusOwner is not released.

Since
1

Types

Async

interface Async

Functions

async

abstract fun async(): Async!

check

Check the FocusOwner provided to tell whether it is recognized as representing the current focused activity.

abstract fun check(focusOwner: FocusOwner!): Boolean!

take

Take the focus. It may fail if the robot is busy and focused on something else, for example in an interactive activity or in safeguard.

abstract fun take(): FocusOwner!

Take the focus from the given token. If the token matched the one of the current focus, the ownership is transmitted to the taker. Any user having the FocusOwner would be released. Otherwise, it behaves like takeFocus.

abstract fun take(token: String!): FocusOwner!