DBSHARINGListSharedLinksError

Objective-C

@interface DBSHARINGListSharedLinksError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGListSharedLinksError : NSObject, DBSerializable, NSCopying

The ListSharedLinksError 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) DBSHARINGListSharedLinksErrorTag tag;

Swift

var tag: DBSHARINGListSharedLinksErrorTag { 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 }

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.

-initWithReset
Initializes union class with tag state of “reset”.

Description of the “reset” tag state: Indicates that the cursor has been invalidated. Call listSharedLinks to obtain a new cursor.
Declaration
Objective-C

- (nonnull instancetype)initWithReset;
Swift

init(reset: ())
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”.
-isReset
Retrieves whether the union’s current tag state has value “reset”.
Declaration
Objective-C

- (BOOL)isReset;
Swift

func isReset() -> Bool
Return Value

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