Interface IPdmAdmin
Gives access to the PDM administration.
Namespace: TopSolid.Pdm.Explorer.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 11, 300, 80)]
public interface IPdmAdminRemarks
This interface is available since v7.10.0.0.
Properties
IsAdmin
Tells whether the connected TopSolid user has PDM administration rights.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
bool IsAdmin { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
This property is available since v7.10.0.0.
UserAccountId
Gets connected user account identifier.
Declaration
[AvailableSinceVersion(7, 15, 186, 0)]
string UserAccountId { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
This property is available since v7.15.186.0.
UserName
Gets connected user account name.
Declaration
[AvailableSinceVersion(7, 15, 186, 0)]
string UserName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
This property is available since v7.15.186.0.
Methods
ActivateUser(String)
Activates an inactive user.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void ActivateUser(string inAccountId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inAccountId | User account identifier. |
Remarks
If the IsAdmin property returns false, this method cannot be called (an exception will be thrown otherwise).
This method is available since v7.10.
ChangeUserPassword(String, String, String)
Sets the password of a user.
Declaration
[AvailableSinceVersion(7, 16, 142, 0)]
bool ChangeUserPassword(string inAccountId, string inOldPassword, string inNewPassword)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inAccountId | User account identifier. |
| System.String | inOldPassword | User current password. |
| System.String | inNewPassword | User new password. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
This method is available since v7.16.
CreateUser(String, String, String, String, String)
Creates a new user.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void CreateUser(string inFirstName, string inLastName, string inInitials, string inAccountId, string inPassword)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inFirstName | User first name. |
| System.String | inLastName | User last name. |
| System.String | inInitials | User initials. |
| System.String | inAccountId | User account identifier. |
| System.String | inPassword | User password. |
Remarks
If the IsAdmin property returns false, this method cannot be called (an exception will be thrown otherwise).
This method is available since v7.10.
DeactivateUser(String)
Deactivate an active user.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void DeactivateUser(string inAccountId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inAccountId | User account identifier. |
Remarks
If the IsAdmin property returns false, this method cannot be called (an exception will be thrown otherwise).
This method is available since v7.10.
GetUserEmailAddress(String)
Gets the e-mail address of a user.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetUserEmailAddress(string inAccountId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inAccountId | User account identifier. |
Returns
| Type | Description |
|---|---|
| System.String | User e-mail address. |
Remarks
This method is available since v7.10.
GetUserGroupName(PdmObjectId, out String, out String)
Gets the name of a user group.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void GetUserGroupName(PdmObjectId inUserGroupId, out string outName, out string outDescription)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inUserGroupId | User Group identifier. |
| System.String | outName | User group name. |
| System.String | outDescription | User group description. |
Remarks
This method is available since v7.8.302.060.
GetUserGroups(Boolean, Boolean)
Gets all the users groups.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmObjectId> GetUserGroups(bool inGetsActiveUserGroups, bool inGetsInactiveUserGroups)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | inGetsActiveUserGroups | Gets active user groups. |
| System.Boolean | inGetsInactiveUserGroups | Gets inactive user groups. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | User group identifiers. |
Remarks
This method is available since v7.8.302.060.
GetUserGroupUserAccountIds(PdmObjectId)
Gets the users account identifiers of a user group.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<string> GetUserGroupUserAccountIds(PdmObjectId inUserGroupId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inUserGroupId | User group identifier. |
Returns
| Type | Description |
|---|---|
| List<System.String> | Users account identifiers. |
Remarks
This method is available since v7.8.302.060.
GetUserName(String, out String, out String, out String)
Gets the name of a user.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void GetUserName(string inAccountId, out string outFirstName, out string outLastName, out string outInitials)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inAccountId | User account identifier. |
| System.String | outFirstName | User first name. |
| System.String | outLastName | User last name. |
| System.String | outInitials | User initials. |
Remarks
This method is available since v7.10.
GetUsers(Boolean, Boolean)
Gets all the users.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<string> GetUsers(bool inGetsActiveUsers, bool inGetsInactiveUsers)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | inGetsActiveUsers | Gets active users. |
| System.Boolean | inGetsInactiveUsers | Gets inactive users. |
Returns
| Type | Description |
|---|---|
| List<System.String> | Users account identifier. |
Remarks
This method is available since v7.10.
IsUserActive(String)
Tells whether a user is active.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
bool IsUserActive(string inAccountId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inAccountId | User account identifier. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The user is active. |
Remarks
This method is available since v7.10.
SetUserEmailAddress(String, String)
Sets the e-mail address of a user.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetUserEmailAddress(string inAccountId, string inEmailAddress)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inAccountId | User account identifier. |
| System.String | inEmailAddress | User e-mail address. |
Remarks
If the IsAdmin property returns false, this method cannot be called (an exception will be thrown otherwise).
This method is available since v7.10.
SetUserName(String, String, String, String)
Sets the name of a user.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetUserName(string inAccountId, string inFirstName, string inLastName, string inInitials)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inAccountId | User account identifier. |
| System.String | inFirstName | User first name. |
| System.String | inLastName | User last name. |
| System.String | inInitials | User initials. |
Remarks
If the IsAdmin property returns false, this method cannot be called (an exception will be thrown otherwise).
This method is available since v7.10.