DBAUTHRateLimitReason

Objective-C

@interface DBAUTHRateLimitReason : NSObject <DBSerializable, NSCopying>

Swift

class DBAUTHRateLimitReason : NSObject, DBSerializable, NSCopying

The RateLimitReason 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 “too_many_requests”.

    Description of the “too_many_requests” tag state: You are making too many requests in the past few minutes.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyRequests;

    Swift

    init(tooManyRequests: ())

    Return Value

    An initialized instance.

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

    Description of the “too_many_write_operations” tag state: There are currently too many write operations happening in the user’s Dropbox.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyWriteOperations;

    Swift

    init(tooManyWriteOperations: ())

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

    Declaration

    Objective-C

    - (BOOL)isTooManyRequests;

    Swift

    func isTooManyRequests() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTooManyWriteOperations;

    Swift

    func isTooManyWriteOperations() -> Bool

    Return Value

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

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