DBSHARINGListSharedLinksResult

Objective-C

@interface DBSHARINGListSharedLinksResult : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGListSharedLinksResult : NSObject, DBSerializable, NSCopying

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

  • Shared links applicable to the path argument.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBSHARINGSharedLinkMetadata *> *_Nonnull links;

    Swift

    var links: [DBSHARINGSharedLinkMetadata] { get }

  • Is true if there are additional shared links that have not been returned yet. Pass the cursor into listSharedLinks to retrieve them.

    Declaration

    Objective-C

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

    Swift

    var hasMore: NSNumber { get }

  • Pass the cursor into listSharedLinks to obtain the additional links. Cursor is returned only if no path is given.

    Declaration

    Objective-C

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

    Swift

    var cursor: String? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithLinks:(nonnull NSArray<DBSHARINGSharedLinkMetadata *> *)links
          hasMore:(nonnull NSNumber *)hasMore
           cursor:(nullable NSString *)cursor;

    Swift

    init(links: [DBSHARINGSharedLinkMetadata], hasMore: NSNumber, cursor: String?)

    Parameters

    links

    Shared links applicable to the path argument.
    hasMore

    Is true if there are additional shared links that have not been returned yet. Pass the cursor into listSharedLinks to retrieve them.
    cursor

    Pass the cursor into listSharedLinks to obtain the additional links. Cursor is returned only if no path is given.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithLinks:(nonnull NSArray<DBSHARINGSharedLinkMetadata *> *)links
          hasMore:(nonnull NSNumber *)hasMore;

    Swift

    init(links: [DBSHARINGSharedLinkMetadata], hasMore: NSNumber)

    Parameters

    links

    Shared links applicable to the path argument.
    hasMore

    Is true if there are additional shared links that have not been returned yet. Pass the cursor into listSharedLinks to retrieve them.

    Return Value

    An initialized instance.