EKM Client API

- Main Page
- Namespaces
- Classes

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

Public Member Functions
com::ansys::ingress::client::api::ConnectionDetails Class Reference

ConnectionDetails provides information about a connection to an EKM server. More...

List of all members.

## Public Member Functions

| ConnectionDetails (string name, Uri location, string workspace, string username, char[] password, bool savedCredentials, bool opened)
| Creates a new instance of ConnectionDetails.
| ConnectionDetails ()
| Creates a new instance of ConnectionDetails.
bool | CredentialsMatch (string username, string password)
| Determines if the given username and password match the credentials associated with this connection.
bool | HasSavedCredentials ()
| Determines if this connection has saved credentials or not.
List< string > | GetAvailableWorkspaces ()
| Gets the workspaces that are available to this connection.
string | GetName ()
| Gets the name of the connection.
string | GetUsername ()
| Gets the username for the connection.
Uri | GetLocation ()
| Gets the location of the EKM server associated with the connection.
string | GetWorkspace ()
| Gets the workspace associated with the connection.
bool | IsAdminUser ()
| Determines if the user associated with the connection is an admin user or not.
bool | IsOpened ()
| Determines if the connection is opened or not.
bool | IsSaved ()
| Determines if the connection is saved or not.
string | GetUserArchiveId ()
| Gets the user's archive ID.
string | GetUserToken ()
| Gets the token a user can use to authenicate with the server.

## Detailed Description

ConnectionDetails provides information about a connection to an EKM server.

## Constructor & Destructor Documentation

com::ansys::ingress::client::api::ConnectionDetails::ConnectionDetails | ( | string | name,
|  | Uri | location,
|  | string | workspace,
|  | string | username,
|  | char[] | password,
|  | bool | savedCredentials,
|  | bool | opened
| ) |  | `[inline]`

Creates a new instance of ConnectionDetails.

Parameters:

  name | the name of the connection
  location | the location of the EKM server associated with the connection
  workspace | the workspace associated with the connection
  username | the username
  password | the password
  savedCredentials | if the connection has saved credentials or not
  opened | if the connection is opened or not

com::ansys::ingress::client::api::ConnectionDetails::ConnectionDetails | ( |  | ) | `[inline]`

Creates a new instance of ConnectionDetails.

## Member Function Documentation

bool com::ansys::ingress::client::api::ConnectionDetails::CredentialsMatch | ( | string | username,
|  | string | password
| ) |  | `[inline]`

Determines if the given username and password match the credentials associated with this connection.

Parameters:

  username | the username
  password | the password

Returns:
  Returns true if the credentials match.

List<string> com::ansys::ingress::client::api::ConnectionDetails::GetAvailableWorkspaces | ( |  | ) | `[inline]`

Gets the workspaces that are available to this connection.

Returns:
  Returns the list of workspaces.

Uri com::ansys::ingress::client::api::ConnectionDetails::GetLocation | ( |  | ) | `[inline]`

Gets the location of the EKM server associated with the connection.

Returns:
  Returns the location.

string com::ansys::ingress::client::api::ConnectionDetails::GetName | ( |  | ) | `[inline]`

Gets the name of the connection.

Returns:
  Returns the name.

string com::ansys::ingress::client::api::ConnectionDetails::GetUserArchiveId | ( |  | ) | `[inline]`

Gets the user's archive ID.

Returns:
  Returns the ID.

string com::ansys::ingress::client::api::ConnectionDetails::GetUsername | ( |  | ) | `[inline]`

Gets the username for the connection.

Returns:
  Returns the username.

string com::ansys::ingress::client::api::ConnectionDetails::GetUserToken | ( |  | ) | `[inline]`

Gets the token a user can use to authenicate with the server.

Returns:
  Returns the token.

string com::ansys::ingress::client::api::ConnectionDetails::GetWorkspace | ( |  | ) | `[inline]`

Gets the workspace associated with the connection.

Returns:
  Returns the workspace.

bool com::ansys::ingress::client::api::ConnectionDetails::HasSavedCredentials | ( |  | ) | `[inline]`

Determines if this connection has saved credentials or not.

Returns:
  Returns true if the connection has saved credentials.

bool com::ansys::ingress::client::api::ConnectionDetails::IsAdminUser | ( |  | ) | `[inline]`

Determines if the user associated with the connection is an admin user or not.

Returns:
  Returns true if the user is an admin user.

bool com::ansys::ingress::client::api::ConnectionDetails::IsOpened | ( |  | ) | `[inline]`

Determines if the connection is opened or not.

Returns:
  Returns true if the connection is opened.

bool com::ansys::ingress::client::api::ConnectionDetails::IsSaved | ( |  | ) | `[inline]`

Determines if the connection is saved or not.

Returns:
  Returns true if the connection is saved.

The documentation for this class was generated from the following file:

- ConnectionDetails.cs

All Classes Namespaces Functions Variables Enumerations Properties