client library

Classes

Client: A client which connects to a Spine-based backend, posts commands, sends queries, and creates and managed subscriptions on behalf of a certain user.
Clients: A factory of Clients.
CommandRequest<M extends GeneratedMessage>: A request to the server to post a command.
Composite: A composite field filter.
Endpoints: URL paths to which the client should send requests.
EventSubscriptionRequest<M extends GeneratedMessage>: A request to subscribe to events.
FilterOrComposite: A simple or a composite field filter.
QueryRequest<M extends GeneratedMessage>: A request to query the server for data.
SimpleFilter: A simple field filter.
StateSubscriptionRequest<M extends GeneratedMessage>: A request to subscribe to entity state updates.
SubscriptionEndpoints: URL paths to which the client should send requests regarding entity and event subscriptions.

all(Iterable<SimpleFilter> filters) → Composite: Creates a composite filter which groups one or more field filters with the ALL operator.
either(Iterable<SimpleFilter> filters) → Composite: Creates a composite filter which groups one or more field filters with the EITHER operator.
eq(String fieldPath, Object value) → SimpleFilter: Creates a field filter with the = operator.
ge(String fieldPath, Object value) → SimpleFilter: Creates a field filter with the >= operator.
gt(String fieldPath, Object value) → SimpleFilter: Creates a field filter with the > operator.
le(String fieldPath, Object value) → SimpleFilter: Creates a field filter with the <= operator.
lt(String fieldPath, Object value) → SimpleFilter: Creates a field filter with the < operator.

CommandErrorCallback = void Function(Error error): A callback which notifies the user about an error when posting a command.
UrlPath = String: A part of URL path, specifying a destination of client requests of some type.