From 874551dfe2d3fa5583adc1e8cc98f0ba185408fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Socha?= <31014760+lukaszsocha2@users.noreply.github.com> Date: Wed, 7 Sep 2022 08:36:41 +0200 Subject: [PATCH] docs: Documentation update for retention policy updates (#1094) --- doc/retention_policies.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/doc/retention_policies.md b/doc/retention_policies.md index 0de0ff905..388cdb3e3 100644 --- a/doc/retention_policies.md +++ b/doc/retention_policies.md @@ -6,7 +6,6 @@ A retention policy blocks permanent deletion of content for a specified amount o - - [Create Retention Policy](#create-retention-policy) - [Get Retention Policy](#get-retention-policy) - [Update Retention Policy](#update-retention-policy) @@ -14,10 +13,11 @@ A retention policy blocks permanent deletion of content for a specified amount o - [Get Retention Policy Assignments](#get-retention-policy-assignments) - [Create Retention Policy Assignment](#create-retention-policy-assignment) - [Get Retention Policy Assignment](#get-retention-policy-assignment) +- [Delete Retention Policy Assignment](#delete-retention-policy-assignment) - [Get File Version Retention](#get-file-version-retention) - [Get File Version Retentions](#get-file-version-retentions) (will be deprecated in the future, use [Get Files Under Retention For Assignment](#get-files-under-retention-for-assignment) and [Get File Version Under Retention For Assignment](#get-file-versions-under-retention-for-assignment) instead) - [Get Files Under Retention For Assignment](#get-files-under-retention-for-assignment) -- [Get File Version Under Retention For Assignment](#get-file-versions-under-retention-for-assignment) +- [Get File Versions Under Retention For Assignment](#get-file-versions-under-retention-for-assignment) - [Extend retention for a file](#extend-retention-for-a-file) @@ -195,6 +195,19 @@ BoxRetentionPolicyAssignment.Info assignmentInfo = assignment.getInfo("assigned_ [get-assignment]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicyAssignment.html#getInfo-java.lang.String...- [policy-assignment-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicyAssignment.Info.html +## Delete Retention Policy Assignment + +To delete Retention Policy Assignment call [`delete()`][delete-assignment] method. + + +```java +BoxRetentionPolicyAssignment assignment = new BoxRetentionPolicyAssignment(api, id); +assignment.delete(); +``` + +[delete-assignment]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicyAssignment.html#delete() + + ## Get File Version Retention Calling [`getInfo(String... fields)`][get-file-version-retention] will return a