DBRequestPathRootError

Objective-C

@interface DBRequestPathRootError : DBRequestHttpError

Swift

class DBRequestPathRootError : DBRequestHttpError

Path Root request error.

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


                    
                    
                    structuredPathRootError

The structured object returned by the Dropbox API in the event of a 422 path root error.

Declaration

Objective-C

@property (nonatomic, readonly) DBCOMMONPathRootError *_Nonnull structuredPathRootError;

Swift

var structuredPathRootError: DBCOMMONPathRootError { get }


                    
                    
                    -init:statusCode:errorContent:userMessage:structuredPathRootError:

DBRequestPathRootError full constructor.

Declaration

Objective-C

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

Swift

init(_ requestId: String, statusCode: NSNumber, errorContent: String, userMessage: DBLocalizedUserMessage?, structuredPathRootError: DBCOMMONPathRootError)

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.
`structuredPathRootError`	The structured object returned by the Dropbox API in the event of a 422 path root error.

Return Value

An initialized DBRequestPathRootError instance.

-description
Description method.
Declaration
Objective-C

- (nonnull NSString *)description;
Swift

func description() -> String
Return Value

A human-readable representation of the current DBRequestAccessError object.