RetentionService
injectable
Service to manage retention for DMS objects. This service allows to set retention for objects and revert retention if necessary/possible.
Methods
Section titled “Methods”getRetentionState
Section titled “getRetentionState”getRetentionState(dmsObject: DmsObject): RetentionStateArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| dmsObject | DmsObject |
setRetention
Section titled “setRetention”Set retention for given objects. This will add the retention SOT to the objects and set the retention start and end date. If the retetion start date is in the future, you can revert the retention until then by calling revertRetention. marker and has no effect on the object lifecycle.
setRetention(dmsObjects: DmsObject[], retentionStart: Date, retentionEnd: Date, destructionDate: Date): Observable<DmsObject[]>Arguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| dmsObjects | DmsObject[] | |
| retentionStart | Date | |
| retentionEnd | Date | |
| destructionDate | Date |