DBSHARINGShareFolderArg

Objective-C

@interface DBSHARINGShareFolderArg
    : DBSHARINGShareFolderArgBase <DBSerializable, NSCopying>

Swift

class DBSHARINGShareFolderArg : DBSHARINGShareFolderArgBase, DBSerializable, NSCopying

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

actions
A list of FolderActions corresponding to FolderPermissions that should appear in the response’s permissions in DBSHARINGSharedFolderMetadata field describing the actions the authenticated user can perform on the folder.
Declaration
Objective-C

@property (nonatomic, readonly, nullable) NSArray<DBSHARINGFolderAction *> *actions;
Swift

var actions: [DBSHARINGFolderAction]? { get }


                    
                    
                    linkSettings

Settings on the link for this folder.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) DBSHARINGLinkSettings *linkSettings;

Swift

var linkSettings: DBSHARINGLinkSettings? { get }

Constructors


                    
                    
                    -initWithPath:aclUpdatePolicy:forceAsync:memberPolicy:sharedLinkPolicy:viewerInfoPolicy:accessInheritance:actions:linkSettings:

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
    accessInheritance:(nullable DBSHARINGAccessInheritance *)accessInheritance
              actions:(nullable NSArray<DBSHARINGFolderAction *> *)actions
         linkSettings:(nullable DBSHARINGLinkSettings *)linkSettings;

Swift

init(path: String, aclUpdatePolicy: DBSHARINGAclUpdatePolicy?, forceAsync: NSNumber?, memberPolicy: DBSHARINGMemberPolicy?, sharedLinkPolicy: DBSHARINGSharedLinkPolicy?, viewerInfoPolicy: DBSHARINGViewerInfoPolicy?, accessInheritance: DBSHARINGAccessInheritance?, actions: [DBSHARINGFolderAction]?, linkSettings: DBSHARINGLinkSettings?)

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.
`accessInheritance`	The access inheritance settings for the folder.
`actions`	A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response’s `permissions` in `DBSHARINGSharedFolderMetadata` field describing the actions the authenticated user can perform on the folder.
`linkSettings`	Settings on the link for this folder.

Return Value

An initialized instance.


                    
                    
                    -initWithPath:

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.