DBFILESSyncSettingsError

@interface DBFILESSyncSettingsError : NSObject <DBSerializable, NSCopying>

The SyncSettingsError union.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

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

  • Initializes union class with tag state of unsupported_combination.

    Description of the unsupported_combination tag state: Setting this combination of sync settings simultaneously is not supported.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnsupportedCombination;

    Swift

    init(unsupportedCombination: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of unsupported_configuration.

    Description of the unsupported_configuration tag state: The specified configuration is not supported.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnsupportedConfiguration;

    Swift

    init(unsupportedConfiguration: ())

    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.

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

    Declaration

    Objective-C

    - (BOOL)isUnsupportedCombination;

    Swift

    func isUnsupportedCombination() -> Bool

    Return Value

    Whether the union’s current tag state has value unsupported_combination.

  • Retrieves whether the union’s current tag state has value unsupported_configuration.

    Declaration

    Objective-C

    - (BOOL)isUnsupportedConfiguration;

    Swift

    func isUnsupportedConfiguration() -> Bool

    Return Value

    Whether the union’s current tag state has value unsupported_configuration.

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