DBFILESSharedLinkFileInfo

Objective-C

@interface DBFILESSharedLinkFileInfo : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSharedLinkFileInfo : NSObject, DBSerializable, NSCopying

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

    The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for.

    Declaration

    Objective-C

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

    Swift

    var url: String { get }

  • The path corresponding to a file in a shared link to a folder. Required for shared links to folders.

    Declaration

    Objective-C

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

    Swift

    var path: String? { get }

  • Password for the shared link. Required for password-protected shared links to files unless it can be read from a cookie.

    Declaration

    Objective-C

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

    Swift

    var password: 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
                           password:(nullable NSString *)password;

    Swift

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

    Parameters

    url

    The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for.
    path

    The path corresponding to a file in a shared link to a folder. Required for shared links to folders.
    password

    Password for the shared link. Required for password-protected shared links to files unless it can be read from a cookie.

    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

    The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for.

    Return Value

    An initialized instance.