DBSHARINGFolderAction

Objective-C

@interface DBSHARINGFolderAction : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGFolderAction : NSObject, DBSerializable, NSCopying

The FolderAction union.

Actions that may be taken on shared folders.

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

Instance fields

Constructors

  • Initializes union class with tag state of “change_options”.

    Description of the “change_options” tag state: Change folder options, such as who can be invited to join the folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithChangeOptions;

    Swift

    init(changeOptions: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “disable_viewer_info”.

    Description of the “disable_viewer_info” tag state: Disable viewer information for this folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDisableViewerInfo;

    Swift

    init(disableViewerInfo: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “edit_contents”.

    Description of the “edit_contents” tag state: Change or edit contents of the folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEditContents;

    Swift

    init(editContents: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “enable_viewer_info”.

    Description of the “enable_viewer_info” tag state: Enable viewer information on the folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEnableViewerInfo;

    Swift

    init(enableViewerInfo: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “invite_editor”.

    Description of the “invite_editor” tag state: Invite a user or group to join the folder with read and write permission.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInviteEditor;

    Swift

    init(inviteEditor: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “invite_viewer”.

    Description of the “invite_viewer” tag state: Invite a user or group to join the folder with read permission.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInviteViewer;

    Swift

    init(inviteViewer: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “invite_viewer_no_comment”.

    Description of the “invite_viewer_no_comment” tag state: Invite a user or group to join the folder with read permission but no comment permissions.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInviteViewerNoComment;

    Swift

    init(inviteViewerNoComment: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “relinquish_membership”.

    Description of the “relinquish_membership” tag state: Relinquish one’s own membership in the folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRelinquishMembership;

    Swift

    init(relinquishMembership: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “unmount”.

    Description of the “unmount” tag state: Unmount the folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnmount;

    Swift

    init(unmount: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “unshare”.

    Description of the “unshare” tag state: Stop sharing this folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnshare;

    Swift

    init(unshare: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “leave_a_copy”.

    Description of the “leave_a_copy” tag state: Keep a copy of the contents upon leaving or being kicked from the folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLeaveACopy;

    Swift

    init(leaveACopy: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “share_link”.

    Description of the “share_link” tag state: Use create_link instead.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithShareLink;

    Swift

    init(shareLink: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “create_link”.

    Description of the “create_link” tag state: Create a shared link for folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCreateLink;

    Swift

    init(createLink: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “set_access_inheritance”.

    Description of the “set_access_inheritance” tag state: Set whether the folder inherits permissions from its parent.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSetAccessInheritance;

    Swift

    init(setAccessInheritance: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “other”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “change_options”.

    Declaration

    Objective-C

    - (BOOL)isChangeOptions;

    Swift

    func isChangeOptions() -> Bool

    Return Value

    Whether the union’s current tag state has value “change_options”.

  • Retrieves whether the union’s current tag state has value “disable_viewer_info”.

    Declaration

    Objective-C

    - (BOOL)isDisableViewerInfo;

    Swift

    func isDisableViewerInfo() -> Bool

    Return Value

    Whether the union’s current tag state has value “disable_viewer_info”.

  • Retrieves whether the union’s current tag state has value “edit_contents”.

    Declaration

    Objective-C

    - (BOOL)isEditContents;

    Swift

    func isEditContents() -> Bool

    Return Value

    Whether the union’s current tag state has value “edit_contents”.

  • Retrieves whether the union’s current tag state has value “enable_viewer_info”.

    Declaration

    Objective-C

    - (BOOL)isEnableViewerInfo;

    Swift

    func isEnableViewerInfo() -> Bool

    Return Value

    Whether the union’s current tag state has value “enable_viewer_info”.

  • Retrieves whether the union’s current tag state has value “invite_editor”.

    Declaration

    Objective-C

    - (BOOL)isInviteEditor;

    Swift

    func isInviteEditor() -> Bool

    Return Value

    Whether the union’s current tag state has value “invite_editor”.

  • Retrieves whether the union’s current tag state has value “invite_viewer”.

    Declaration

    Objective-C

    - (BOOL)isInviteViewer;

    Swift

    func isInviteViewer() -> Bool

    Return Value

    Whether the union’s current tag state has value “invite_viewer”.

  • Retrieves whether the union’s current tag state has value “invite_viewer_no_comment”.

    Declaration

    Objective-C

    - (BOOL)isInviteViewerNoComment;

    Swift

    func isInviteViewerNoComment() -> Bool

    Return Value

    Whether the union’s current tag state has value “invite_viewer_no_comment”.

  • Retrieves whether the union’s current tag state has value “relinquish_membership”.

    Declaration

    Objective-C

    - (BOOL)isRelinquishMembership;

    Swift

    func isRelinquishMembership() -> Bool

    Return Value

    Whether the union’s current tag state has value “relinquish_membership”.

  • Retrieves whether the union’s current tag state has value “unmount”.

    Declaration

    Objective-C

    - (BOOL)isUnmount;

    Swift

    func isUnmount() -> Bool

    Return Value

    Whether the union’s current tag state has value “unmount”.

  • Retrieves whether the union’s current tag state has value “unshare”.

    Declaration

    Objective-C

    - (BOOL)isUnshare;

    Swift

    func isUnshare() -> Bool

    Return Value

    Whether the union’s current tag state has value “unshare”.

  • Retrieves whether the union’s current tag state has value “leave_a_copy”.

    Declaration

    Objective-C

    - (BOOL)isLeaveACopy;

    Swift

    func isLeaveACopy() -> Bool

    Return Value

    Whether the union’s current tag state has value “leave_a_copy”.

  • Retrieves whether the union’s current tag state has value “share_link”.

    Declaration

    Objective-C

    - (BOOL)isShareLink;

    Swift

    func isShareLink() -> Bool

    Return Value

    Whether the union’s current tag state has value “share_link”.

  • Retrieves whether the union’s current tag state has value “create_link”.

    Declaration

    Objective-C

    - (BOOL)isCreateLink;

    Swift

    func isCreateLink() -> Bool

    Return Value

    Whether the union’s current tag state has value “create_link”.

  • Retrieves whether the union’s current tag state has value “set_access_inheritance”.

    Declaration

    Objective-C

    - (BOOL)isSetAccessInheritance;

    Swift

    func isSetAccessInheritance() -> Bool

    Return Value

    Whether the union’s current tag state has value “set_access_inheritance”.

  • Retrieves whether the union’s current tag state has value “other”.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value “other”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.