TimelineEntry

@objc
public class TimelineEntry : NSObject, UniquelyIdentifiable

Timeline Entries encapsulate all the lightweight representations of properties related to an action event to be stored in a timeline without any references to the original data. This is to prevent memory usage spiralling out of control while the app is running.

!!! TODO: Remove @objc and change entry to struct when Swift bug SR-6039/SR-55 is fixed.

See

https://bugs.swift.org/browse/SR-55

  • The kind of event. We can record both the start and completion of actions

    See more

    Declaration

    Swift

    public enum Kind
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public let kind: Kind
    Show on GitHub

  • An incrementing ID for entries. Supports overflow, so it only unique when combined with the current date/time

    Declaration

    Swift

    public let sequenceID: UInt
    Show on GitHub

  • A unique ID for the entry

    Declaration

    Swift

    public var uniqueID: String { get }
    Show on GitHub

  • Indicates whether or not the action was performed directly by a user, or automatically by code

    Declaration

    Swift

    public let userInitiated: Bool
    Show on GitHub

  • An indication of the source of the action. User initiated actions can come from multiple sources e.g. UI interactions or asking the system to open a URL

    Declaration

    Swift

    public let source: ActionSource
    Show on GitHub

  • The date/time the event occurred

    Declaration

    Swift

    public let date: Date
    Show on GitHub

  • The feature in which the action was invoked

    Declaration

    Swift

    public let feature: FeatureDefinition.Type
    Show on GitHub

  • The session name in which the action was performed

    Declaration

    Swift

    public let sessionName: String
    Show on GitHub

  • The name of the action

    Declaration

    Swift

    public let actionName: String
    Show on GitHub

  • The human-friendly description of the input to the action

    Declaration

    Swift

    public let inputDescription: String?
    Show on GitHub

  • The detailed debug description of the input to the action

    Declaration

    Swift

    public let inputInfo: [String : Any]?
    Show on GitHub

  • The outcome of the action. This is nil unless kind is .complete.

    Declaration

    Swift

    public let outcome: ActionOutcome?
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public override var description: String { get }
    Show on GitHub