DBFILESListFolderLongpollArg

Objective-C

@interface DBFILESListFolderLongpollArg : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESListFolderLongpollArg : NSObject, DBSerializable, NSCopying

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

  • A cursor as returned by listFolder or listFolderContinue. Cursors retrieved by setting includeMediaInfo in DBFILESListFolderArg to true are not supported.

    Declaration

    Objective-C

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

    Swift

    var cursor: String { get }

  • A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts.

    Declaration

    Objective-C

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

    Swift

    var timeout: NSNumber { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCursor:(nonnull NSString *)cursor
                               timeout:(nullable NSNumber *)timeout;

    Swift

    init(cursor: String, timeout: NSNumber?)

    Parameters

    cursor

    A cursor as returned by listFolder or listFolderContinue. Cursors retrieved by setting includeMediaInfo in DBFILESListFolderArg to true are not supported.
    timeout

    A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCursor:(nonnull NSString *)cursor;

    Swift

    init(cursor: String)

    Parameters

    cursor

    A cursor as returned by listFolder or listFolderContinue. Cursors retrieved by setting includeMediaInfo in DBFILESListFolderArg to true are not supported.

    Return Value

    An initialized instance.