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(PTDiffusionPrimitive) Category Reference

Introduction

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

Since
6.0

Instance Methods

(void) - appendToTopicPath:stringValue:completionHandler:
 
(void) - appendToTopicPath:doubleFloatNumberValue:completionHandler:
 
(void) - appendToTopicPath:int64NumberValue:completionHandler:
 
(void) - editAtTopicPath:originalSequence:stringValue:completionHandler:
 
(void) - editAtTopicPath:originalSequence:doubleFloatNumberValue:completionHandler:
 
(void) - editAtTopicPath:originalSequence:int64NumberValue:completionHandler:
 
(void) - evaluateQuery:atTopicPath:stringCompletionHandler:
 
(void) - evaluateQuery:atTopicPath:doubleFloatNumberCompletionHandler:
 
(void) - evaluateQuery:atTopicPath:int64NumberCompletionHandler:
 

Method Documentation

- (void) appendToTopicPath: (NSString *)  topicPath
doubleFloatNumberValue: (nullable NSNumber *)  value
completionHandler: (PTDiffusionTimeSeriesEventMetadata *_Nullable)  eventMetadata
(NSError *_Nullable error)  completionHandler 

Update a time series topic by appending a new double-precision floating point (Eight-byte IEEE 754) 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) appendToTopicPath: (NSString *)  topicPath
int64NumberValue: (nullable NSNumber *)  value
completionHandler: (PTDiffusionTimeSeriesEventMetadata *_Nullable)  eventMetadata
(NSError *_Nullable error)  completionHandler 

Update a time series topic by appending a new 64-bit integer 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) appendToTopicPath: (NSString *)  topicPath
stringValue: (nullable NSString *)  value
completionHandler: (PTDiffusionTimeSeriesEventMetadata *_Nullable)  eventMetadata
(NSError *_Nullable error)  completionHandler 

Update a time series topic by appending a new string 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
doubleFloatNumberValue: (nullable NSNumber *)  value
completionHandler: (PTDiffusionTimeSeriesEventMetadata *_Nullable)  eventMetadata
(NSError *_Nullable error)  completionHandler 

Update a time series topic by appending a new double-precision floating point (Eight-byte IEEE 754) 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) editAtTopicPath: (NSString *)  topicPath
originalSequence: (UInt64)  originalSequence
int64NumberValue: (nullable NSNumber *)  value
completionHandler: (PTDiffusionTimeSeriesEventMetadata *_Nullable)  eventMetadata
(NSError *_Nullable error)  completionHandler 

Update a time series topic by appending a new 64-bit integer 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) editAtTopicPath: (NSString *)  topicPath
originalSequence: (UInt64)  originalSequence
stringValue: (nullable NSString *)  value
completionHandler: (PTDiffusionTimeSeriesEventMetadata *_Nullable)  eventMetadata
(NSError *_Nullable error)  completionHandler 

Update a time series topic by appending a new string 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
doubleFloatNumberCompletionHandler: (PTDiffusionNumberTimeSeriesQueryResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler 

Evaluate a query for a time series topic where events have double-precision floating point (Eight-byte IEEE 754) 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
- (void) evaluateQuery: (PTDiffusionTimeSeriesRangeQuery *)  query
atTopicPath: (NSString *)  topicPath
int64NumberCompletionHandler: (PTDiffusionNumberTimeSeriesQueryResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler 

Evaluate a query for a time series topic where events have 64-bit integer 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
- (void) evaluateQuery: (PTDiffusionTimeSeriesRangeQuery *)  query
atTopicPath: (NSString *)  topicPath
stringCompletionHandler: (PTDiffusionStringTimeSeriesQueryResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler 

Evaluate a query for a time series topic where events have string 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