DBSHARINGJobError

Objective-C

@interface DBSHARINGJobError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGJobError : NSObject, DBSerializable, NSCopying

The JobError union.

Error occurred while performing an asynchronous job from unshareFolder or removeFolderMember.

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) DBSHARINGJobErrorTag tag;

Swift

var tag: DBSHARINGJobErrorTag { get }

unshareFolderError
Error occurred while performing unshareFolder action. - note: Ensure the isUnshareFolderError method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBSHARINGUnshareFolderError *_Nonnull unshareFolderError;
Swift

var unshareFolderError: DBSHARINGUnshareFolderError { get }
removeFolderMemberError
Error occurred while performing removeFolderMember action. - note: Ensure the isRemoveFolderMemberError method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBSHARINGRemoveFolderMemberError *_Nonnull removeFolderMemberError;
Swift

var removeFolderMemberError: DBSHARINGRemoveFolderMemberError { get }
relinquishFolderMembershipError
Error occurred while performing relinquishFolderMembership action. @note Ensure the isRelinquishFolderMembershipError method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBSHARINGRelinquishFolderMembershipError *_Nonnull relinquishFolderMembershipError;
Swift

var relinquishFolderMembershipError: DBSHARINGRelinquishFolderMembershipError { get }

Constructors


                    
                    
                    -initWithUnshareFolderError:

Initializes union class with tag state of “unshare_folder_error”.

Description of the “unshare_folder_error” tag state: Error occurred while performing unshareFolder action.

Declaration

Objective-C

- (nonnull instancetype)initWithUnshareFolderError:
    (nonnull DBSHARINGUnshareFolderError *)unshareFolderError;

Swift

init(unshareFolderError: DBSHARINGUnshareFolderError)

Parameters


                                unshareFolderError

Error occurred while performing unshareFolder action.

Return Value

An initialized instance.


                    
                    
                    -initWithRemoveFolderMemberError:

Initializes union class with tag state of “remove_folder_member_error”.

Description of the “remove_folder_member_error” tag state: Error occurred while performing removeFolderMember action.

Declaration

Objective-C

- (nonnull instancetype)initWithRemoveFolderMemberError:
    (nonnull DBSHARINGRemoveFolderMemberError *)removeFolderMemberError;

Swift

init(removeFolderMemberError: DBSHARINGRemoveFolderMemberError)

Parameters


                                removeFolderMemberError

Error occurred while performing removeFolderMember action.

Return Value

An initialized instance.


                    
                    
                    -initWithRelinquishFolderMembershipError:

Initializes union class with tag state of “relinquish_folder_membership_error”.

Description of the “relinquish_folder_membership_error” tag state: Error occurred while performing relinquishFolderMembership action.

Declaration

Objective-C

- (nonnull instancetype)initWithRelinquishFolderMembershipError:
    (nonnull DBSHARINGRelinquishFolderMembershipError *)
        relinquishFolderMembershipError;

Swift

init(relinquishFolderMembershipError: DBSHARINGRelinquishFolderMembershipError)

Parameters


                                relinquishFolderMembershipError

Error occurred while performing relinquishFolderMembership action.

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

-isUnshareFolderError
Retrieves whether the union’s current tag state has value “unshare_folder_error”.

Note

Call this method and ensure it returns true before accessing the unshareFolderError property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isUnshareFolderError;
Swift

func isUnshareFolderError() -> Bool
Return Value

Whether the union’s current tag state has value “unshare_folder_error”.
-isRemoveFolderMemberError
Retrieves whether the union’s current tag state has value “remove_folder_member_error”.

Note

Call this method and ensure it returns true before accessing the removeFolderMemberError property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isRemoveFolderMemberError;
Swift

func isRemoveFolderMemberError() -> Bool
Return Value

Whether the union’s current tag state has value “remove_folder_member_error”.
-isRelinquishFolderMembershipError
Retrieves whether the union’s current tag state has value “relinquish_folder_membership_error”.

Note

Call this method and ensure it returns true before accessing the relinquishFolderMembershipError property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isRelinquishFolderMembershipError;
Swift

func isRelinquishFolderMembershipError() -> Bool
Return Value

Whether the union’s current tag state has value “relinquish_folder_membership_error”.
-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.