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

Introduction

Extension adding support to the Time Series feature for appending and editing events using record values.

Since
6.0

Instance Methods

(void) - appendToTopicPath:recordValue:completionHandler:
 
(void) - editAtTopicPath:originalSequence:recordValue:completionHandler:
 
(void) - evaluateQuery:atTopicPath:recordCompletionHandler:
 

Method Documentation

- (void) appendToTopicPath: (NSString *)  topicPath
recordValue: (PTDiffusionRecordV2 *)  value
completionHandler: (PTDiffusionTimeSeriesEventMetadata *_Nullable)  eventMetadata
(NSError *_Nullable error)  completionHandler 

Update a time series topic by appending a new record value.

The server will add an event to the end of the time series based on the supplied value, with a new sequence number, timestamp, and the author set to the authenticated principal of the session.

Parameters
topicPathThe path of the time series topic to update.
valueThe event value.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any supplied arguments are nil.
Since
6.0
- (void) editAtTopicPath: (NSString *)  topicPath
originalSequence: (UInt64)  originalSequence
recordValue: (PTDiffusionRecordV2 *)  value
completionHandler: (PTDiffusionTimeSeriesEventMetadata *_Nullable)  eventMetadata
(NSError *_Nullable error)  completionHandler 

Update a time series topic by appending a new record value that overrides the value of an existing event.

The existing event is identified by its sequence number and must be an original event.

The server will add an edit event to the end of the time series based on the supplied value, with a new sequence number, timestamp, and the author set to the authenticated principal of the session.

Parameters
topicPathThe path of the time series topic to update.
originalSequenceThe sequence number of the original event to edit.
valueThe event value.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any of the topicPath, value or completionHandler arguments are nil. Also raised if the originalSequence argument exceeds INT64_MAX.
Since
6.0
- (void) evaluateQuery: (PTDiffusionTimeSeriesRangeQuery *)  query
atTopicPath: (NSString *)  topicPath
recordCompletionHandler: (PTDiffusionRecordV2TimeSeriesQueryResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler 

Evaluate a query for a time series topic where events have record values.

Parameters
queryThe configured query.
topicPathThe path of the time series topic to query.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if any supplied arguments are nil.
Since
6.0