DBSHARINGRelinquishFolderMembershipError
Objective-C
@interface DBSHARINGRelinquishFolderMembershipError
: NSObject <DBSerializable, NSCopying>
Swift
class DBSHARINGRelinquishFolderMembershipError : NSObject, DBSerializable, NSCopying
The RelinquishFolderMembershipError
union.
This class implements the DBSerializable
protocol (serialize and
deserialize instance methods), which is required for all Obj-C SDK API route
objects.
-
Represents the union’s current tag state.
Declaration
Objective-C
@property (nonatomic, readonly) DBSHARINGRelinquishFolderMembershipErrorTag tag;
Swift
var tag: DBSHARINGRelinquishFolderMembershipErrorTag { get }
-
(no description). - note: Ensure the
isAccessError
method returns true before accessing, otherwise a runtime exception will be raised.Declaration
Objective-C
@property (nonatomic, readonly) DBSHARINGSharedFolderAccessError *_Nonnull accessError;
Swift
var accessError: DBSHARINGSharedFolderAccessError { get }
-
Initializes union class with tag state of “access_error”.
Declaration
Objective-C
- (nonnull instancetype)initWithAccessError: (nonnull DBSHARINGSharedFolderAccessError *)accessError;
Swift
init(accessError: DBSHARINGSharedFolderAccessError)
Parameters
accessError
(no description).
Return Value
An initialized instance.
-
Initializes union class with tag state of “folder_owner”.
Description of the “folder_owner” tag state: The current user is the owner of the shared folder. Owners cannot relinquish membership to their own folders. Try unsharing or transferring ownership first.
Declaration
Objective-C
- (nonnull instancetype)initWithFolderOwner;
Swift
init(folderOwner: ())
Return Value
An initialized instance.
-
Initializes union class with tag state of “mounted”.
Description of the “mounted” tag state: The shared folder is currently mounted. Unmount the shared folder before relinquishing membership.
Declaration
Objective-C
- (nonnull instancetype)initWithMounted;
Swift
init(mounted: ())
Return Value
An initialized instance.
-
Initializes union class with tag state of “group_access”.
Description of the “group_access” tag state: The current user has access to the shared folder via a group. You can’t relinquish membership to folders shared via groups.
Declaration
Objective-C
- (nonnull instancetype)initWithGroupAccess;
Swift
init(groupAccess: ())
Return Value
An initialized instance.
-
Initializes union class with tag state of “team_folder”.
Description of the “team_folder” tag state: This action cannot be performed on a team shared folder.
Declaration
Objective-C
- (nonnull instancetype)initWithTeamFolder;
Swift
init(teamFolder: ())
Return Value
An initialized instance.
-
Initializes union class with tag state of “no_permission”.
Description of the “no_permission” tag state: The current user does not have permission to perform this action.
Declaration
Objective-C
- (nonnull instancetype)initWithNoPermission;
Swift
init(noPermission: ())
Return Value
An initialized instance.
-
Initializes union class with tag state of “no_explicit_access”.
Description of the “no_explicit_access” tag state: The current user only has inherited access to the shared folder. You can’t relinquish inherited membership to folders.
Declaration
Objective-C
- (nonnull instancetype)initWithNoExplicitAccess;
Swift
init(noExplicitAccess: ())
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.
-
Retrieves whether the union’s current tag state has value “access_error”.
Note
Call this method and ensure it returns true before accessing the
accessError
property, otherwise a runtime exception will be thrown.Declaration
Objective-C
- (BOOL)isAccessError;
Swift
func isAccessError() -> Bool
Return Value
Whether the union’s current tag state has value “access_error”.
-
Retrieves whether the union’s current tag state has value “folder_owner”.
Declaration
Objective-C
- (BOOL)isFolderOwner;
Swift
func isFolderOwner() -> Bool
Return Value
Whether the union’s current tag state has value “folder_owner”.
-
Retrieves whether the union’s current tag state has value “mounted”.
Declaration
Objective-C
- (BOOL)isMounted;
Swift
func isMounted() -> Bool
Return Value
Whether the union’s current tag state has value “mounted”.
-
Retrieves whether the union’s current tag state has value “group_access”.
Declaration
Objective-C
- (BOOL)isGroupAccess;
Swift
func isGroupAccess() -> Bool
Return Value
Whether the union’s current tag state has value “group_access”.
-
Retrieves whether the union’s current tag state has value “team_folder”.
Declaration
Objective-C
- (BOOL)isTeamFolder;
Swift
func isTeamFolder() -> Bool
Return Value
Whether the union’s current tag state has value “team_folder”.
-
Retrieves whether the union’s current tag state has value “no_permission”.
Declaration
Objective-C
- (BOOL)isNoPermission;
Swift
func isNoPermission() -> Bool
Return Value
Whether the union’s current tag state has value “no_permission”.
-
Retrieves whether the union’s current tag state has value “no_explicit_access”.
Declaration
Objective-C
- (BOOL)isNoExplicitAccess;
Swift
func isNoExplicitAccess() -> Bool
Return Value
Whether the union’s current tag state has value “no_explicit_access”.
-
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.