@inweb/client
Version:
JavaScript REST API client for the Open Cloud Server
60 lines (59 loc) • 2.42 kB
TypeScript
/**
* Defines the {@link Role | role} actions are allowed to be performed.
*/
export interface IRoleActions {
/**
* Defines what actions are allowed to be performed at the project level. The available actions
* include:
*
* - `update` - The ability to update the project details.
* - `createTopic` - The ability to create a new topic.
* - `createDocument` - The ability to create a new document.
*/
projectActions?: string[];
/**
* Defines what actions are allowed to be performed at the topic level. The available actions include:
*
* - `update` - The ability to update the topic.
* - `updateBimSnippet` - The ability to update the BIM snippet for topics.
* - `updateRelatedTopics` - The ability to update the collection of related topics.
* - `updateDocumentReferences` - The ability to update the collection of document references.
* - `updateFiles` - The ability to update the file header.
* - `createComment` - The ability to create a comment.
* - `createViewpoint` - The ability to create a new viewpoint.
*/
topicActions?: string[];
/**
* Defines what actions are allowed to be performed at the comment level. The available actions
* include:
*
* - `update` - The ability to update the comment.
* - `delete` - The ability to delete the comment.
*/
commentActions?: string[];
/**
* Defines what actions are allowed to be performed at the viewpoint level. The available actions
* include:
*
* - `update` - The ability to update the viewpoint.
* - `delete` - The ability to delete the viewpoint.
*/
viewpointActions?: string[];
/**
* Defines what actions are allowed to be performed at the groups level. The available actions include:
*
* - `create` - The ability to create the group.
* - `update` - The ability to update the group.
* - `updateUser` - The ability to add users to the group.
* - `delete` - The ability to delete the group.
*/
odaGroupActions?: string[];
/**
* Defines what actions are allowed to be performed at the roles level. The available actions include:
*
* - `create` - The ability to create the role.
* - `update` - The ability to update the role.
* - `delete` - The ability to delete the role.
*/
odaRoleActions?: string[];
}