Class: QueryingClient

(abstract) QueryingClient(actorRequestFactorynon-null)

A client which performs entity state queries.

Constructor

(abstract) new QueryingClient(actorRequestFactorynon-null)

Parameters:
Name Type Description
actorRequestFactory ActorRequestFactory a request factory to build requests to Spine server
Source:

Classes

QueryingClient

Methods

newQuery() → {QueryFactory}

Creates a new query factory instance which can be further used for the `Query` creation.
Source:
Returns:
Type
QueryFactory

read(querynon-null) → {Promise.<Array.<Message>>}

Executes the given `Query` instance specifying the data to be retrieved from Spine server fulfilling a returned promise with an array of received objects.
Parameters:
Name Type Description
query spine.client.Query a query instance to be executed
Source:
Returns:
a promise to be fulfilled with a list of Protobuf messages of a given type or with an empty list if no entities matching given query were found; rejected with a `SpineError` if error occurs
Type
Promise.<Array.<Message>>

select(entityTypenon-null, clientnon-null) → {QueryRequest}

Creates a new query request.
Parameters:
Name Type Description
entityType Class.<Message> the target entity type
client Client the client which initiated the request
Source:
Returns:
a new query request
Type
QueryRequest