DBSHARINGGetFileMetadataIndividualResult

Objective-C

@interface DBSHARINGGetFileMetadataIndividualResult
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGGetFileMetadataIndividualResult : NSObject, DBSerializable, NSCopying

The GetFileMetadataIndividualResult 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) DBSHARINGGetFileMetadataIndividualResultTag tag;

Swift

var tag: DBSHARINGGetFileMetadataIndividualResultTag { get }

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

@property (nonatomic, readonly) DBSHARINGSharedFileMetadata *_Nonnull metadata;
Swift

var metadata: DBSHARINGSharedFileMetadata { get }
accessError
The result 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


                    
                    
                    -initWithMetadata:

Initializes union class with tag state of “metadata”.

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

Declaration

Objective-C

- (nonnull instancetype)initWithMetadata:
    (nonnull DBSHARINGSharedFileMetadata *)metadata;

Swift

init(metadata: DBSHARINGSharedFileMetadata)

Parameters


                                metadata

The result 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 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 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

-isMetadata
Retrieves whether the union’s current tag state has value “metadata”.

Note

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

- (BOOL)isMetadata;
Swift

func isMetadata() -> Bool
Return Value

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