Method DeleteItemAsync

Namespace

Kepware.Api.ClientHandler

Assembly

Kepware.Api.dll

DeleteItemAsync<T>(T, CancellationToken)

Deletes an item from the Kepware server.

public Task<bool> DeleteItemAsync<T>(T item, CancellationToken cancellationToken = default) where T : NamedEntity, new()

Parameters

item T

cancellationToken CancellationToken

Returns

Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the delete was successful.

Type Parameters

T

DeleteItemAsync<T>(string, CancellationToken)

Deletes an item from the Kepware server using the item name.

public Task<bool> DeleteItemAsync<T>(string itemName, CancellationToken cancellationToken = default) where T : NamedEntity, new()

Parameters

itemName string

cancellationToken CancellationToken

Returns

Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the delete was successful.

Type Parameters

T

DeleteItemAsync<T>(string[], CancellationToken)

public Task<bool> DeleteItemAsync<T>(string[] itemNames, CancellationToken cancellationToken = default) where T : NamedEntity, new()

Parameters

itemNames string[]

cancellationToken CancellationToken

Returns

Task<bool>

Type Parameters

T

DeleteItemAsync<T, K>(K, NamedEntity?, CancellationToken)

Deletes an item from the Kepware server.

public Task DeleteItemAsync<T, K>(K item, NamedEntity? owner = null, CancellationToken cancellationToken = default) where T : EntityCollection<K> where K : NamedEntity, new()

Parameters

item K

owner NamedEntity

cancellationToken CancellationToken

Returns

Task

Type Parameters

T

K