Extends
- BaseClient
Members
Methods
# list_world_objects(object_typenullable, time_start_pointnullable, argsopt) → {Promise.<world_object_pb.ListWorldObjectResponse>}
Get a list of World Objects.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
object_type |
Array.<world_object_pb.WorldObjectType>
|
<nullable> |
null | Specific types to include in the response, all other types will be filtered out. |
time_start_point |
number
|
<nullable> |
null | A client timestamp to filter objects in the response. All objects will have a timestamp after this time. |
args |
Object
|
<optional> |
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
Couldn't convert the timestamp into robot time.
NoTimeSyncError
The response message,
which includes the filtered list of all world objects.
Promise.<world_object_pb.ListWorldObjectResponse>
# mutate_world_objects(mutation_req, argsopt) → {Promise.<world_object_pb.MutateWorldObjectResponse>|Promise.<void>}
Mutate (add, change, delete) world objects.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
mutation_req |
world_object_pb.MutateWorldObjectRequest
|
The request including the object to be mutated and the type of mutation. | |
args |
Object
|
<optional> |
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
Couldn't convert the timestamp into robot time.
NoTimeSyncError
The response message,
which includes the filtered list of all world objects.
Promise.<world_object_pb.MutateWorldObjectResponse>
|
Promise.<void>
# async update_from(other) → {void}
Update instance from another object.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
Object
|
The object where to copy from. |
void