Class Project

Namespace

Kepware.Api.Model

Assembly

Kepware.Api.dll

Represents a project in the Kepware configuration. It provides the project properties for the client interfaces that Kepware supports.

[Endpoint("/config/v1/project", null)]
[JsonConverter(typeof(ProjectPropertiesJsonConverter))]
public class Project : DefaultEntity, IEquatable<BaseEntity>, IHaveOwner

Inheritance

object

BaseEntity

DefaultEntity

Project

Implements

IEquatable<BaseEntity>

IHaveOwner

Inherited Members

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.AppendHashSources(CustomHashGenerator.HashSourceBuilder)

BaseEntity.ConditionalNonSerialized()

BaseEntity.GetUpdateDiff(DefaultEntity)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Project()

Initializes a new instance of the Project class.

Properties

Channels

Gets or sets the channels in the project

IotGateway

Gets or sets the IoT Gateway container holding MQTT Client, REST Client, and REST Server agent collections.

IsEmpty

If this is true, it indicates that this is an empty project object that was instantiated without data from the server.

IsLoadedByProjectLoadService

If this is true the project was loaded by the JsonProjectLoad service (added to Kepware Server v6.17 / Kepware Edge v1.10)

ProjectProperties

Gets the project properties in the project

Methods

Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

Recursively cleans up the project and all its children

CloneAsync(CancellationToken)

NormalizeNestedProperties()

Normalizes nested properties by flattening the client_interfaces array from the Kepware API.