DBSHARINGRelinquishFileMembershipError

Objective-C

@interface DBSHARINGRelinquishFileMembershipError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGRelinquishFileMembershipError : NSObject, DBSerializable, NSCopying

The RelinquishFileMembershipError union.

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

Instance fields

tag

Represents the union’s current tag state.

Declaration

Objective-C

@property (nonatomic, readonly) DBSHARINGRelinquishFileMembershipErrorTag tag;

Swift

var tag: DBSHARINGRelinquishFileMembershipErrorTag { get }

accessError
(no description). - note: Ensure the isAccessError method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBSHARINGSharingFileAccessError *_Nonnull accessError;
Swift

var accessError: DBSHARINGSharingFileAccessError { get }

Constructors


                    
                    
                    -initWithAccessError:

Initializes union class with tag state of “access_error”.

Declaration

Objective-C

- (nonnull instancetype)initWithAccessError:
    (nonnull DBSHARINGSharingFileAccessError *)accessError;

Swift

init(accessError: DBSHARINGSharingFileAccessError)

Parameters


                                accessError

(no description).

Return Value

An initialized instance.

-initWithGroupAccess
Initializes union class with tag state of “group_access”.

Description of the “group_access” tag state: The current user has access to the shared file via a group. You can’t relinquish membership to a file shared via groups.
Declaration
Objective-C

- (nonnull instancetype)initWithGroupAccess;
Swift

init(groupAccess: ())
Return Value

An initialized instance.
-initWithNoPermission
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.
-initWithOther
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

-isAccessError
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”.
-isGroupAccess
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”.
-isNoPermission
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”.
-isOther
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”.
-tagName
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.