simple_query
library
Classes
BatchRequest
A group of MutationRequest s to execute together as a single batch.
BatchResult
The combined outcome of a BatchRequest , with one result per operation.
BinaryContent
A safely-closeable handle to an open binary resource (e.g. a photo or
file body opened via SimpleQuery.openBinaryContent ).
BinaryContentHandle
A handle to an open binary resource, providing its local path and metadata.
Close it with SimpleQuery.closeBinary when finished.
BinaryRequest
A request to open binary content (e.g. a photo or file) for streaming.
CalendarEventRecord
Typed view over a QueryRecord from the QueryDomain.calendar domain.
CallRecord
Typed view over a QueryRecord from the QueryDomain.calls domain.
CapabilityContracts
Enforces that every QueryDomain is represented exactly once in a
CapabilitySnapshot . A platform that omits a domain — or reports it
twice — is a contract bug, and RuntimeContractValidation raises
SimpleQueryError(unavailable, details: {missingDomains: [...]}).
CapabilityDescriptor
Describes what operations (read, write, observe, stream) are supported
for a single QueryDomain on the current platform.
CapabilitySnapshot
A point-in-time summary of all capabilities available on this device.
ContactRecord
Typed view over a QueryRecord from the QueryDomain.contacts domain.
FileRecord
Typed view over a QueryRecord from the QueryDomain.files domain.
MediaRecord
Typed view over a QueryRecord from the QueryDomain.media domain.
MessageRecord
Typed view over a QueryRecord from the QueryDomain.messages domain.
MutationRequest
A request to insert, update, or delete data in a specific domain .
MutationResult
The outcome of a mutation, including how many records were affected.
ObserveEvent
A notification that data in a watched domain has changed.
ObserveRequest
A request to watch a domain for changes and receive ObserveEvent s.
QueryBuilder
A fluent builder for constructing and executing a QueryRequest .
QueryDomainContracts
Declares the canonical required + optional record keys for each
QueryDomain .
QueryFieldCatalog
The canonical field vocabulary each QueryDomain accepts for filters,
sort, projection, and mutation values.
QueryFilterCondition
A single filter rule that narrows which records a query returns.
QueryPage
Pagination settings that control which slice of results to return.
QueryRequest
A request to read data from a specific domain with optional filters,
sorting, projection, and pagination.
QueryResult
The response from a query, containing matched records and pagination info.
QuerySort
A sorting rule that controls the order of query results.
RuntimeContractValidation
Enforces the documented contracts of request/response models at runtime.
SimpleQuery
The main entry point for querying and modifying device data.
Exceptions / Errors
SimpleQueryError
An error thrown when a simple_query operation fails.
