Obj-C API v2 Error Handling

billymeltdown

Hi folks, I find myself having more questions about error handling in the obj-c API v2. I keep going over the README and I am still unable to figure out where I should look for documentation on figuring out what's in a routeError and when I should look to it instead of (or in addition to) the error param in a response block.

 

For instance, create folder:

 

 

DropboxClient *client = [DropboxClientsManager authorizedClient];
if (client != nil) {
    [[client.filesRoutes createFolder:self.rootPath] 
    response:^(DBFILESFolderMetadata * _Nullable result, DBFILESCreateFolderError * _Nullable routeError, DBError * _Nullable error) {
        if (result != nil) {
            // Onward to the next step!
            [self doNextThing]
        } else {
            // Bummers? which bummers?
        }
    }];
}

 

Then I go to the documentation and lookup that route error type, DBFilesCreateFolderError, and that says it's "The CreateFolderError union." All I see there is "isPath". I don't see any methods mentioned in the error handling section of the README like isWriteError.

So, what's the process of figuring out what I should be looking for here, where do I look so that I don't have to ask here for every route? Sorry if that sounds melodramatic, I just want to do it right and understand where to look for the answers myself

 

Greg-DB

For each API call, you'll want to handle both the route error (for errors specific to that call) as well as the general error (for errors that can happen on any call).

 

For the route specific error for createFolder, which is DBFILESCreateFolderError, there is only the isPath case, since that error doesn't have any other scenarios. (The example in the README is for the delete call, which has a different set of possible route-specific errors, under DBFILESDeleteError.)

 

To see what is possible for any particular error, I recommend checking the Objective-C SDK documentation for that error type, e.g., DBFILESCreateFolderError, which lists just isPath. (You can look at the HTTP documenation, as you linked to, but the names won't always be exactly the same, as they get translated slightly for the SDK.)

 

So, if DBFILESCreateFolderError isPath is true, you can then access the DBFILESWriteError in it via the path field.

 

Here's a more elaborate sample for createFolder showing that:

 

        [[client.filesRoutes createFolder:@/test/path] response:^(DBFILESFolderMetadata *result, DBFILESCreateFolderError *routeError, DBError *error) {
            if (result) {
                NSLog(@%@\n", result);
            } else if (routeError) {
                NSLog(@%@\n", routeError);
                if ([routeError isPath]) {
                    if ([routeError.path isConflict]) {
                        if ([routeError.path.conflict isFolder]) {
                            NSLog(@Could not create folder because a folder already exists at path.);
                        } else {
                            // some other path conflict error:
                            NSLog(@%@\n", routeError.path.conflict);
                        }
                    } else if ([routeError.path isMalformedPath]) {
                        NSLog(@Could not create folder because the path is malformed.);
                    } else { // and so on for other errors as desired
                        // some other path error:
                        NSLog(@%@\n", routeError.path);
                    }
                }
            } else if (error) {
                NSLog(@%@\n", error);
            }
        }];