DBFILESPathOrLink

Objective-C

@interface DBFILESPathOrLink : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESPathOrLink : NSObject, DBSerializable, NSCopying

The PathOrLink 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) DBFILESPathOrLinkTag tag;

    Swift

    var tag: DBFILESPathOrLinkTag { get }

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

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull path;

    Swift

    var path: String { get }

  • (no description). - note: Ensure the isLink method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESSharedLinkFileInfo *_Nonnull link;

    Swift

    var link: DBFILESSharedLinkFileInfo { get }

Constructors

  • Initializes union class with tag state of “path”.

    Declaration

    Objective-C

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

    Swift

    init(path: String)

    Parameters

    path

    (no description).

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “link”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLink:(nonnull DBFILESSharedLinkFileInfo *)link;

    Swift

    init(link: DBFILESSharedLinkFileInfo)

    Parameters

    link

    (no description).

    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.

Tag state methods

  • 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”.

  • Retrieves whether the union’s current tag state has value “link”.

    Note

    Call this method and ensure it returns true before accessing the link property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isLink;

    Swift

    func isLink() -> Bool

    Return Value

    Whether the union’s current tag state has value “link”.

  • 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.