Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventMetadata

Time series event metadata.

Hierarchy

Implemented by

Index

Properties

Methods

Properties

author

author: string

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

If the session that created the event was not authenticated, the author will be an empty string.

sequence

sequence: number

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 is equal to the sequence number of the preceding event plus one.

timestamp

timestamp: number

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.

Timestamps represent the difference, measured in milliseconds, between the time the server added the event to the time series and midnight, January 1, 1970 UTC

Methods

equals

  • equals(other: any): boolean
  • Check if the EventMetadata is equal to another object

    Parameters

    • other: any

    Returns boolean

    true if the two objects are equal