NAOqi Core - Overview | API
Getting Started 1 - Activity Developer | Getting Started 2 - User Data Provider Developer
Namespace : AL
#include <alproxies/alusersessionproxy.h>
As any module, this module inherits methods from ALModule API. It also has the following specific methods:
Checks if UserSession IDs exist in database.
Parameters: |
|
---|---|
Returns: | true if all users exist, else false. |
Gets all UserSession IDs in the database.
Returns: | a list of the integer UserSession IDs. |
---|
Gets the number of users in the database.
Returns: | the number of users. |
---|
Gets which user has the robot focus.
Returns: | The UserSession ID of the focused user if there is one, or -1 if no user is focused. |
---|
Gets which users have an open session.
Returns: | the UserSession IDs of the users with an open session. |
---|
Checks if UserSession IDs have an open session.
Parameters: |
|
---|---|
Returns: | true if all users have open sessions, else false. |
Gets the list of binding sources that have been applied to UserSession.
Returns: | the names of the binding sources. |
---|
Queries if a particular binding source has been applied to UserSession.
Parameters: |
|
---|---|
Returns: | true if a binding source exists, else false. |
Gets the sources a UserSession ID is bound to.
Parameters: |
|
---|---|
Returns: | A map of binding sources names and their bound ID. |
Gets the a specific source a UserSession ID is bound to.
Parameters: |
|
---|---|
Returns: | Bound ID for the specified user ID and binding source. |
Gets the sources a User Session ID is bound to.
Parameters: |
|
---|---|
Returns: | The int UserSession IDs of the users with the passed bindingValue. |
Checks if a data source has been registered.
Parameters: |
|
---|---|
Returns: | True if the source has been registered, else false. |
Gets all registered data sources.
Returns: | Names of the registered data sources. |
---|
Gets a specific data about a UserSession ID, for a specific source. Will throw if the specified data type does not exist.
Parameters: |
|
---|---|
Returns: | User data for the specified data and source names. |
Gets a specific data about a user, for all sources. Will throw if the specified data type does not exist.
Parameters: |
|
---|---|
Returns: | A map which is keyed by the data source name, with the value as the user data. |
Parameters: |
|
---|
This event is raised when Users are created in the UserSession database. This could be raised if Autonomous Life thinks the robot just met someone it hasn’t seen before.
Parameters: |
|
---|
This event is raised when Users are deleted from the UserSession database. This could be raised if Autonomous Life is pruning users.
Parameters: |
|
---|
This event is raised when user sessions are opened. It is possible to open multiple sessions simultaneously.
Sessions are opened when a UserSession ID is tracked by Basic Awareness.
Parameters: |
|
---|
This event is raised when user sessions are closed. It is possible to close multiple sessions simultaneously.
A session is closed when the corresponding person is no longer perceived by people perception.
Parameters: |
|
---|
This event is raised when the number of open user sessions transitions from zero to any or any to zero.
Parameters: |
|
---|
This event is raised when the focused user changes.
Parameters: |
|
---|
This event is raised when ALAutonomousLife thinks that there is nobody to interact with, and recommends that the current Interactive Activity exits.
A list of the UserSession IDs of all currently open user sessions.