DBTEAMSharingAllowlistRemoveError

Objective-C

@interface DBTEAMSharingAllowlistRemoveError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMSharingAllowlistRemoveError : NSObject, DBSerializable, NSCopying

The SharingAllowlistRemoveError 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) DBTEAMSharingAllowlistRemoveErrorTag tag;

    Swift

    var tag: DBTEAMSharingAllowlistRemoveErrorTag { get }

  • One of provided values is not valid. - note: Ensure the isMalformedEntry method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var malformedEntry: String { get }

  • One or more provided values do not exist. - note: Ensure the isEntriesDoNotExist method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var entriesDoNotExist: String { get }

Constructors

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

    Description of the “malformed_entry” tag state: One of provided values is not valid.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMalformedEntry:
    (nonnull NSString *)malformedEntry;

    Swift

    init(malformedEntry: String)

    Parameters

    malformedEntry

    One of provided values is not valid.

    Return Value

    An initialized instance.

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

    Description of the “entries_do_not_exist” tag state: One or more provided values do not exist.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEntriesDoNotExist:
    (nonnull NSString *)entriesDoNotExist;

    Swift

    init(entriesDoNotExist: String)

    Parameters

    entriesDoNotExist

    One or more provided values do not exist.

    Return Value

    An initialized instance.

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

    Description of the “no_entries_provided” tag state: Neither single domain nor email provided.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNoEntriesProvided;

    Swift

    init(noEntriesProvided: ())

    Return Value

    An initialized instance.

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

    Description of the “too_many_entries_provided” tag state: Too many entries provided within one call.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyEntriesProvided;

    Swift

    init(tooManyEntriesProvided: ())

    Return Value

    An initialized instance.

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

    Description of the “unknown_error” tag state: Unknown error.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnknownError;

    Swift

    init(unknownError: ())

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isMalformedEntry;

    Swift

    func isMalformedEntry() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isEntriesDoNotExist;

    Swift

    func isEntriesDoNotExist() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isNoEntriesProvided;

    Swift

    func isNoEntriesProvided() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTooManyEntriesProvided;

    Swift

    func isTooManyEntriesProvided() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isUnknownError;

    Swift

    func isUnknownError() -> Bool

    Return Value

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

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