Class IotAgent

Namespace

Kepware.Api.Model

Assembly

Kepware.Api.dll

Base class for all IoT Gateway agent types. Contains the universal properties shared by MQTT Client, REST Client, and REST Server agents.

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

Inheritance

object

BaseEntity

DefaultEntity

NamedEntity

IotAgent

Implements

IEquatable<BaseEntity>

IHaveOwner

IHaveName

Derived

PublishingIotAgent

RestServerAgent

Inherited Members

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

IotAgent()

Initializes a new instance of the IotAgent class.

IotAgent(string)

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

Properties

AgentType

Gets the agent type identifier (read-only).

AllAgentsTotal

Gets the total number of tags configured under all agents (read-only).

Enabled

Gets or sets whether the agent is enabled.

IgnoreQualityChanges

Gets or sets whether quality changes should be ignored.

IotItems

Gets or sets the IoT Items in this agent.

LicenseLimit

Gets the license limit for configured tags (read-only).

ThisAgentTotal

Gets the total number of tags configured under this agent (read-only).

Methods

Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

Recursively cleans up the agent and all IoT Items.