DBSHARINGSharePathError

Objective-C

@interface DBSHARINGSharePathError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGSharePathError : NSObject, DBSerializable, NSCopying

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

Constructors

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

    Description of the “is_file” tag state: A file is at the specified path.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIsFile;

    Swift

    init(isFile: ())

    Return Value

    An initialized instance.

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

    Description of the “inside_shared_folder” tag state: We do not support sharing a folder inside a shared folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsideSharedFolder;

    Swift

    init(insideSharedFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “contains_shared_folder” tag state: We do not support shared folders that contain shared folders.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithContainsSharedFolder;

    Swift

    init(containsSharedFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “contains_app_folder” tag state: We do not support shared folders that contain app folders.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithContainsAppFolder;

    Swift

    init(containsAppFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “contains_team_folder” tag state: We do not support shared folders that contain team folders.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithContainsTeamFolder;

    Swift

    init(containsTeamFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “is_app_folder” tag state: We do not support sharing an app folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIsAppFolder;

    Swift

    init(isAppFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “inside_app_folder” tag state: We do not support sharing a folder inside an app folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsideAppFolder;

    Swift

    init(insideAppFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “is_public_folder” tag state: A public folder can’t be shared this way. Use a public link instead.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIsPublicFolder;

    Swift

    init(isPublicFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “inside_public_folder” tag state: A folder inside a public folder can’t be shared this way. Use a public link instead.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsidePublicFolder;

    Swift

    init(insidePublicFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “already_shared” tag state: Folder is already shared. Contains metadata about the existing shared folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAlreadyShared:
    (nonnull DBSHARINGSharedFolderMetadata *)alreadyShared;

    Swift

    init(alreadyShared: DBSHARINGSharedFolderMetadata)

    Parameters

    alreadyShared

    Folder is already shared. Contains metadata about the existing shared folder.

    Return Value

    An initialized instance.

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

    Description of the “invalid_path” tag state: Path is not valid.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidPath;

    Swift

    init(invalidPath: ())

    Return Value

    An initialized instance.

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

    Description of the “is_osx_package” tag state: We do not support sharing a Mac OS X package.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIsOsxPackage;

    Swift

    init(isOsxPackage: ())

    Return Value

    An initialized instance.

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

    Description of the “inside_osx_package” tag state: We do not support sharing a folder inside a Mac OS X package.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsideOsxPackage;

    Swift

    init(insideOsxPackage: ())

    Return Value

    An initialized instance.

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

    Description of the “is_vault” tag state: We do not support sharing the Vault folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIsVault;

    Swift

    init(isVault: ())

    Return Value

    An initialized instance.

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

    Description of the “is_vault_locked” tag state: We do not support sharing a folder inside a locked Vault.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIsVaultLocked;

    Swift

    init(isVaultLocked: ())

    Return Value

    An initialized instance.

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

    Description of the “is_family” tag state: We do not support sharing the Family folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIsFamily;

    Swift

    init(isFamily: ())

    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 “is_file”.

    Declaration

    Objective-C

    - (BOOL)isIsFile;

    Swift

    func isIsFile() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInsideSharedFolder;

    Swift

    func isInsideSharedFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isContainsSharedFolder;

    Swift

    func isContainsSharedFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isContainsAppFolder;

    Swift

    func isContainsAppFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isContainsTeamFolder;

    Swift

    func isContainsTeamFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isIsAppFolder;

    Swift

    func isIsAppFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInsideAppFolder;

    Swift

    func isInsideAppFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isIsPublicFolder;

    Swift

    func isIsPublicFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInsidePublicFolder;

    Swift

    func isInsidePublicFolder() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isAlreadyShared;

    Swift

    func isAlreadyShared() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInvalidPath;

    Swift

    func isInvalidPath() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isIsOsxPackage;

    Swift

    func isIsOsxPackage() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInsideOsxPackage;

    Swift

    func isInsideOsxPackage() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isIsVault;

    Swift

    func isIsVault() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isIsVaultLocked;

    Swift

    func isIsVaultLocked() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isIsFamily;

    Swift

    func isIsFamily() -> Bool

    Return Value

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

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