DBSHARINGSharedLinkSettings

Objective-C

@interface DBSHARINGSharedLinkSettings : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGSharedLinkSettings : NSObject, DBSerializable, NSCopying

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

  • Boolean flag to enable or disable password protection.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *requirePassword;

    Swift

    var requirePassword: NSNumber? { get }
  • If requirePassword is true, this is needed to specify the password to access the link.

    Declaration

    Objective-C

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

    Swift

    var linkPassword: String? { get }
  • Expiration time of the shared link. By default the link won’t expire.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDate *expires;

    Swift

    var expires: Date? { get }
  • The new audience who can benefit from the access level specified by the link’s access level specified in the link_access_level field of LinkPermissions. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the effective_audience field of `LinkPermissions.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBSHARINGLinkAudience *audience;

    Swift

    var audience: DBSHARINGLinkAudience? { get }
  • Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBSHARINGRequestedLinkAccessLevel *access;

    Swift

    var access: DBSHARINGRequestedLinkAccessLevel? { get }
  • Use audience instead. The requested access for this shared link.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBSHARINGRequestedVisibility *requestedVisibility;

    Swift

    var requestedVisibility: DBSHARINGRequestedVisibility? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
        initWithRequirePassword:(nullable NSNumber *)requirePassword
                   linkPassword:(nullable NSString *)linkPassword
                        expires:(nullable NSDate *)expires
                       audience:(nullable DBSHARINGLinkAudience *)audience
                         access:(nullable DBSHARINGRequestedLinkAccessLevel *)access
            requestedVisibility:
                (nullable DBSHARINGRequestedVisibility *)requestedVisibility;

    Swift

    init(requirePassword: NSNumber?, linkPassword: String?, expires: Date?, audience: DBSHARINGLinkAudience?, access: DBSHARINGRequestedLinkAccessLevel?, requestedVisibility: DBSHARINGRequestedVisibility?)

    Parameters

    requirePassword

    Boolean flag to enable or disable password protection.

    linkPassword

    If requirePassword is true, this is needed to specify the password to access the link.

    expires

    Expiration time of the shared link. By default the link won’t expire.

    audience

    The new audience who can benefit from the access level specified by the link’s access level specified in the link_access_level field of LinkPermissions. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the effective_audience field of `LinkPermissions.

    access

    Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.

    requestedVisibility

    Use audience instead. The requested access for this shared link.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initDefault;

    Swift

    init(default: ())

    Return Value

    An initialized instance.