Diffusion Apple API  6.2.0
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Functions Variables Properties Pages
Class Methods | Properties | Instance Methods | List of all members
PTDiffusionTimeSeriesQueryResult Class Reference

Introduction

Query result providing an array of time series events.

Since
6.0
Inheritance diagram for PTDiffusionTimeSeriesQueryResult:
PTDiffusionBinaryTimeSeriesQueryResult PTDiffusionJSONTimeSeriesQueryResult PTDiffusionNumberTimeSeriesQueryResult PTDiffusionRecordV2TimeSeriesQueryResult PTDiffusionStringTimeSeriesQueryResult

Class Methods

(instancetype) + NS_UNAVAILABLE
 

Properties

BOOL complete
 
UInt64 selectedCount
 
PTDiffusionTimeSeriesQueryResultEventArrayStructureeventArrayStructure
 

Instance Methods

(instancetype) - NS_UNAVAILABLE
 
(BOOL) - isEqualToTimeSeriesQueryResult:
 

Method Documentation

- (BOOL) isEqualToTimeSeriesQueryResult: (nullable PTDiffusionTimeSeriesQueryResult *)  timeSeriesQueryResult

Compares the receiver to the given time series query result.

Parameters
timeSeriesQueryResultThe time series query result object with which to compare the receiver.
Returns
YES if it is identical to the receiver, otherwise NO.
Since
6.0

Property Documentation

- (BOOL) complete
readnonatomicassign

If this result includes all events selected by the query then YES.

When this property returns YES then the value returned by the selectedCount property will be the same as the count of the array returned by the events property.

Since
6.0
- (PTDiffusionTimeSeriesQueryResultEventArrayStructure*) eventArrayStructure
readnonatomicassign

The structural properties of the events array.

See Also
events
Since
6.0
- (UInt64) selectedCount
readnonatomicassign

The number of events selected by the query.

This number may be greater than the count of the array returned by the events property due to a policy of the time series topic to limit the number of returned results, or the use a limit on the range query.

Since
6.0