Class AdminApiHandler

Namespace: Kepware.Api.ClientHandler

Assembly: Kepware.Api.dll

Handles operations related to administrative settings and configurations in the Kepware server.

public class AdminApiHandler

Inheritance: object

AdminApiHandler

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AdminApiHandler(KepwareApiClient, ILogger<AdminApiHandler>): Initializes a new instance of the AdminApiHandler class.

Methods

CreateOrUpdateServerUserAsync(ServerUser, CancellationToken): Creates a new Server User or updates an existing one.

CreateOrUpdateServerUserGroupAsync(ServerUserGroup, CancellationToken): Creates a new Server User Group or updates an existing one.

CreateOrUpdateUaEndpointAsync(UaEndpoint, CancellationToken): Creates a new OPC UA endpoint or updates an existing one.

DeleteServerUserAsync(string, CancellationToken): Deletes a Server User configuration asynchronously.

DeleteServerUserGroupAsync(string, CancellationToken): Deletes a Server User Group configuration asynchronously.

DeleteUaEndpointAsync(string, CancellationToken): Deletes an OPC UA endpoint configuration asynchronously.

GetAdminSettingsAsync(CancellationToken): Retrieves the current administrator settings asynchronously.

GetProjectPermissionAsync(ServerUserGroup, ProjectPermissionName, CancellationToken): Retrieves a project permission for a specific server user group asynchronously.

GetProjectPermissionAsync(string, ProjectPermissionName, CancellationToken): Retrieves a project permission for a specific server user group asynchronously.

GetProjectPermissionListAsync(CancellationToken): Retrieves a collection of project permissions asynchronously.

GetServerUserAsync(string, CancellationToken): Retrieves a Server User configuration asynchronously.

GetServerUserGroupAsync(string, CancellationToken): Retrieves a Server User Group configuration asynchronously.

GetServerUserGroupListAsync(CancellationToken): Retrieves a collection of Server User Groups asynchronously.

GetServerUserListAsync(CancellationToken): Retrieves a collection of Server Users asynchronously.

GetUaEndpointAsync(string, CancellationToken): Retrieves an OPC UA endpoint configuration asynchronously.

GetUaEndpointListAsync(CancellationToken): Retrieves a collection of OPC UA endpoints asynchronously.

SetAdminSettingsAsync(AdminSettings, CancellationToken): Updates the administrator settings with the specified values.

UpdateProjectPermissionAsync(ServerUserGroup, ProjectPermission, CancellationToken): Updates a project permission for a specific server user group asynchronously.

UpdateProjectPermissionAsync(string, ProjectPermission, CancellationToken): Updates a project permission for a specific server user group asynchronously.

Edit this page