mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
update doc (#8386)
This commit is contained in:
Eugenio Romano
GitHub
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2022-11-25
|
||||
---
|
||||
|
||||
# [Card View Content Update Service](lib/content-services/src/lib/common/services/card-view-content-update.service.ts "Defined in card-view-content-update.service.ts")
|
||||
# [Card View Content Update Service](../../../lib/content-services/src/lib/common/services/card-view-content-update.service.ts "Defined in card-view-content-update.service.ts")
|
||||
|
||||
Manages Card View properties in the content services environment.
|
||||
Implements [`BaseCardViewContentUpdate`](../../../lib/content-services/src/lib/interfaces/base-card-view-content-update.interface.ts).
|
||||
|
||||
@@ -13,15 +13,46 @@ Datasource service for category tree.
|
||||
|
||||
### Methods
|
||||
|
||||
- **getSubNodes**(parentNodeId: `string`, skipCount?: `number`, maxItems?: `number`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TreeResponse<CategoryNode>`](../../../lib/content-services/src/lib/tree/models/tree-response.interface.ts)`>`<br/>
|
||||
- **appendNodes**(nodeToAppend: [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts), subNodes: [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`[]`)<br/>
|
||||
Append more child nodes to already expanded parent node
|
||||
- _nodeToAppend:_ [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts) - Expanded parent node
|
||||
- _subNodes:_ [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`[]` - List of nodes that will be added as children of expanded node
|
||||
- **collapseNode**(nodeToCollapse: [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts))<br/>
|
||||
Collapses a node removing all children from it.
|
||||
- _nodeToCollapse:_ [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts) - Node to be collapsed
|
||||
- **connect**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`[]>`<br/>
|
||||
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`[]>` -
|
||||
|
||||
- **disconnect**()<br/>
|
||||
|
||||
- **expandNode**(nodeToExpand: [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts), subNodes: [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`[]`)<br/>
|
||||
Expands node applying subnodes to it.
|
||||
- _nodeToExpand:_ [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts) - Node to be expanded
|
||||
- _subNodes:_ [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`[]` - List of nodes that will be added as children of expanded node
|
||||
- **getChildren**(parentNode: [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)): [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`[]`<br/>
|
||||
Gets children of the node
|
||||
- _parentNode:_ [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts) - Parent node
|
||||
- **Returns** [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`[]` - children of parent node
|
||||
- **getParentNode**(parentNodeId: `string`): [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`|undefined`<br/>
|
||||
Gets parent node of given node. If node with parentNodeId is not found it returns undefined.
|
||||
- _parentNodeId:_ `string` - Id of a parent node to be found
|
||||
- **Returns** [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`|undefined` - parent node or undefined when not found
|
||||
- **getSubNodes**(parentNodeId: `string`, skipCount?: `number`, maxItems?: `number`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TreeResponse`](../../../lib/content-services/src/lib/tree/models/tree-response.interface.ts)`<`[`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`>>`<br/>
|
||||
Gets categories as nodes for category tree.
|
||||
- _parentNodeId:_ `string` - Identifier of a parent category
|
||||
- _skipCount:_ `number` - Number of top categories to skip
|
||||
- _maxItems:_ `number` - Maximum number of subcategories returned from Observable
|
||||
- _name:_ `string` - Optional parameter which specifies if categories should be filtered out by name or not. If not specified then returns categories without filtering.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TreeResponse<CategoryNode>`](../../../lib/content-services/src/lib/tree/models/tree-response.interface.ts)`>` - TreeResponse object containing pagination object and list on nodes
|
||||
- _skipCount:_ `number` - (Optional) Number of top categories to skip
|
||||
- _maxItems:_ `number` - (Optional) Maximum number of subcategories returned from
|
||||
- _name:_ `string` - (Optional) Optional parameter which specifies if categories should be filtered out by name or not. If not specified then returns categories without filtering.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TreeResponse`](../../../lib/content-services/src/lib/tree/models/tree-response.interface.ts)`<`[`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts)`>>` -
|
||||
- **isEmpty**(): `boolean`<br/>
|
||||
Checks if tree is empty
|
||||
- **Returns** `boolean` - boolean
|
||||
- **removeNode**(node: [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts))<br/>
|
||||
Removes provided node from the tree
|
||||
- _node:_ [`CategoryNode`](../../../lib/content-services/src/lib/category/models/category-node.interface.ts) - Node to be removed
|
||||
|
||||
## Details
|
||||
|
||||
Category tree datasource service acts as datasource for tree component utilizing category service. See the
|
||||
[Category tree datasource service](../../content-services/services/category-tree-datasource.service.md) acts as datasource for [tree component](../../content-services/components/tree.component.md) utilizing [category service](../../content-services/services/category.service.md). See the
|
||||
[Tree component](../../../lib/content-services/src/lib/tree/components/tree.component.ts) and [Tree service](../../../lib/content-services/src/lib/tree/services/tree.service.ts) to get more details on how datasource is used.
|
||||
|
||||
@@ -13,32 +13,32 @@ Manages categories in Content Services.
|
||||
|
||||
### Methods
|
||||
|
||||
- **getSubcategories**(parentCategoryId: `string`, skipCount?: `number`, maxItems?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryPaging.md)`>`<br/>
|
||||
Gets subcategories of a given parent category.
|
||||
- _parentCategoryId:_ `string` - Identifier of a parent category
|
||||
- _skipCount:_ `number` - Number of top categories to skip
|
||||
- _maxItems:_ `number` - Maximum number of subcategories returned from Observable
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryPaging.md)`>` - CategoryPaging object (defined in JS-API) with category paging list
|
||||
- **createSubcategory**(parentCategoryId: `string`, payload: [`CategoryBody`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryBody.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryEntry.md)`>`<br/>
|
||||
Creates subcategory under category with provided categoryId.
|
||||
- _parentCategoryId:_ `string` - Identifier of a parent category
|
||||
- _payload:_ [`CategoryBody`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryBody.md) - Created category body
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryEntry.md)`>` - CategoryEntry object (defined in JS-API) containing the category
|
||||
- **updateCategory**(categoryId: `string`, payload: [`CategoryBody`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryBody.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryEntry.md)`>`<br/>
|
||||
Updates category.
|
||||
- _categoryId:_ `string` - Identifier of a category
|
||||
- _payload:_ [`CategoryBody`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryBody.md) - Created category body
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryEntry.md)`>` - CategoryEntry object (defined in JS-API) containing the category
|
||||
- **createSubcategory**(parentCategoryId: `string`, payload: `CategoryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<CategoryEntry>`<br/>
|
||||
Creates subcategory under category with provided categoryId
|
||||
- _parentCategoryId:_ `string` - The identifier of a parent category.
|
||||
- _payload:_ `CategoryBody` - Created category body
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<CategoryEntry>` - [`Observable`](http://reactivex.io/documentation/observable.html)<CategoryEntry>
|
||||
- **deleteCategory**(categoryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
|
||||
Deletes category.
|
||||
- _categoryId:_ `string` - Identifier of a category
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Null object when the operation completes
|
||||
- **searchCategories**(name: `string`, skipCount: `number`, maxItems?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`<br/>
|
||||
Deletes category
|
||||
- _categoryId:_ `string` - The identifier of a category.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - [`Observable`](http://reactivex.io/documentation/observable.html)<void>
|
||||
- **getSubcategories**(parentCategoryId: `string`, skipCount?: `number`, maxItems?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<CategoryPaging>`<br/>
|
||||
Get subcategories of a given parent category
|
||||
- _parentCategoryId:_ `string` - The identifier of a parent category.
|
||||
- _skipCount:_ `number` - (Optional) Number of top categories to skip.
|
||||
- _maxItems:_ `number` - (Optional) Maximum number of subcategories returned from [Observable](http://reactivex.io/documentation/observable.html).
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<CategoryPaging>` - [`Observable`](http://reactivex.io/documentation/observable.html)<CategoryPaging>
|
||||
- **searchCategories**(name: `string`, skipCount: `number` = `0`, maxItems?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`<br/>
|
||||
Searches categories by their name.
|
||||
- _name:_ `string` - Value for name which should be used during searching categories.
|
||||
- _skipCount:_ `number` - Specify how many first results should be skipped. Default 0.
|
||||
- _maxItems:_ `number` - Specify max number of returned categories. Default is specified by UserPreferencesService.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - Found categories which name contains searched name.
|
||||
- _name:_ `string` - Value for name which should be used during searching categories.
|
||||
- _skipCount:_ `number` - Specify how many first results should be skipped. Default 0.
|
||||
- _maxItems:_ `number` - (Optional) Specify max number of returned categories. Default is specified by [UserPreferencesService](../../core/services/user-preferences.service.md).
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - [`Observable`](http://reactivex.io/documentation/observable.html)<ResultSetPaging> Found categories which name contains searched name.
|
||||
- **updateCategory**(categoryId: `string`, payload: `CategoryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<CategoryEntry>`<br/>
|
||||
Updates category
|
||||
- _categoryId:_ `string` - The identifier of a category.
|
||||
- _payload:_ `CategoryBody` - Updated category body
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<CategoryEntry>` - [`Observable`](http://reactivex.io/documentation/observable.html)<CategoryEntry>
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -33,11 +33,11 @@ Implements node operations used by the [Document List component](../components/d
|
||||
- _nodeId:_ `string` - ID of the folder node
|
||||
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
|
||||
- **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
|
||||
- **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`<br/>
|
||||
Gets a node via its node ID.
|
||||
- _nodeId:_ `string` - ID of the target node
|
||||
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the folder
|
||||
- **isCustomSourceService**(nodeId: `any`): `boolean`<br/>
|
||||
|
||||
- _nodeId:_ `any` -
|
||||
|
||||
@@ -22,6 +22,10 @@ Adds and retrieves comments for nodes in Content Services.
|
||||
Gets all comments that have been added to a task.
|
||||
- _id:_ `string` - ID of the target task
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>` - Details for each comment
|
||||
- **getUserImage**(avatarId: `string`): `string`<br/>
|
||||
|
||||
- _avatarId:_ `string` -
|
||||
- **Returns** `string` -
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ Stores information from all the custom search and faceted search widgets, compil
|
||||
- **Returns** `QueryBody` - The finished query
|
||||
- **execute**(queryBody?: `QueryBody`)<br/>
|
||||
Builds and executes the current query.
|
||||
- _queryBody:_ `QueryBody` - (Optional) (Optional)
|
||||
- _queryBody:_ `QueryBody` - (Optional)
|
||||
- **getDefaultConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/models/search-configuration.interface.ts)`|undefined`<br/>
|
||||
|
||||
- **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/models/search-configuration.interface.ts)`|undefined` -
|
||||
@@ -92,7 +92,7 @@ Stores information from all the custom search and faceted search widgets, compil
|
||||
|
||||
- **update**(queryBody?: `QueryBody`)<br/>
|
||||
Builds the current query and triggers the `updated` event.
|
||||
- _queryBody:_ `QueryBody` - (Optional) (Optional)
|
||||
- _queryBody:_ `QueryBody` - (Optional)
|
||||
- **updateSelectedConfiguration**(index: `number`)<br/>
|
||||
|
||||
- _index:_ `number` -
|
||||
|
||||
@@ -13,67 +13,68 @@ Manages security groups & marks in Content Services.
|
||||
|
||||
### Methods
|
||||
|
||||
- **getSecurityGroup**(skipCount?: `number`, maxItems?: `number`, include?: `string`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityControlsGroupResponse>`<br/>
|
||||
Get security groups.
|
||||
- _skipCount:_ `number` - The number of entities that exist in the collection before those included in this list.
|
||||
- _maxItems:_ `number` - The maximum number of items to return in the list.
|
||||
- _include:_ `string` - Additional information about the security group.
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityControlsGroupResponse>`
|
||||
- **createSecurityGroup**(input: `SecurityGroupBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityGroupEntry>`<br/>
|
||||
Creates a security group.
|
||||
- _input:_ `SecurityGroupBody` - Security group.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityGroupEntry>`
|
||||
- **createSecurityMarks**(securityGroupId: `string`, input: `SecurityMarkBody[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkPaging | SecurityMarkEntry>`<br/>
|
||||
Create security marks.
|
||||
Create security group
|
||||
- _input:_ `SecurityGroupBody` - securityGroupBody.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityGroupEntry>` - [`Observable`](http://reactivex.io/documentation/observable.html)<SecurityGroupEntry>
|
||||
- **createSecurityMarks**(securityGroupId: `string`, input: `SecurityMarkBody[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkPaging|SecurityMarkEntry>`<br/>
|
||||
Create security marks
|
||||
- _securityGroupId:_ `string` - The key for the security group id.
|
||||
- _SecurityMarkBody:_ `SecurityMarkBody[]` - Node security marks list.
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkPaging | SecurityMarkEntry>`
|
||||
- **getSecurityMark**(securityGroupId: `string`, skipCount?: `number`, include?: `string`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityControlsMarkResponse>`<br/>
|
||||
Get security mark value.
|
||||
- _securityGroupId:_ `string` - The key for the security group id.
|
||||
- _skipCount:_ `number` - The number of entities that exist in the collection before those included in this list.
|
||||
- _include:_ `string` - The key for the security mark is in use or not.
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityControlsMarkResponse>`
|
||||
- **updateSecurityGroup**(securityGroupId: `string`, input: `SecurityGroupBody`, opts?: `any`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityGroupEntry>`<br/>
|
||||
Update a security groups information.
|
||||
- _securityGroupId:_ `string` - The key of security group id for which info is required.
|
||||
- _input:_ `SecurityGroupBody` - Security group.
|
||||
- _opts:_ `any` - (Optional) Extra options supported by JS-API.
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityGroupEntry>`
|
||||
- **updateSecurityMark**(securityGroupId: `string`, securityMarkId: `string`, input: `SecurityMarkBody`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkEntry>`<br/>
|
||||
Updates Security Mark value.
|
||||
- _securityGroupId:_ `string` - The key for the security group id.
|
||||
- _securityMarkId:_ `string` - The key for the security mark is in use or not.
|
||||
- _input:_ `SecurityMarkBody` - Security mark.
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkEntry>`
|
||||
- _input:_ `SecurityMarkBody[]` - securityMarkBody\[].
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkPaging|SecurityMarkEntry>` - [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)<SecurityMarkPaging | SecurityMarkEntry>
|
||||
- **deleteSecurityGroup**(securityGroupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityGroupEntry>`<br/>
|
||||
Delete security group.
|
||||
Delete security group
|
||||
- _securityGroupId:_ `string` - The key for the security group id.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityGroupEntry>`
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityGroupEntry>` - [`Observable`](http://reactivex.io/documentation/observable.html)<SecurityGroupEntry>
|
||||
- **deleteSecurityMark**(securityGroupId: `string`, securityMarkId: `string`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkEntry>`<br/>
|
||||
Delete security mark.
|
||||
Delete security mark
|
||||
- _securityGroupId:_ `string` - The key for the security group id.
|
||||
- _securityMarkId:_ `string` - The key for the security mark id.
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkEntry>`
|
||||
- **getClearancesForAuthority**(authorityName: `string`, skipCount?: `number`, maxItems?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<AuthorityClearanceGroupPaging>`<br/>
|
||||
Get the authority clearances for a single user/group.
|
||||
- _authorityName:_ `string` - The name for the authority for which the clearance is to be fetched.
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkEntry>` - [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)<SecurityMarkEntry>
|
||||
- **getClearancesForAuthority**(authorityName: `string`, skipCount: `number` = `DEFAULT_SKIP_COUNT`, maxItems: `number` = `this.userPreferencesService.paginationSize`): [`Observable`](http://reactivex.io/documentation/observable.html)`<AuthorityClearanceGroupPaging>`<br/>
|
||||
Get the authority clearances for a single user/group
|
||||
- _authorityName:_ `string` - The name for the authority for which the clearance is to be fetched. Can be left blank in which case it will fetch it for all users with pagination
|
||||
- _skipCount:_ `number` - The number of entities that exist in the collection before those included in this list.
|
||||
- _maxItems:_ `number` - The maximum number of items to return in the list.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<AuthorityClearanceGroupPaging>`
|
||||
- **updateClearancesForAuthority**(authorityName: `string`, securityMarksList: `NodeSecurityMarkBody[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityMarkEntry | SecurityMarkPaging>`<br/>
|
||||
Updates the authority clearance.
|
||||
- _authorityName:_ `string` - The name for the authority for which the clearance is to be updated.
|
||||
- _securityMarksList:_ `NodeSecurityMarkBody[]` - Node security marks list.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityMarkEntry | SecurityMarkPaging>`
|
||||
- _maxItems:_ `number` - The maximum number of items to return in the list. Default is specified by [UserPreferencesService](../../core/services/user-preferences.service.md).
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<AuthorityClearanceGroupPaging>` - [`Observable`](http://reactivex.io/documentation/observable.html)<AuthorityClearanceGroupPaging>
|
||||
- **getSecurityGroup**(skipCount: `number` = `DEFAULT_SKIP_COUNT`, maxItems: `number` = `this.userPreferencesService.paginationSize`, include: `string` = `DEFAULT_INCLUDE`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`SecurityControlsGroupResponse`](../../../lib/content-services/src/lib/security/services/models/security-controls-group-response.interface.ts)`>`<br/>
|
||||
Get All security groups
|
||||
- _skipCount:_ `number` - The number of entities that exist in the collection before those included in this list.
|
||||
- _maxItems:_ `number` - The maximum number of items to return in the list. Default is specified by [UserPreferencesService](../../core/services/user-preferences.service.md).
|
||||
- _include:_ `string` - Additional information about the security group
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`SecurityControlsGroupResponse`](../../../lib/content-services/src/lib/security/services/models/security-controls-group-response.interface.ts)`>` - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)<SecurityControlsGroupResponse>
|
||||
- **getSecurityMark**(securityGroupId: `string`, skipCount: `number` = `DEFAULT_SKIP_COUNT`, include: `string` = `DEFAULT_INCLUDE`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`SecurityControlsMarkResponse`](../../../lib/content-services/src/lib/security/services/models/security-controls-mark-response.interface.ts)`>`<br/>
|
||||
Get security mark value Gets the value for a selected **securityGroupId**.
|
||||
- _securityGroupId:_ `string` - The key for the security group id.
|
||||
- _skipCount:_ `number` - The number of entities that exist in the collection before those included in this list.
|
||||
- _include:_ `string` - The key for the security mark is in use or not
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`SecurityControlsMarkResponse`](../../../lib/content-services/src/lib/security/services/models/security-controls-mark-response.interface.ts)`>` - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)<SecurityControlsMarkResponse>
|
||||
- **reloadSecurityGroups**()<br/>
|
||||
|
||||
- **updateClearancesForAuthority**(authorityName: `string`, securityMarksList: `NodeSecurityMarkBody[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityMarkEntry|SecurityMarkPaging>`<br/>
|
||||
Updates the authority clearance.
|
||||
- _authorityName:_ `string` - The name for the authority for which the clearance is to be updated
|
||||
- _securityMarksList:_ `NodeSecurityMarkBody[]` - NodeSecurityMarkBody\[]
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityMarkEntry|SecurityMarkPaging>` - [`Observable`](http://reactivex.io/documentation/observable.html)<SecurityMarkEntry | SecurityMarkPaging>
|
||||
- **updateSecurityGroup**(securityGroupId: `string`, input: `SecurityGroupBody`, opts?: `any`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityGroupEntry>`<br/>
|
||||
Update a security groups information
|
||||
- _securityGroupId:_ `string` - The Key of Security Group id for which info is required
|
||||
- _input:_ `SecurityGroupBody` - SecurityGroupBody
|
||||
- _opts:_ `any` - (Optional) additional information about the security group
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityGroupEntry>` - [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)<SecurityGroupEntry>
|
||||
- **updateSecurityMark**(securityGroupId: `string`, securityMarkId: `string`, input: `SecurityMarkBody`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkEntry>`<br/>
|
||||
Updates Security Mark value
|
||||
- _securityGroupId:_ `string` - The key for the security group id.
|
||||
- _securityMarkId:_ `string` - The key for the security mark is in use or not.
|
||||
- _input:_ `SecurityMarkBody` - securityMarkBody.
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<SecurityMarkEntry>` - [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)<SecurityMarkEntry>
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- |--------------------------|
|
||||
| groupsPaginated$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityControlsGroupResponse>` | Current paginated groups. |
|
||||
| marksPaginated$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<SecurityControlsMarkResponse>` | Current paginated marks. |
|
||||
| reloadSecurityControls$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` | |
|
||||
| reloadAuthorityClearance$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` | |
|
||||
| loading$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` | Current loading state. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| groupsPaginated$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SecurityControlsGroupResponse`](../../../lib/content-services/src/lib/security/services/models/security-controls-group-response.interface.ts)`>` | Current paginated groups. |
|
||||
| marksPaginated$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SecurityControlsMarkResponse`](../../../lib/content-services/src/lib/security/services/models/security-controls-mark-response.interface.ts)`>` | Current paginated marks. |
|
||||
| reloadSecurityControls$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` | |
|
||||
| reloadAuthorityClearance$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` | |
|
||||
| loading$ | [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` | Current loading state. |
|
||||
|
||||
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2018-11-13
|
||||
---
|
||||
|
||||
# [Sites service](lib/content-services/src/lib/common/services/sites.service.ts "Defined in sites.service.ts")
|
||||
# [Sites service](../../../lib/content-services/src/lib/common/services/sites.service.ts "Defined in sites.service.ts")
|
||||
|
||||
Accesses and manipulates sites from a Content Services repository.
|
||||
|
||||
|
||||
@@ -22,6 +22,10 @@ Adds and retrieves comments for task and process instances in Process Services.
|
||||
Gets all comments that have been added to a task.
|
||||
- _id:_ `string` - ID of the target task
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>` - Details for each comment
|
||||
- **getUserImage**(user: [`UserProcessModel`](../../core/models/user-process.model.md)): `string`<br/>
|
||||
|
||||
- _user:_ [`UserProcessModel`](../../core/models/user-process.model.md) -
|
||||
- **Returns** `string` -
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
Reference in New Issue
Block a user