EKM Client API

- Main Page
- Namespaces
- Classes

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

Public Member Functions
com::ansys::ingress::client::api::AdministrationManager Interface Reference

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...

List of all members.

## Public Member Functions

void | AddSubgroups (List< string > subgroups, string group)
| Adds subgroups to the specified group. If a subgroup in the list does not exist, it is ignored.
void | AddUsersToGroup (List< string > users, string group)
| Adds the users in the list to the specified group.
bool | BelongsTo (string member, string group)
| Determines if the member (user or group) belongs to the specified group.
void | ClearRecycleBin ()
| Clears the current user's recycle bin on the EKM server.
ModelObject | CreateGroup (string groupName)
| Creates a new group.
ModelObject | CreateUser (string username)
| Creates a new user account in the EKM repository.
bool | DeleteMember (string memberName)
| Deletes a user or group.
void | ExecuteScript (string script)
| Executes the given Python code on the server. For example, ExecuteScript("print 1 + 1") will execute that code on the server.
ModelObject | FindGroup (string groupName)
| Searches the groups defined in EKM for the one with the given name.
ModelObject | FindUser (string username)
| Searches the user accounts defined in EKM for the user with the specified name.
DateTime | GetServerTime ()
| Retrieves the date and time from the server.
string | GetCurrentUnitSystem ()
| Gets the current unit system being used by this user on the EKM server.
void | RemoveSubgroups (List< string > subgroups, string group)
| Removes subgroups from a group. If a subgroup specified in the list of subgroups does not exist, it is ignored.
void | RemoveUsersFromGroup (List< string > users, string group)
| Removes users from a group. If a user specified in the list of users does not exist, it is ignored.
void | RestoreRecycleBin (List< string > idsToRestore)
| Restores the data in the user's recycle bin on the EKM server to its original locations.

## Detailed Description

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.

## Member Function Documentation

void com::ansys::ingress::client::api::AdministrationManager::AddSubgroups | ( | List< string > | subgroups,
|  | string | group
| ) |  |

Adds subgroups to the specified group. If a subgroup in the list does not exist, it is ignored.

Parameters:

  subgroups | the list of subgroups
  group | the group

Exceptions:

  DataException | Thrown if the subgroups could not be added to the group.

void com::ansys::ingress::client::api::AdministrationManager::AddUsersToGroup | ( | List< string > | users,
|  | string | group
| ) |  |

Adds the users in the list to the specified group.

Parameters:

  users | the users to add
  group | the group

Exceptions:

  DataException | Thrown if the users could not be added to the group.

bool com::ansys::ingress::client::api::AdministrationManager::BelongsTo | ( | string | member,
|  | string | group
| ) |  |

Determines if the member (user or group) belongs to the specified group.

Parameters:

  member | the member
  group | the group to check

Returns:
  Returns true if the member belongs to the group.

void com::ansys::ingress::client::api::AdministrationManager::ClearRecycleBin | ( |  | ) |

Clears the current user's recycle bin on the EKM server.

ModelObject com::ansys::ingress::client::api::AdministrationManager::CreateGroup | ( | string | groupName | ) |

Creates a new group.

Parameters:

  groupName | the name of the new group

Returns:
  Returns the new group.

Exceptions:

  DataException | Thrown if the groupd could not be created.

ModelObject com::ansys::ingress::client::api::AdministrationManager::CreateUser | ( | string | username | ) |

Creates a new user account in the EKM repository.

Parameters:

  username | the username for the new account

Returns:
  Returns the newly created user.

Exceptions:

  DataException | Thrown if the user could not be created.

bool com::ansys::ingress::client::api::AdministrationManager::DeleteMember | ( | string | memberName | ) |

Deletes a user or group.

Parameters:

  memberName | the name of the member to delete.

Returns:
  Returns true if the member was deleted.

void com::ansys::ingress::client::api::AdministrationManager::ExecuteScript | ( | string | script | ) |

Executes the given Python code on the server. For example, ExecuteScript("print 1 + 1") will execute that code on the server.

Parameters:

  script | the code to execute - this is NOT a path to a script on the server

Exceptions:

  DataException | Thrown if an error occurs executing the script.

ModelObject com::ansys::ingress::client::api::AdministrationManager::FindGroup | ( | string | groupName | ) |

Searches the groups defined in EKM for the one with the given name.

Parameters:

  groupName | the name of the group

Returns:
  Returns the group or null if it was not found.

Exceptions:

  DataException | Thrown if an error occurs executing the search.

ModelObject com::ansys::ingress::client::api::AdministrationManager::FindUser | ( | string | username | ) |

Searches the user accounts defined in EKM for the user with the specified name.

Parameters:

  username | the user name

Returns:
  Returns the user or null if the user does not exist.

Exceptions:

  DataException | Thrown if an error occurs executing the search.

string com::ansys::ingress::client::api::AdministrationManager::GetCurrentUnitSystem | ( |  | ) |

Gets the current unit system being used by this user on the EKM server.

Returns:
  Returns the current unit system (e.g. SI).

DateTime com::ansys::ingress::client::api::AdministrationManager::GetServerTime | ( |  | ) |

Retrieves the date and time from the server.

Returns:
  Returns the current date and time of the server.

void com::ansys::ingress::client::api::AdministrationManager::RemoveSubgroups | ( | List< string > | subgroups,
|  | string | group
| ) |  |

Removes subgroups from a group. If a subgroup specified in the list of subgroups does not exist, it is ignored.

Parameters:

  subgroups | the subgroups to remove
  group | the group

Exceptions:

  DataException | Thrown if an error occurs removing the subgroups from the group.

void com::ansys::ingress::client::api::AdministrationManager::RemoveUsersFromGroup | ( | List< string > | users,
|  | string | group
| ) |  |

Removes users from a group. If a user specified in the list of users does not exist, it is ignored.

Parameters:

  users | the users to remove
  group | the group

Exceptions:

  DataException | Thrown if an error occurs removing the users from the group.

void com::ansys::ingress::client::api::AdministrationManager::RestoreRecycleBin | ( | List< string > | idsToRestore | ) |

Restores the data in the user's recycle bin on the EKM server to its original locations.

Parameters:

  idsToRestore | The IDs of the objects in the recycle bin to be restored.

Exceptions:

  DataException | Thrown if objects could not be restored.

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

- AdministrationManager.cs

All Classes Namespaces Functions Variables Enumerations Properties