DBRequestAccessError

Objective-C

@interface DBRequestAccessError : DBRequestHttpError

Swift

class DBRequestAccessError : DBRequestHttpError

Access request error.

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

  • The structured object returned by the Dropbox API in the event of a 403 access error.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBAUTHAccessError *_Nonnull structuredAccessError;

    Swift

    var structuredAccessError: DBAUTHAccessError { get }

  • DBRequestAccessError full constructor.

    Declaration

    Objective-C

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

    Swift

    init(_ requestId: String, statusCode: NSNumber, errorContent: String, userMessage: DBLocalizedUserMessage?, structuredAccessError: DBAUTHAccessError)

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

    The structured object returned by the Dropbox API in the event of a 403 access error.

    Return Value

    An initialized DBRequestAccessError instance.

  • Description method.

    Declaration

    Objective-C

    - (nonnull NSString *)description;

    Swift

    func description() -> String

    Return Value

    A human-readable representation of the current DBRequestAccessError object.