Inherits from NSObject
Conforms to NSCopying
Declared in DBPath.h

Overview

The path object represents a valid Dropbox path, and knows how to do correct path comparisons. It also has convenience methods for constructing new paths.

Tasks

  • + root

    The top-most folder in your app’s view of the user’s Dropbox.

  • – initWithString:

    Create a new path object from a string. Some special characters, names, or encodings a are not allowed in a Dropbox path. For more details see this article ).

  • – name

    The unqualified name of the file or folder at this path. For the root, this will return the same as stringValue.

  • – childPath:

    Create a new path by treating the current path as a path to a folder, and childName as the name of an item in that folder.

  • – parent

    Create a new path that is the folder containing the current path. For the root, this will return the same as stringValue.

  • – stringValue

    The fully qualified path (relative to the root) as a string, with original casing.

Class Methods

root

+ (DBPath *)root
Discussion

The top-most folder in your app’s view of the user’s Dropbox.

Declared In

DBPath.h

Instance Methods

childPath:

- (DBPath *)childPath:(NSString *)childName
Discussion

Create a new path by treating the current path as a path to a folder, and childName as the name of an item in that folder.

Return Value

A new path, or nil if childName is invalid.

Declared In

DBPath.h

initWithString:

- (id)initWithString:(NSString *)pathStr
Discussion

Create a new path object from a string. Some special characters, names, or encodings a are not allowed in a Dropbox path. For more details see this article ).

Return Value

A new path object if the contents of pathStr are a valid Dropbox path, nil otherwise.

Declared In

DBPath.h

name

- (NSString *)name
Discussion

The unqualified name of the file or folder at this path. For the root, this will return the same as stringValue.

Declared In

DBPath.h

parent

- (DBPath *)parent
Discussion

Create a new path that is the folder containing the current path. For the root, this will return the same as stringValue.

Return Value

A new path, or nil if path is already at the root.

Declared In

DBPath.h

stringValue

- (NSString *)stringValue
Discussion

The fully qualified path (relative to the root) as a string, with original casing.

Declared In

DBPath.h