DBSHARINGFileAction

Objective-C

@interface DBSHARINGFileAction : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGFileAction : NSObject, DBSerializable, NSCopying

The FileAction union.

Sharing actions that may be taken on files.

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 “disable_viewer_info”.

    Description of the “disable_viewer_info” tag state: Disable viewer information on the file.

    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 file.

    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 file.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEnableViewerInfo;

    Swift

    init(enableViewerInfo: ())

    Return Value

    An initialized instance.

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

    Description of the “invite_viewer” tag state: Add a member with view permissions.

    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: Add a member with view permissions 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 “invite_editor”.

    Description of the “invite_editor” tag state: Add a member with edit permissions.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInviteEditor;

    Swift

    init(inviteEditor: ())

    Return Value

    An initialized instance.

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

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnshare;

    Swift

    init(unshare: ())

    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 to the file.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRelinquishMembership;

    Swift

    init(relinquishMembership: ())

    Return Value

    An initialized instance.

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

    Description of the “share_link” tag state: Use create_view_link and create_edit_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: Use create_view_link and create_edit_link instead.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCreateLink;

    Swift

    init(createLink: ())

    Return Value

    An initialized instance.

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

    Description of the “create_view_link” tag state: Create a shared link to a file that only allows users to view the content.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCreateViewLink;

    Swift

    init(createViewLink: ())

    Return Value

    An initialized instance.

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

    Description of the “create_edit_link” tag state: Create a shared link to a file that allows users to edit the content.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCreateEditLink;

    Swift

    init(createEditLink: ())

    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 “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_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 “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 “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 “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 “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 “create_view_link”.

    Declaration

    Objective-C

    - (BOOL)isCreateViewLink;

    Swift

    func isCreateViewLink() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isCreateEditLink;

    Swift

    func isCreateEditLink() -> Bool

    Return Value

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

  • 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.