DITDocumentPath

@interface DITDocumentPath : NSObject

Provides an interface to specify a path to a key in a document that you can then call a function on to get the value at the specified key as a specific type. You obtain a DITDocumentPath by subscripting a DITDocument and you can then further subscript a DITDocumentPath to further specify the key of the document that you want to get the value of.

  • Used to specify a path to a key in the document that you can subscript further to access a nested key in the document.

    Declaration

    Objective-C

    - (nonnull DITDocumentPath *)objectForKeyedSubscript:(nonnull NSString *)key;

    Parameters

    key

    The next part of the path needed to get to the key in the document you wish to get the value of.

    Return Value

    The same DITDocumentPath object with the provided key incorporated into the document path.

  • Used to specify an index in the array at the preceding key-path specified through the subscripting defined previously. You can subscript the return value further to access a further nested key in the document.

    Declaration

    Objective-C

    - (nonnull DITDocumentPath *)objectAtIndexedSubscript:(NSUInteger)index;

    Parameters

    index

    The index of the array that you wish to access in the key previously specified with the preceding subscripting.

    Return Value

    The same DITDocumentPath object with the provided index incorporated into the document path.

  • Returns the value at the previously specified key in the document as an NSObject if possible, otherwise the return value will be nil.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) id value;

  • Returns the value at the previously specified key in the document as an NSString if possible, otherwise the return value will be nil.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *string;

  • Returns the value at the previously specified key in the document as an NSString. If the key was invalid the return value will be an empty string.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull stringValue;

  • Returns the value at the previously specified key in the document as a BOOL if possible, otherwise the return value will be nil.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) BOOL *boolean;

  • Returns the value at the previously specified key in the document as a BOOL. If the key was invalid the return value will be false.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL booleanValue;

  • Returns the value at the previously specified key in the document as an NSInteger if possible, otherwise the return value will be 0.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger integerValue;

  • Returns the value at the previously specified key in the document as an NSNumber if possible, otherwise the return value will be nil.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *number;

  • Returns the value at the previously specified key in the document as an NSNumber. If the key was invalid the return value will be an NSNumber with a value of 0.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull numberValue;

  • Returns the value at the previously specified key in the document as an NSArray if possible, otherwise the return value will be nil.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSArray *array;

  • Returns the value at the previously specified key in the document as an NSArray. If the key was invalid the return value will be an empty array.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray *_Nonnull arrayValue;

  • Returns the value at the previously specified key in the document as an NSDictionary if possible, otherwise the return value will be nil.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDictionary<NSString *, id> *dictionary;

  • Returns the value at the previously specified key in the document as an NSDictionary. If the key was invalid the return value will be an empty dictionary.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDictionary<NSString *, id> *_Nonnull dictionaryValue;

  • Returns the value at the previously specified key in the document as a DITAttachmentToken if possible, otherwise the return value will be nil.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DITAttachmentToken *attachmentToken;