Class PublishingIotAgent

Namespace

Kepware.Api.Model

Assembly

Kepware.Api.dll

Base class for IoT Gateway agent types that support publishing (MQTT Client and REST Client). Contains publish configuration and message template properties not applicable to REST Server agents.

public class PublishingIotAgent : IotAgent, IEquatable<BaseEntity>, IHaveOwner, IHaveName

Inheritance

object

BaseEntity

DefaultEntity

NamedEntity

IotAgent

PublishingIotAgent

Implements

IEquatable<BaseEntity>

IHaveOwner

IHaveName

Derived

MqttClientAgent

RestClientAgent

Inherited Members

IotAgent.IotItems

IotAgent.AgentType

IotAgent.Enabled

IotAgent.IgnoreQualityChanges

IotAgent.ThisAgentTotal

IotAgent.AllAgentsTotal

IotAgent.LicenseLimit

IotAgent.Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

NamedEntity.Name

NamedEntity.AppendHashSources(CustomHashGenerator.HashSourceBuilder)

NamedEntity.GetUpdateDiff(NamedEntity, bool)

DefaultEntity.Owner

BaseEntity.IncludesNestedDynamicProperties

BaseEntity.Hash

BaseEntity.ProjectId

BaseEntity.Description

BaseEntity.TypeName

BaseEntity.DynamicProperties

BaseEntity.Equals(BaseEntity)

BaseEntity.GetDynamicProperty<T>(string)

BaseEntity.SetDynamicProperty<T>(string, T)

BaseEntity.TryGetDynamicProperty<T>(string, out T)

BaseEntity.CalculateHash()

BaseEntity.EnsureDynamicPropertiesNormalized()

BaseEntity.NormalizeNestedProperties()

BaseEntity.ConditionalNonSerialized()

BaseEntity.GetUpdateDiff(DefaultEntity)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

HelperExtentions.Flatten(NamedEntity?)

HelperExtentions.Flatten(NamedEntity?, Type)

Constructors

PublishingIotAgent()

Initializes a new instance of the PublishingIotAgent class.

PublishingIotAgent(string)

Initializes a new instance of the PublishingIotAgent class with the specified name.

Properties

AdvancedTemplate

Gets or sets the advanced template for message formatting.

ExpansionOfValues

Gets or sets the expansion of |VALUES| in the standard template.

MaxEventsPerPublish

Gets or sets the maximum number of tag events per publish in narrow format.

MessageFormat

Gets or sets the message format (Standard or Advanced Template).

PublishFormat

Gets or sets the publish format (Wide or Narrow).

PublishType

Gets or sets the publish type (Interval or On Data Change).

RateMs

Gets or sets the publish rate in milliseconds.

SendInitialUpdate

Gets or sets whether the initial update should be sent when the agent starts.

StandardTemplate

Gets or sets the standard template for message formatting.

TransactionTimeoutS

Gets or sets the transaction timeout in seconds.