DBSHARINGFileMemberRemoveActionResult
Objective-C
@interface DBSHARINGFileMemberRemoveActionResult
: NSObject <DBSerializable, NSCopying>
Swift
class DBSHARINGFileMemberRemoveActionResult : NSObject, DBSerializable, NSCopying
The FileMemberRemoveActionResult
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) DBSHARINGFileMemberRemoveActionResultTag tag;
Swift
var tag: DBSHARINGFileMemberRemoveActionResultTag { get }
-
Member was successfully removed from this file. - note: Ensure the
isSuccess
method returns true before accessing, otherwise a runtime exception will be raised.Declaration
Objective-C
@property (nonatomic, readonly) DBSHARINGMemberAccessLevelResult *_Nonnull success;
Swift
var success: DBSHARINGMemberAccessLevelResult { get }
-
User was not able to remove this member. - note: Ensure the
isMemberError
method returns true before accessing, otherwise a runtime exception will be raised.Declaration
Objective-C
@property (nonatomic, readonly) DBSHARINGFileMemberActionError *_Nonnull memberError;
Swift
var memberError: DBSHARINGFileMemberActionError { get }
-
Initializes union class with tag state of “success”.
Description of the “success” tag state: Member was successfully removed from this file.
Declaration
Objective-C
- (nonnull instancetype)initWithSuccess: (nonnull DBSHARINGMemberAccessLevelResult *)success;
Swift
init(success: DBSHARINGMemberAccessLevelResult)
Parameters
success
Member was successfully removed from this file.
Return Value
An initialized instance.
-
Initializes union class with tag state of “member_error”.
Description of the “member_error” tag state: User was not able to remove this member.
Declaration
Objective-C
- (nonnull instancetype)initWithMemberError: (nonnull DBSHARINGFileMemberActionError *)memberError;
Swift
init(memberError: DBSHARINGFileMemberActionError)
Parameters
memberError
User was not able to remove this member.
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 “success”.
Note
Call this method and ensure it returns true before accessing the
success
property, otherwise a runtime exception will be thrown.Declaration
Objective-C
- (BOOL)isSuccess;
Swift
func isSuccess() -> Bool
Return Value
Whether the union’s current tag state has value “success”.
-
Retrieves whether the union’s current tag state has value “member_error”.
Note
Call this method and ensure it returns true before accessing the
memberError
property, otherwise a runtime exception will be thrown.Declaration
Objective-C
- (BOOL)isMemberError;
Swift
func isMemberError() -> Bool
Return Value
Whether the union’s current tag state has value “member_error”.
-
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.