Class IotGatewayApiHandler
- Namespace
- Kepware.Api.ClientHandler
- Assembly
- Kepware.Api.dll
Handles operations related to IoT Gateway agent configurations in the Kepware server. Supports MQTT Client, REST Client, and REST Server agent types and their child IoT Items.
public class IotGatewayApiHandler- Inheritance
-
IotGatewayApiHandler
- Inherited Members
Constructors
- IotGatewayApiHandler(KepwareApiClient, ILogger<IotGatewayApiHandler>)
Initializes a new instance of the IotGatewayApiHandler class.
Methods
- CreateIotItemAsync(string, IotAgent, IDictionary<string, object>?, CancellationToken)
Creates a new IoT Item for the specified server tag under the given parent agent. The IoT Item name is derived from the server tag by replacing dots with underscores and stripping any leading underscore.
- CreateMqttClientAgentAsync(string, IDictionary<string, object>?, CancellationToken)
Creates a new MQTT Client agent with the specified name.
- CreateRestClientAgentAsync(string, IDictionary<string, object>?, CancellationToken)
Creates a new REST Client agent with the specified name.
- CreateRestServerAgentAsync(string, IDictionary<string, object>?, CancellationToken)
Creates a new REST Server agent with the specified name.
- DeleteIotItemAsync(IotItem, CancellationToken)
Deletes the specified IoT Item.
- DeleteIotItemAsync(string, IotAgent, CancellationToken)
Deletes the IoT Item identified by the specified server tag under the given parent agent. The server tag is converted to the IoT Item name by replacing dots with underscores and stripping any leading underscore.
- DeleteMqttClientAgentAsync(MqttClientAgent, CancellationToken)
Deletes the specified MQTT Client agent.
- DeleteMqttClientAgentAsync(string, CancellationToken)
Deletes the MQTT Client agent with the specified name.
- DeleteRestClientAgentAsync(RestClientAgent, CancellationToken)
Deletes the specified REST Client agent.
- DeleteRestClientAgentAsync(string, CancellationToken)
Deletes the REST Client agent with the specified name.
- DeleteRestServerAgentAsync(RestServerAgent, CancellationToken)
Deletes the specified REST Server agent.
- DeleteRestServerAgentAsync(string, CancellationToken)
Deletes the REST Server agent with the specified name.
- GetIotItemAsync(string, IotAgent, CancellationToken)
Gets an IoT Item by its server tag name under the given parent agent. The server tag is converted to the IoT Item name by replacing dots with underscores and stripping any leading underscore.
- GetMqttClientAgentAsync(string, CancellationToken)
Gets an MQTT Client agent with the specified name.
- GetOrCreateIotItemAsync(string, IotAgent, IDictionary<string, object>?, CancellationToken)
Gets or creates an IoT Item for the specified server tag under the given parent agent. If the item exists, it is loaded and returned. If it does not exist, it is created with the specified properties. The IoT Item name is derived from the server tag by replacing dots with underscores and stripping any leading underscore.
- GetOrCreateMqttClientAgentAsync(string, IDictionary<string, object>?, CancellationToken)
Gets or creates an MQTT Client agent with the specified name. If the agent exists, it is loaded and returned. If it does not exist, it is created with the specified properties.
- GetOrCreateRestClientAgentAsync(string, IDictionary<string, object>?, CancellationToken)
Gets or creates a REST Client agent with the specified name. If the agent exists, it is loaded and returned. If it does not exist, it is created with the specified properties.
- GetOrCreateRestServerAgentAsync(string, IDictionary<string, object>?, CancellationToken)
Gets or creates a REST Server agent with the specified name. If the agent exists, it is loaded and returned. If it does not exist, it is created with the specified properties.
- GetRestClientAgentAsync(string, CancellationToken)
Gets a REST Client agent with the specified name.
- GetRestServerAgentAsync(string, CancellationToken)
Gets a REST Server agent with the specified name.
- UpdateIotItemAsync(IotItem, CancellationToken)
Updates the specified IoT Item.
- UpdateMqttClientAgentAsync(MqttClientAgent, CancellationToken)
Updates the specified MQTT Client agent.
- UpdateRestClientAgentAsync(RestClientAgent, CancellationToken)
Updates the specified REST Client agent.
- UpdateRestServerAgentAsync(RestServerAgent, CancellationToken)
Updates the specified REST Server agent.