SubscriptionMessage

Methods

• delete

  • delete(): void

    Delete the subscription message to free resources when it is no longer needed. This is done automatically by iterating to the next result in the stream.

    Returns void

• isDeleted

  • isDeleted(): boolean

    Has the message been deleted?

    Returns boolean

Properties

• readonly isRefresh: boolean

  Is the message a refresh?

• readonly dataSourceId: DataSourceId

  The data source of this message

• readonly symbologyId: SymbologyId

  The symbology of symbol

• readonly symbol: string

  The symbol

• readonly topicType: TopicType

  The type of the topic subscribed to

• readonly permissionId: PermissionId

  The permission id

• readonly updateId: number

  The update id

• readonly eventType?: EventType

  The type of event if this message is an update, otherwise undefined.

• readonly updateType?: UpdateType

  The type of update if this message is an update to a map topic, otherwise undefined.

• readonly mapKey?: string

  The map key if this is an update to a specific map topic, otherwise undefined

• readonly topicSubscriptionState: TopicSubscriptionState

  The topic subscription state

• readonly fieldData: FieldData

  The field data of this message