DBSHARINGGetSharedLinkMetadataArg

Objective-C

@interface DBSHARINGGetSharedLinkMetadataArg
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGGetSharedLinkMetadataArg : NSObject, DBSerializable, NSCopying

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

  • url

    URL of the shared link.

    Declaration

    Objective-C

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

    Swift

    var url: String { get }

  • If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.

    Declaration

    Objective-C

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

    Swift

    var path: String? { get }

  • If the shared link has a password, this parameter can be used.

    Declaration

    Objective-C

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

    Swift

    var linkPassword: String? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUrl:(nonnull NSString *)url
                               path:(nullable NSString *)path
                       linkPassword:(nullable NSString *)linkPassword;

    Swift

    init(url: String, path: String?, linkPassword: String?)

    Parameters

    url

    URL of the shared link.
    path

    If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
    linkPassword

    If the shared link has a password, this parameter can be used.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUrl:(nonnull NSString *)url;

    Swift

    init(url: String)

    Parameters

    url

    URL of the shared link.

    Return Value

    An initialized instance.