DBTEAMCustomQuotaResult

Objective-C

@interface DBTEAMCustomQuotaResult : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMCustomQuotaResult : NSObject, DBSerializable, NSCopying

The CustomQuotaResult union.

User custom quota.

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) DBTEAMCustomQuotaResultTag tag;

Swift

var tag: DBTEAMCustomQuotaResultTag { get }

success
User’s custom quota. - note: Ensure the isSuccess method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBTEAMUserCustomQuotaResult *_Nonnull success;
Swift

var success: DBTEAMUserCustomQuotaResult { get }
invalidUser
Invalid user (not in team). - note: Ensure the isInvalidUser method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBTEAMUserSelectorArg *_Nonnull invalidUser;
Swift

var invalidUser: DBTEAMUserSelectorArg { get }

Constructors


                    
                    
                    -initWithSuccess:

Initializes union class with tag state of “success”.

Description of the “success” tag state: User’s custom quota.

Declaration

Objective-C

- (nonnull instancetype)initWithSuccess:
    (nonnull DBTEAMUserCustomQuotaResult *)success;

Swift

init(success: DBTEAMUserCustomQuotaResult)

Parameters


                                success

User’s custom quota.

Return Value

An initialized instance.


                    
                    
                    -initWithInvalidUser:

Initializes union class with tag state of “invalid_user”.

Description of the “invalid_user” tag state: Invalid user (not in team).

Declaration

Objective-C

- (nonnull instancetype)initWithInvalidUser:
    (nonnull DBTEAMUserSelectorArg *)invalidUser;

Swift

init(invalidUser: DBTEAMUserSelectorArg)

Parameters


                                invalidUser

Invalid user (not in team).

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

-isSuccess
Retrieves whether the union’s current tag state has value “success”.

Note

Call this method and ensure it returns true before accessing the success property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isSuccess;
Swift

func isSuccess() -> Bool
Return Value

Whether the union’s current tag state has value “success”.
-isInvalidUser
Retrieves whether the union’s current tag state has value “invalid_user”.

Note

Call this method and ensure it returns true before accessing the invalidUser property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isInvalidUser;
Swift

func isInvalidUser() -> Bool
Return Value

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