DBSHARINGUpdateFolderPolicyArg

Objective-C

@interface DBSHARINGUpdateFolderPolicyArg : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGUpdateFolderPolicyArg : NSObject, DBSerializable, NSCopying

The UpdateFolderPolicyArg struct.

If any of the policies are unset, then they retain their current setting.

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

Instance fields


                    
                    
                    sharedFolderId

The ID for the shared folder.

Declaration

Objective-C

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

Swift

var sharedFolderId: String { get }


                    
                    
                    memberPolicy

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

Declaration

Objective-C

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

Swift

var memberPolicy: DBSHARINGMemberPolicy? { get }


                    
                    
                    aclUpdatePolicy

Who can add and remove members of this shared folder.

Declaration

Objective-C

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

Swift

var aclUpdatePolicy: DBSHARINGAclUpdatePolicy? { get }


                    
                    
                    viewerInfoPolicy

Who can enable/disable viewer info for this shared folder.

Declaration

Objective-C

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

Swift

var viewerInfoPolicy: DBSHARINGViewerInfoPolicy? { get }

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.
Declaration
Objective-C

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

var sharedLinkPolicy: DBSHARINGSharedLinkPolicy? { get }


                    
                    
                    linkSettings

Settings on the link for this folder.

Declaration

Objective-C

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

Swift

var linkSettings: DBSHARINGLinkSettings? { get }

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 }

Constructors


                    
                    
                    -initWithSharedFolderId:memberPolicy:aclUpdatePolicy:viewerInfoPolicy:sharedLinkPolicy:linkSettings:actions:

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

Declaration

Objective-C

- (nonnull instancetype)
    initWithSharedFolderId:(nonnull NSString *)sharedFolderId
              memberPolicy:(nullable DBSHARINGMemberPolicy *)memberPolicy
           aclUpdatePolicy:(nullable DBSHARINGAclUpdatePolicy *)aclUpdatePolicy
          viewerInfoPolicy:
              (nullable DBSHARINGViewerInfoPolicy *)viewerInfoPolicy
          sharedLinkPolicy:
              (nullable DBSHARINGSharedLinkPolicy *)sharedLinkPolicy
              linkSettings:(nullable DBSHARINGLinkSettings *)linkSettings
                   actions:(nullable NSArray<DBSHARINGFolderAction *> *)actions;

Swift

init(sharedFolderId: String, memberPolicy: DBSHARINGMemberPolicy?, aclUpdatePolicy: DBSHARINGAclUpdatePolicy?, viewerInfoPolicy: DBSHARINGViewerInfoPolicy?, sharedLinkPolicy: DBSHARINGSharedLinkPolicy?, linkSettings: DBSHARINGLinkSettings?, actions: [DBSHARINGFolderAction]?)

Parameters

`sharedFolderId`	The ID for the shared folder.
`memberPolicy`	Who can be a member of this shared folder. Only applicable if the current user is on a team.
`aclUpdatePolicy`	Who can add and remove members of this shared folder.
`viewerInfoPolicy`	Who can enable/disable viewer info for this shared folder.
`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`.
`linkSettings`	Settings on the link for this 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.

Return Value

An initialized instance.


                    
                    
                    -initWithSharedFolderId:

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

Declaration

Objective-C

- (nonnull instancetype)initWithSharedFolderId:
    (nonnull NSString *)sharedFolderId;

Swift

init(sharedFolderId: String)

Parameters


                                sharedFolderId

The ID for the shared folder.

Return Value

An initialized instance.