EKM Client API

- Main Page
- Namespaces
- Classes

- Namespace List
- Namespace Members

Namespaces | Classes | Enumerations
com::ansys::ingress::client::api Namespace Reference

## Namespaces

namespace | impl
namespace | search
namespace | utils

## Classes

interface | AdministrationManager
| AdministrationManager provides the interface to perform administrative operations on an EKM server. This includes managing users and groups (for actual admin users), managing the user's recycle bin, and other miscellaneous operations. More...
interface | Connection
| Connection represents a connection to an EKM server. It provides access to the managers used to perform various operations on the server. It also defines the methods used to manage persistent connections. More...
class | ConnectionDetails
| ConnectionDetails provides information about a connection to an EKM server. More...
class | ConnectionFactory
| ConnectionFactory is used to open connections to an EKM server. These can be transient connections or persistent connections that were previously saved. More...
interface | DataManager
| DataManager defines the interface for performing data management operations on an EKM server. These operations include C.R.U.D., version control, locking, and file transfers. More...
class | EkmException
| EkmException is the base class for exceptions thrown by the EKM Connector User API. More...
class | ConnectionException
| ConnectionException is for errors related to connections to an EKM server. More...
class | ConnectionClosedException
| Indicates the connection is closed. More...
class | DataException
| DataException is for errors related to data operations performed on an EKM server. More...
class | AdministrationException
| AdministrationException is for errors related to admin operations performed on an EKM server. More...
class | PermissionAction
| PermissionAction defines the actions a user can perform on an object in the Repository. More...
class | Subscriptions
| Subscriptions defines the events that a user can be notified about. More...
interface | ConnectorEventListener
| Defines the interface a listener of events from the connector must implement. More...
interface | TransferEventListener
| TransferEventListener defines the interface that classes should implement to receive events related to a transfer. More...
class | TransferEventAdapter
| TransferEventAdapter is a convenience class that other classes may extend so that not all methods in the TransferEventListener need to be implemented. No actions are taken on any events in the default implementations of the event methods. More...
class | TransferEventError
| TransferEventError contains information about a failed transfer. More...
class | TransferEvent
| TransferEvent contains detailed information about a file transfer and is passed to objects that implement the TransferEventListener interface or extend the TransferEventAdapter class. More...
class | TransferMonitor
| TransferMonitor is used to monitor transfers between the client and the EKM server. More...
class | VersionHistoryItem
| VersionHistoryItem provides information about a specific version of an object in the EKM repository. The information provided includes: More...

## Enumerations

enum | TransferEventReason { CACHED, COMPLETED, ERROR, PROGRESS, STARTED, TERMINATED, METADATA_EXTRACTION_ENDED, METADATA_EXTRACTION_STARTED, FILE_DOWNLOADED, UNDEFINED }
| TransferEventReason is an enumeration of reasons for a transfer event. More...

## Detailed Description

This is the primary namespace for the C# classes defined in the EKM Client API.

## Enumeration Type Documentation

enum com::ansys::ingress::client::api::TransferEventReason

TransferEventReason is an enumeration of reasons for a transfer event.

Enumerator:

  CACHED | Indicates the files and folders being uploaded have reached the EKM cache server.
  COMPLETED | Indicates the transfer is complete.
  ERROR | Indicates the transfer failed.
  PROGRESS | Indicates progress information is being reported for the transfer.
  STARTED | Indicates a transfer was started.
  TERMINATED | Indicates a transfer was terminated.
  METADATA_EXTRACTION_ENDED | Indicates metadata extraction on the server has ended.
  METADATA_EXTRACTION_STARTED | Indicates metadata extraction on the server has started.
  FILE_DOWNLOADED | Indicates a file was downloaded from the server.
  UNDEFINED | Indicates the event was created for an unknown reason.

All Classes Namespaces Functions Variables Enumerations Properties