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
PTDiffusionTimeSeriesEventMetadata Class Reference

Introduction

Metadata associated with a time series event.

See Also
PTDiffusionTimeSeriesEvent
Since
6.0
Inheritance diagram for PTDiffusionTimeSeriesEventMetadata:
PTDiffusionTimeSeriesEvent PTDiffusionBinaryTimeSeriesEvent PTDiffusionJSONTimeSeriesEvent PTDiffusionNumberTimeSeriesEvent PTDiffusionRecordV2TimeSeriesEvent PTDiffusionStringTimeSeriesEvent

Class Methods

(instancetype) + NS_UNAVAILABLE
 

Properties

UInt64 sequence
 
SInt64 timestamp
 
NSString * author
 

Instance Methods

(instancetype) - NS_UNAVAILABLE
 
(BOOL) - isEqualToTimeSeriesEventMetadata:
 

Method Documentation

- (BOOL) isEqualToTimeSeriesEventMetadata: (nullable PTDiffusionTimeSeriesEventMetadata *)  timeSeriesEventMetadata

Compares the receiver to the given time series event metadata.

Parameters
timeSeriesEventMetadataThe time series event metadata object with which to compare the receiver.
Returns
YES if it matches the receiver for just metadata elements (sequence, timestamp and author), otherwise NO.
Since
6.0

Property Documentation

- (NSString*) author
readnonatomicassign

Server-authenticated identity of the session that created the event.

Returns
The principal that created the event, or [PTDiffusionSession anonymousPrincipal] if the session that created the event was not authenticated
Since
6.0
- (UInt64) sequence
readnonatomicassign

Sequence number identifying this event within its time series. Assigned by the server when the event is created.

Sequence numbers are unique within a time series. Each event appended to a time series is assigned a sequence number that is equal to the sequence number of the preceding event plus one.

Returns
The sequence number; never higher than INT64_MAX.
Since
6.0
- (SInt64) timestamp
readnonatomicassign

Event timestamp. Assigned by the server when the event is created.

Events do not have unique timestamps. Events with different sequence numbers may have the same timestamp.

Subsequent events in a time series usually have timestamps that are greater or equal to the timestamps of earlier events, but this is not guaranteed due to changes to the time source used by the server.

Returns
The difference, measured in milliseconds, between the time the server added the event to the time series and midnight, January 1, 1970 UTC.
Since
6.0