EKM Client API

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:

com::ansys::ingress::client::api::AdministrationException | AdministrationException is for errors related to admin operations performed on an EKM server
com::ansys::ingress::client::api::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
com::ansys::ingress::client::api::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
com::ansys::ingress::client::api::ConnectionClosedException | Indicates the connection is closed
com::ansys::ingress::client::api::ConnectionDetails | ConnectionDetails provides information about a connection to an EKM server
com::ansys::ingress::client::api::ConnectionException | ConnectionException is for errors related to connections to an EKM server
com::ansys::ingress::client::api::ConnectionFactory | ConnectionFactory is used to open connections to an EKM server. These can be transient connections or persistent connections that were previously saved
com::ansys::ingress::client::api::ConnectorEventListener | Defines the interface a listener of events from the connector must implement
com::ansys::ingress::client::api::DataException | DataException is for errors related to data operations performed on an EKM server
com::ansys::ingress::client::api::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
com::ansys::ingress::client::api::EkmException | EkmException is the base class for exceptions thrown by the EKM Connector User API
com::ansys::ingress::client::api::impl::JobSpaceCreationResult | Encapsulates information returned from job space creation

- JobSpaceId - the newly created JobObject's repository full path
- CanSeeClientWorkingDirectory - boolean. Whether or not the Portal can see the client directory
- PortalOverriddenClientWorkingDirectory - the portal overridden client working directory

com::ansys::ingress::connector::model::ModelObject | ModelObject represents a real object in an EKM repository
com::ansys::ingress::connector::model::spec::ModelSpec | ModelSpec defines type information about objects in the repository
com::ansys::ingress::client::api::utils::PathUtils | Utilities methods for EKM paths
com::ansys::ingress::client::api::PermissionAction | PermissionAction defines the actions a user can perform on an object in the Repository
com::ansys::ingress::client::api::search::Query | Query represents a complex query that is performed in an EKM repository
com::ansys::ingress::client::api::search::QueryOperation | QueryOperation is the data used to query for objects on the EKM server
com::ansys::ingress::client::api::search::QueryRow | QueryRow is a specific part of a query used to find an object on the EKM server. For example, a query row will generate an expression like name = "foo" as part of larger query
com::ansys::ingress::client::api::impl::RsmJobManager | RsmJobManager defines the interface for performing job management operations on an EKM server
com::ansys::ingress::client::api::Subscriptions | Subscriptions defines the events that a user can be notified about
com::ansys::ingress::client::api::TransferEvent | TransferEvent contains detailed information about a file transfer and is passed to objects that implement the TransferEventListener interface or extend the TransferEventAdapter class
com::ansys::ingress::client::api::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
com::ansys::ingress::client::api::TransferEventError | TransferEventError contains information about a failed transfer
com::ansys::ingress::client::api::TransferEventListener | TransferEventListener defines the interface that classes should implement to receive events related to a transfer
com::ansys::ingress::client::api::TransferMonitor | TransferMonitor is used to monitor transfers between the client and the EKM server
com::ansys::ingress::connector::model::Variant | Variant represents any type of data value that can be stored in a property of an EKM object. The valid types include:
com::ansys::ingress::connector::model::VariantFactory | VariantFactory is used to create instances of Variants from various value types
com::ansys::ingress::client::api::VersionHistoryItem | VersionHistoryItem provides information about a specific version of an object in the EKM repository. The information provided includes:

All Classes Namespaces Functions Variables Enumerations Properties