DBSHARINGShareFolderArgBase

@interface DBSHARINGShareFolderArgBase : NSObject <DBSerializable, NSCopying>

The ShareFolderArgBase struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

  • Who can add and remove members of this shared folder.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable)
        DBSHARINGAclUpdatePolicy *aclUpdatePolicy;

    Swift

    var aclUpdatePolicy: DBSHARINGAclUpdatePolicy? { get }
  • Whether to force the share to happen asynchronously.

    Declaration

    Objective-C

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

    Swift

    var forceAsync: NSNumber { get }
  • Who can be a member of this shared folder. Only applicable if the current user is on a team.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) DBSHARINGMemberPolicy *memberPolicy;

    Swift

    var memberPolicy: DBSHARINGMemberPolicy? { get }
  • The path to the folder to share. If it does not exist, then a new one is created.

    Declaration

    Objective-C

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

    Swift

    var path: String { get }
  • The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to members in DBSHARINGSharedLinkPolicy.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable)
        DBSHARINGSharedLinkPolicy *sharedLinkPolicy;

    Swift

    var sharedLinkPolicy: DBSHARINGSharedLinkPolicy? { get }
  • Who can enable/disable viewer info for this shared folder.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable)
        DBSHARINGViewerInfoPolicy *viewerInfoPolicy;

    Swift

    var viewerInfoPolicy: DBSHARINGViewerInfoPolicy? { get }
  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
        initWithPath:(nonnull NSString *)path
     aclUpdatePolicy:(nullable DBSHARINGAclUpdatePolicy *)aclUpdatePolicy
          forceAsync:(nullable NSNumber *)forceAsync
        memberPolicy:(nullable DBSHARINGMemberPolicy *)memberPolicy
    sharedLinkPolicy:(nullable DBSHARINGSharedLinkPolicy *)sharedLinkPolicy
    viewerInfoPolicy:(nullable DBSHARINGViewerInfoPolicy *)viewerInfoPolicy;

    Swift

    init(path: String, aclUpdatePolicy: DBSHARINGAclUpdatePolicy?, forceAsync: NSNumber?, memberPolicy: DBSHARINGMemberPolicy?, sharedLinkPolicy: DBSHARINGSharedLinkPolicy?, viewerInfoPolicy: DBSHARINGViewerInfoPolicy?)

    Parameters

    path

    The path to the folder to share. If it does not exist, then a new one is created.

    aclUpdatePolicy

    Who can add and remove members of this shared folder.

    forceAsync

    Whether to force the share to happen asynchronously.

    memberPolicy

    Who can be a member of this shared folder. Only applicable if the current user is on a team.

    sharedLinkPolicy

    The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to members in DBSHARINGSharedLinkPolicy.

    viewerInfoPolicy

    Who can enable/disable viewer info for this shared 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 the folder to share. If it does not exist, then a new one is created.

    Return Value

    An initialized instance.