DBRequestAuthError

Objective-C

@interface DBRequestAuthError : DBRequestHttpError

Swift

class DBRequestAuthError : DBRequestHttpError

Auth request error.

Contains relevant information regarding a failed network request. Initialized in the event of an HTTP 401 response. Extends DBRequestHttpError.

  • The structured object returned by the Dropbox API in the event of a 401 auth error.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBAUTHAuthError *_Nonnull structuredAuthError;

    Swift

    var structuredAuthError: DBAUTHAuthError { get }

  • DBRequestAuthError full constructor.

    Declaration

    Objective-C

    - (nonnull instancetype)init:(nonnull NSString *)requestId
                  statusCode:(nonnull NSNumber *)statusCode
                errorContent:(nonnull NSString *)errorContent
                 userMessage:(nullable DBLocalizedUserMessage *)userMessage
         structuredAuthError:(nonnull DBAUTHAuthError *)structuredAuthError;

    Swift

    init(_ requestId: String, statusCode: NSNumber, errorContent: String, userMessage: DBLocalizedUserMessage?, structuredAuthError: DBAUTHAuthError)

    Parameters

    requestId

    The Dropbox request id of the network call. This is useful to Dropbox for debugging issues with Dropbox’s SDKs and API.
    statusCode

    The HTTP response status code of the request.
    errorContent

    A string representation of the error body received in the reponse. If for a route-specific error, this field will be the value of the “error_summary” key.
    userMessage

    An error message object that is optionally returned from some API endpoints.
    structuredAuthError

    The structured object returned by the Dropbox API in the event of a 401 auth error.

    Return Value

    An initialized DBRequestAuthError instance.

  • Description method.

    Declaration

    Objective-C

    - (nonnull NSString *)description;

    Swift

    func description() -> String

    Return Value

    A human-readable representation of the current DBRequestAuthError object.