DBTEAMLegalHoldPolicy

Objective-C

@interface DBTEAMLegalHoldPolicy : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLegalHoldPolicy : NSObject, DBSerializable, NSCopying

The LegalHoldPolicy struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • id_

    The legal hold id.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull id_;

    Swift

    var id_: String { get }
  • Policy name.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull name;

    Swift

    var name: String { get }
  • A description of the legal hold policy.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *description_;

    Swift

    var description_: String? { get }
  • The time at which the legal hold was activated.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDate *activationTime;

    Swift

    var activationTime: Date? { get }
  • Team members IDs and number of permanently deleted members under hold.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMMembersInfo *_Nonnull members;

    Swift

    var members: DBTEAMMembersInfo { get }
  • The current state of the hold.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMLegalHoldStatus *_Nonnull status;

    Swift

    var status: DBTEAMLegalHoldStatus { get }
  • Start date of the legal hold policy.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull startDate;

    Swift

    var startDate: Date { get }
  • End date of the legal hold policy.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDate *endDate;

    Swift

    var endDate: Date? { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithId_:(nonnull NSString *)id_
                                   name:(nonnull NSString *)name
                                members:(nonnull DBTEAMMembersInfo *)members
                                 status:(nonnull DBTEAMLegalHoldStatus *)status
                              startDate:(nonnull NSDate *)startDate
                           description_:(nullable NSString *)description_
                         activationTime:(nullable NSDate *)activationTime
                                endDate:(nullable NSDate *)endDate;

    Swift

    init(id_: String, name: String, members: DBTEAMMembersInfo, status: DBTEAMLegalHoldStatus, start startDate: Date, description_: String?, activationTime: Date?, end endDate: Date?)

    Parameters

    id_

    The legal hold id.

    name

    Policy name.

    members

    Team members IDs and number of permanently deleted members under hold.

    status

    The current state of the hold.

    startDate

    Start date of the legal hold policy.

    description_

    A description of the legal hold policy.

    activationTime

    The time at which the legal hold was activated.

    endDate

    End date of the legal hold policy.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithId_:(nonnull NSString *)id_
                                   name:(nonnull NSString *)name
                                members:(nonnull DBTEAMMembersInfo *)members
                                 status:(nonnull DBTEAMLegalHoldStatus *)status
                              startDate:(nonnull NSDate *)startDate;

    Swift

    init(id_: String, name: String, members: DBTEAMMembersInfo, status: DBTEAMLegalHoldStatus, start startDate: Date)

    Parameters

    id_

    The legal hold id.

    name

    Policy name.

    members

    Team members IDs and number of permanently deleted members under hold.

    status

    The current state of the hold.

    startDate

    Start date of the legal hold policy.

    Return Value

    An initialized instance.