DBTEAMLegalHoldsListHeldRevisionResult

Objective-C

@interface DBTEAMLegalHoldsListHeldRevisionResult
    : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLegalHoldsListHeldRevisionResult : NSObject, DBSerializable, NSCopying

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

  • List of file entries that under the hold.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBTEAMLegalHoldHeldRevisionMetadata *> *_Nonnull entries;

    Swift

    var entries: [DBTEAMLegalHoldHeldRevisionMetadata] { get }

  • The cursor idicates where to continue reading file metadata entries for the next API call. When there are no more entries, the cursor will return none. Pass the cursor into /2/team/legal_holds/list_held_revisions/continue.

    Declaration

    Objective-C

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

    Swift

    var cursor: String? { get }

  • True if there are more file entries that haven’t been returned. You can retrieve them with a call to /legal_holds/list_held_revisions_continue.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull hasMore;

    Swift

    var hasMore: NSNumber { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithEntries:
        (nonnull NSArray<DBTEAMLegalHoldHeldRevisionMetadata *> *)entries
            hasMore:(nonnull NSNumber *)hasMore
             cursor:(nullable NSString *)cursor;

    Swift

    init(entries: [DBTEAMLegalHoldHeldRevisionMetadata], hasMore: NSNumber, cursor: String?)

    Parameters

    entries

    List of file entries that under the hold.
    hasMore

    True if there are more file entries that haven’t been returned. You can retrieve them with a call to /legal_holds/list_held_revisions_continue.
    cursor

    The cursor idicates where to continue reading file metadata entries for the next API call. When there are no more entries, the cursor will return none. Pass the cursor into /2/team/legal_holds/list_held_revisions/continue.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithEntries:
        (nonnull NSArray<DBTEAMLegalHoldHeldRevisionMetadata *> *)entries
            hasMore:(nonnull NSNumber *)hasMore;

    Swift

    init(entries: [DBTEAMLegalHoldHeldRevisionMetadata], hasMore: NSNumber)

    Parameters

    entries

    List of file entries that under the hold.
    hasMore

    True if there are more file entries that haven’t been returned. You can retrieve them with a call to /legal_holds/list_held_revisions_continue.

    Return Value

    An initialized instance.