Method DeleteRestClientAgentAsync

Namespace

Kepware.Api.ClientHandler

Assembly

Kepware.Api.dll

DeleteRestClientAgentAsync(RestClientAgent, CancellationToken)

Deletes the specified REST Client agent.

public Task<bool> DeleteRestClientAgentAsync(RestClientAgent agent, CancellationToken cancellationToken = default)

Parameters

agent RestClientAgent

The agent to delete.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<bool>

A boolean indicating whether the deletion was successful.

Exceptions

ArgumentNullException

Thrown when the agent is null.

DeleteRestClientAgentAsync(string, CancellationToken)

Deletes the REST Client agent with the specified name.

public Task<bool> DeleteRestClientAgentAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the agent to delete.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<bool>

A boolean indicating whether the deletion was successful.

Exceptions

ArgumentException

Thrown when the name is null or empty.