Session \(Python\)
June 4, 2021 ยท View on GitHub
This page describes the Python Session API.
RPC reference
This section describes the existing RPCs used in this API.
Service to manage user sessions
SessionClient RPCs
| Function name | Return type | Input type | Description |
|---|---|---|---|
| CreateSession | Empty | CreateSessionInfo | Creates a new session on the robot using given values for user name, session timeout value, and password |
| CloseSession | Empty | Empty | Closes an existing open session |
| KeepAlive | Empty | Empty | Sends message to robot to keep current session alive |
| GetConnections | ConnectionList | Empty | Retrieves the list of connections |
Class reference
This section describes the data classes used in this API.
Messages
| Class | Description |
|---|---|
| ConnectionList | Array of connections |
| CreateSessionInfo | Parameters needed to create a new session |
Enumerators
| Enumerator | Description |
|---|---|
| ServiceVersion | Identifies session service current version |