Class GenericApiHandler

Namespace: Kepware.Api.ClientHandler

Assembly: Kepware.Api.dll

Provides general operation APIs related to configuring objects in the Kepware server.

public class GenericApiHandler

Inheritance: object

GenericApiHandler

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CompareAndApply<T, K>(T?, T?, NamedEntity?, CancellationToken): Compares two collections of entities and applies the changes to the target collection. Left should represent the source collection and Right should represent the target collection in the Kepware server.

DeleteItemAsync<T>(string, CancellationToken): Deletes an item from the Kepware server using the item name.

DeleteItemAsync<T>(string[], CancellationToken)

DeleteItemAsync<T>(T, CancellationToken): Deletes an item from the Kepware server.

DeleteItemAsync<T, K>(K, NamedEntity?, CancellationToken): Deletes an item from the Kepware server.

DeleteItemByEndpointAsync<T>(string, CancellationToken)

DeleteItemsAsync<T, K>(List<K>, NamedEntity?, CancellationToken): Deletes a list of items from the Kepware server.

DeserializeJsonArrayAsync<K>(HttpResponseMessage, CancellationToken)

DeserializeJsonAsync<K>(HttpResponseMessage, JsonTypeInfo<K>, CancellationToken)

DeserializeJsonAsync<K>(HttpResponseMessage, CancellationToken)

GetChannelPropertiesAsync(Driver, CancellationToken): Returns the channel properties for the specified driver in the Kepware server.

GetChannelPropertiesAsync(string, CancellationToken)

GetDevicePropertiesAsync(Driver, CancellationToken): Returns the device properties for the specified driver in the Kepware server.

GetDevicePropertiesAsync(string, CancellationToken): Returns the device properties for the specified driver in the Kepware server.

InsertItemAsync<T>(T, NamedEntity?, CancellationToken): Inserts an item in the Kepware server.

InsertItemAsync<T, K>(K, NamedEntity?, CancellationToken): Inserts an item in the Kepware server.

InsertItemsAsync<T, K>(List<K>, int, NamedEntity?, CancellationToken): Inserts a list of items in the Kepware server.

LoadChannelPropertiesAsync(string, CancellationToken)

LoadCollectionAsync<T>(NamedEntity, CancellationToken): Loads a collection of entities of type T asynchronously by its owner from the Kepware server.

LoadCollectionAsync<T>(string?, CancellationToken): Loads a collection of entities of type T asynchronously by its owner from the Kepware server.

LoadCollectionAsync<T, K>(NamedEntity, CancellationToken): Loads a collection of entities of type T asynchronously by its owner from the Kepware server.

LoadCollectionAsync<T, K>(IEnumerable<string>, CancellationToken): Loads a collection of entities of type T asynchronously by its endpoint from the Kepware server.

LoadCollectionAsync<T, K>(string?, CancellationToken): Loads a collection of entities of type T asynchronously by its owner from the Kepware server.

LoadCollectionByEndpointAsync<T, K>(string, CancellationToken)

LoadDevicePropertiesAsync(string, CancellationToken)

LoadEntityAsync<T>(IEnumerable<string>, CancellationToken): Loads an entity of type T asynchronously by its owner from the Kepware server.

LoadEntityAsync<T>(string, NamedEntity, CancellationToken): Loads an entity of type T asynchronously by its name and owner from the Kepware server.

LoadEntityAsync<T>(string?, CancellationToken): Loads an entity of type T asynchronously by its name from the Kepware server.

LoadEntityByEndpointAsync<T>(string, CancellationToken)

LoadSupportedDriversAsync(CancellationToken)

SupportedDriversAsync(CancellationToken): Returns a list of all supported drivers from the Kepware server.

UpdateItemAsync<T>(string, T, T, CancellationToken)

UpdateItemAsync<T>(T, T?, CancellationToken): Updates an item in the Kepware server.

UpdateItemAsync<T, K>(K, K?, NamedEntity?, CancellationToken): Updates an item in the Kepware server.

UpdateItemsAsync<T, K>(List<(K item, K? oldItem)>, NamedEntity?, CancellationToken): Updates a list of items in the Kepware server.

Edit this page