Interface IPdmSecurity
Gives access to the PDM security.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 8, 0, 0)]
public interface IPdmSecurityRemarks
This interface is available since v7.8.
Methods
ActivateProjectSecurity(PdmObjectId)
Activates security of a project.
Declaration
[AvailableSinceVersion(7, 8, 302, 60)]
void ActivateProjectSecurity(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier to activate. |
Remarks
This method is available since v7.8.302.060.
ActivateSecurity()
Activates system security.
Declaration
[AvailableSinceVersion(7, 12, 0, 0)]
void ActivateSecurity()Remarks
This method is available since v7.12.
DeactivateProjectSecurity(PdmObjectId)
Deactivates security of a project.
Declaration
[AvailableSinceVersion(7, 8, 302, 60)]
void DeactivateProjectSecurity(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier to deactivate. |
Remarks
This method is available since v7.8.302.060.
DeactivateSecurity()
Deactivates system security.
Declaration
[AvailableSinceVersion(7, 12, 0, 0)]
void DeactivateSecurity()Remarks
This method is available since v7.12.
GetPermissions(PdmObjectId)
Retrieves security of a project, folder or document.
Declaration
[AvailableSinceVersion(7, 8, 302, 60)]
List<PdmSecurityUserOrGroupPermissions> GetPermissions(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Project, folder or document identifier to retrieve permissions or empty for system permissions. |
Returns
| Type | Description |
|---|---|
| List<PdmSecurityUserOrGroupPermissions> | Security permissions. |
Remarks
This method is available since v7.8.302.060.
HasRight(PdmObjectId, PdmRight)
Tells whether the current user has a specific right on an object.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
bool HasRight(PdmObjectId inObjectId, PdmRight inRight)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of project, folder or document. |
| PdmRight | inRight | Right. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Has right. |
Remarks
This method is available since v7.10.
IsProjectSecurityActive(PdmObjectId)
Tells if a security is activated on a project.
Declaration
[AvailableSinceVersion(7, 8, 302, 60)]
bool IsProjectSecurityActive(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The project securities activated. |
Remarks
This method is available since v7.8.302.060.
IsSecurityActive()
Tells if a security is globally activated.
Declaration
[AvailableSinceVersion(7, 8, 302, 60)]
bool IsSecurityActive()Returns
| Type | Description |
|---|---|
| System.Boolean | Global security is activated. |
Remarks
This method is available since v7.8.302.060.
SetPermissions(PdmObjectId, List<PdmSecurityUserOrGroupPermissions>)
Sets security of a project, folder or document.
Declaration
[AvailableSinceVersion(7, 8, 302, 60)]
void SetPermissions(PdmObjectId inObjectId, List<PdmSecurityUserOrGroupPermissions> inPermissions)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Project, folder or document identifier to set permissions or empty for system permissions. |
| List<PdmSecurityUserOrGroupPermissions> | inPermissions | Security permissions to set. |
Remarks
This method is available since v7.8.302.060.