SnapshotMessage

Snapshot message.

Methods

  • delete

    • delete(): void

      Delete the snapshot message to free resources when it is no longer needed.

      Returns void

  • isDeleted

    • isDeleted(): boolean

      Has the message been deleted?

      Returns boolean

Properties

  • readonly dataSourceId: DataSourceId

    The data source of this message

  • readonly symbologyId: SymbologyId

    The symbology of symbol

  • readonly symbol: string

    The symbol

  • readonly permissionId?: PermissionId

    The permission id, only present if received through a onSnapshot callback or the SnapshotResult that contains this message has a status code of success.

  • readonly updateId?: number

    The update id, only present if received through a onSnapshot callback or the SnapshotResult that contains this message has a status code of success.

  • readonly fieldData?: FieldData

    The field data of this message, only present if received through a onSnapshot callback or the SnapshotResult that contains this message has a status code of success.

Also in this Section