RetentionPolicy

public class RetentionPolicy : BoxModel

A retention policy blocks permanent deletion of content for a specified amount of time.

  • Declaration

    Swift

    public private(set) var rawData: [String : Any] { get }

  • Box item type

    Declaration

    Swift

    public var type: String
  • id

    Identifier

    Declaration

    Swift

    public let id: String

  • The name of the retention policy.

    Declaration

    Swift

    public let name: String?

  • The type of the retention policy based on whether the amount of time to retain content is known or unknown.

    Declaration

    Swift

    public let policyType: RetentionPolicyType?

  • The length of the retention policy. This length specifies the duration in days that the retention policy will be active for after being assigned to content.

    Declaration

    Swift

    public let retentionLength: Int?

  • The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    Declaration

    Swift

    public let dispositionAction: DispositionAction?

  • The status of the retention policy. Can be either active or retired. Once a policy has been retired, it cannot become active again.

    Declaration

    Swift

    public let status: RetentionPolicyStatus?

  • A mini user object representing the user that created the retention policy.

    Declaration

    Swift

    public let createdBy: User?

  • When the retention policy object was created.

    Declaration

    Swift

    public let createdAt: Date?

  • When the retention policy object was last modified.

    Declaration

    Swift

    public let modifiedAt: Date?

  • Wheter owner can extend time of retention policy.

    Declaration

    Swift

    public let canOwnerExtendRetention: Bool?

  • Whether owners are notified about retention policy changes.

    Declaration

    Swift

    public let areOwnersNotified: Bool?

  • Other users notified about retention policy changes.

    Declaration

    Swift

    public let customNotificationRecipients: [User]?

  • Specifies the retention type which can be modifiable or non-modifiable

    Declaration

    Swift

    public let retentionType: RetentionType?

  • Declaration

    Swift

    public required init(json: [String : Any]) throws