Search class

Search is performed from a start point on the time line, towards an end point. If the end point is prior to the start point, search will be performed backwards. This can be useful if only the newest matching event is of interest, or if it is otherwise convenient to get the results in newest to oldest order.

Default Access Policy Definition | | Administrator | Operator | User | Anonymous | | PRE_AUTH | X | X | X | X | | READ_SYSTEM | X | X | X | | | READ_SYSTEM_SENSITIVE | X | X | | | | READ_SYSTEM_SECRET | X | | | | | WRITE_SYSTEM | X | | | | | UNRECOVERABLE | X | | | | | READ_MEDIA | X | X | X | | | ACTUATE | X | X | | |

Constructors

Search({required Transport transport, required Uri uri})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

loggy → Loggy<UiLoggy>

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transport → Transport

final, inherited

uri → Uri

final, inherited

Methods

findRecordings({SearchScope? searchScope, int? maxMatches, required int keepAliveTime}) → Future<String>

FindRecordings starts a search session, looking for recordings that matches the scope (See 20.2.4) defined in the request. Results from the search are acquired using the GetRecordingSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs:

getRecordingInformation(String recordingToken) → Future<RecordingInformation>

Returns information about a single Recording specified by a RecordingToken. This operation is mandatory to support for a device implementing the recording search service.

getRecordingSearchResults(String searchToken, {int? minResults, int? maxResults, String? waitTime}) → Future<List<FindRecordingResult>>

GetRecordingSearchResults acquires the results from a recording search session previously initiated by a FindRecordings operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. The number of results relates to the number of recordings. For viewing individual recorded data for a signal track use the FindEvents method.

getRecordingSummary() → Future<RecordingSummary>

GetRecordingSummary is used to get a summary description of all recorded data. This operation is mandatory to support for a device implementing the recording search service.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited