DBFILESListFolderError

Objective-C

@interface DBFILESListFolderError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESListFolderError : NSObject, DBSerializable, NSCopying

The ListFolderError 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) DBFILESListFolderErrorTag tag;

Swift

var tag: DBFILESListFolderErrorTag { get }

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

@property (nonatomic, readonly) DBFILESLookupError *_Nonnull path;
Swift

var path: DBFILESLookupError { get }
templateError
(no description). - note: Ensure the isTemplateError method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBFILEPROPERTIESTemplateError *_Nonnull templateError;
Swift

var templateError: DBFILEPROPERTIESTemplateError { get }

Constructors


                    
                    
                    -initWithPath:

Initializes union class with tag state of “path”.

Declaration

Objective-C

- (nonnull instancetype)initWithPath:(nonnull DBFILESLookupError *)path;

Swift

init(path: DBFILESLookupError)

Parameters


                                path

(no description).

Return Value

An initialized instance.


                    
                    
                    -initWithTemplateError:

Initializes union class with tag state of “template_error”.

Declaration

Objective-C

- (nonnull instancetype)initWithTemplateError:
    (nonnull DBFILEPROPERTIESTemplateError *)templateError;

Swift

init(templateError: DBFILEPROPERTIESTemplateError)

Parameters


                                templateError

(no description).

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

-isPath
Retrieves whether the union’s current tag state has value “path”.

Note

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

- (BOOL)isPath;
Swift

func isPath() -> Bool
Return Value

Whether the union’s current tag state has value “path”.
-isTemplateError
Retrieves whether the union’s current tag state has value “template_error”.

Note

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

- (BOOL)isTemplateError;
Swift

func isTemplateError() -> Bool
Return Value

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