Class

DataServiceClient

DataServiceClient()

Constructor

# new DataServiceClient()

Client for adding to robot data buffer.

View Source bosdyn-client/data_service.js, line 14

Extends

  • BaseClient

Methods

# delete_data_pages(time_rangenullable, page_idsnon-null, argsopt) → {Promise.<data_index_protos.DeleteDataPagesResponse>}

Parameters:
Name Type Attributes Description
time_range data_index_protos.TimeRange <nullable>
The time range to send.
page_ids Array.<string> List of page's ids.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 77

Promise.<data_index_protos.DeleteDataPagesResponse>

# get_data_buffer_status(get_blob_specsopt, argsopt) → {Promise.<data_index_protos.GetDataBufferStatusResponse>}

Query for operator comments and events.
Parameters:
Name Type Attributes Default Description
get_blob_specs boolean <optional>
false whether to list message series.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 101

Problem communicating with the robot.
RpcError
Promise.<data_index_protos.GetDataBufferStatusResponse>

# get_data_index(query, argsopt) → {Promise.<data_index_protos.GetDataIndexResponse>}

Query for data index
Parameters:
Name Type Attributes Description
query data_index_protos.DataQuery The data to query.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 54

Problem communicating with the robot.
RpcError
Promise.<data_index_protos.GetDataIndexResponse>

# get_data_pages(time_range, argsopt) → {Promise.<data_index_protos.GetDataPagesResponse>}

Internal get_data_index RPC stub call.
Parameters:
Name Type Attributes Description
time_range data_index_protos.TimeRange The time range to send.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 66

Problem communicating with the robot.
RpcError
Promise.<data_index_protos.GetDataPagesResponse>

# get_events_comments(querynullable, argsopt) → {Promise.<data_index_protos.GetEventsCommentsResponse>}

Query for operator comments and events
Parameters:
Name Type Attributes Description
query data_index_protos.EventsCommentsSpec <nullable>
The events comments to send.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 89

Problem communicating with the robot.
RpcError
Promise.<data_index_protos.GetEventsCommentsResponse>

# async update_from(other) → {Promise.<void>}

Update instance from another object.
Parameters:
Name Type Description
other Object The object where to copy from.

View Source bosdyn-client/data_service.js, line 38

Promise.<void>

DataServiceClient(namenullable)

Constructor

# new DataServiceClient(namenullable)

Create an instance of DataServiceClient's class.
Parameters:
Name Type Attributes Default Description
name string <nullable>
null Class name.

View Source bosdyn-client/data_service.js, line 27

Methods

# delete_data_pages(time_rangenullable, page_idsnon-null, argsopt) → {Promise.<data_index_protos.DeleteDataPagesResponse>}

Parameters:
Name Type Attributes Description
time_range data_index_protos.TimeRange <nullable>
The time range to send.
page_ids Array.<string> List of page's ids.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 77

Promise.<data_index_protos.DeleteDataPagesResponse>

# get_data_buffer_status(get_blob_specsopt, argsopt) → {Promise.<data_index_protos.GetDataBufferStatusResponse>}

Query for operator comments and events.
Parameters:
Name Type Attributes Default Description
get_blob_specs boolean <optional>
false whether to list message series.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 101

Problem communicating with the robot.
RpcError
Promise.<data_index_protos.GetDataBufferStatusResponse>

# get_data_index(query, argsopt) → {Promise.<data_index_protos.GetDataIndexResponse>}

Query for data index
Parameters:
Name Type Attributes Description
query data_index_protos.DataQuery The data to query.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 54

Problem communicating with the robot.
RpcError
Promise.<data_index_protos.GetDataIndexResponse>

# get_data_pages(time_range, argsopt) → {Promise.<data_index_protos.GetDataPagesResponse>}

Internal get_data_index RPC stub call.
Parameters:
Name Type Attributes Description
time_range data_index_protos.TimeRange The time range to send.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 66

Problem communicating with the robot.
RpcError
Promise.<data_index_protos.GetDataPagesResponse>

# get_events_comments(querynullable, argsopt) → {Promise.<data_index_protos.GetEventsCommentsResponse>}

Query for operator comments and events
Parameters:
Name Type Attributes Description
query data_index_protos.EventsCommentsSpec <nullable>
The events comments to send.
args Object <optional>
Extra arguments for controlling RPC details.

View Source bosdyn-client/data_service.js, line 89

Problem communicating with the robot.
RpcError
Promise.<data_index_protos.GetEventsCommentsResponse>

# async update_from(other) → {Promise.<void>}

Update instance from another object.
Parameters:
Name Type Description
other Object The object where to copy from.

View Source bosdyn-client/data_service.js, line 38

Promise.<void>