DBSHARINGListFileMembersIndividualResult

Objective-C

@interface DBSHARINGListFileMembersIndividualResult
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGListFileMembersIndividualResult : NSObject, DBSerializable, NSCopying

The ListFileMembersIndividualResult 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) DBSHARINGListFileMembersIndividualResultTag tag;

Swift

var tag: DBSHARINGListFileMembersIndividualResultTag { get }

result
The results of the query for this file if it was successful. - note: Ensure the isResult method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBSHARINGListFileMembersCountResult *_Nonnull result;
Swift

var result: DBSHARINGListFileMembersCountResult { get }
accessError
The result of the query for this file if it was an error. - 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


                    
                    
                    -initWithResult:

Initializes union class with tag state of “result”.

Description of the “result” tag state: The results of the query for this file if it was successful.

Declaration

Objective-C

- (nonnull instancetype)initWithResult:
    (nonnull DBSHARINGListFileMembersCountResult *)result;

Swift

init(result: DBSHARINGListFileMembersCountResult)

Parameters


                                result

The results of the query for this file if it was successful.

Return Value

An initialized instance.


                    
                    
                    -initWithAccessError:

Initializes union class with tag state of “access_error”.

Description of the “access_error” tag state: The result of the query for this file if it was an error.

Declaration

Objective-C

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

Swift

init(accessError: DBSHARINGSharingFileAccessError)

Parameters


                                accessError

The result of the query for this file if it was an error.

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

-isResult
Retrieves whether the union’s current tag state has value “result”.

Note

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

- (BOOL)isResult;
Swift

func isResult() -> Bool
Return Value

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