DBTEAMLegalHoldsPolicyCreateArg

Objective-C

@interface DBTEAMLegalHoldsPolicyCreateArg
    : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLegalHoldsPolicyCreateArg : NSObject, DBSerializable, NSCopying

The LegalHoldsPolicyCreateArg 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

  • 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 }

  • List of team member IDs added to the hold.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull members;

    Swift

    var members: [String] { get }

  • start date of the legal hold policy.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDate *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)initWithName:(nonnull NSString *)name
                             members:(nonnull NSArray<NSString *> *)members
                        description_:(nullable NSString *)description_
                           startDate:(nullable NSDate *)startDate
                             endDate:(nullable NSDate *)endDate;

    Swift

    init(name: String, members: [String], description_: String?, start startDate: Date?, end endDate: Date?)

    Parameters

    name

    Policy name.
    members

    List of team member IDs added to the hold.
    description_

    A description of the legal hold policy.
    startDate

    start date of the legal hold policy.
    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)initWithName:(nonnull NSString *)name
                             members:(nonnull NSArray<NSString *> *)members;

    Swift

    init(name: String, members: [String])

    Parameters

    name

    Policy name.
    members

    List of team member IDs added to the hold.

    Return Value

    An initialized instance.