DBSHARINGCreateSharedLinkArg

Objective-C

@interface DBSHARINGCreateSharedLinkArg : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGCreateSharedLinkArg : NSObject, DBSerializable, NSCopying

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

  • The path to share.

    Declaration

    Objective-C

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

    Swift

    var path: String { get }
  • Whether to return a shortened URL.

    Declaration

    Objective-C

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

    Swift

    var shortUrl: NSNumber { get }
  • If it’s okay to share a path that does not yet exist, set this to either file in DBSHARINGPendingUploadMode or folder in DBSHARINGPendingUploadMode to indicate whether to assume it’s a file or folder.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBSHARINGPendingUploadMode *pendingUpload;

    Swift

    var pendingUpload: DBSHARINGPendingUploadMode? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull NSString *)path
                                shortUrl:(nullable NSNumber *)shortUrl
                           pendingUpload:
                               (nullable DBSHARINGPendingUploadMode *)pendingUpload;

    Swift

    init(path: String, shortUrl: NSNumber?, pendingUpload: DBSHARINGPendingUploadMode?)

    Parameters

    path

    The path to share.

    shortUrl

    Whether to return a shortened URL.

    pendingUpload

    If it’s okay to share a path that does not yet exist, set this to either file in DBSHARINGPendingUploadMode or folder in DBSHARINGPendingUploadMode to indicate whether to assume it’s a file or folder.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull NSString *)path;

    Swift

    init(path: String)

    Parameters

    path

    The path to share.

    Return Value

    An initialized instance.