DITUpdateResult Class Reference


                    
                    
                    type

The update result’s type.

Check this value before using one of asSet, asRemoved, asReplacedWithCounter, asIncremented, asPushed, or asPopped to ensure that you get the correct richer update result object.

Declaration

Objective-C

@property (nonatomic, readonly) DITUpdateResultType type;


                    
                    
                    docID

The ID of the document that was updated.

Declaration

Objective-C

@property (nonatomic, readonly) DITDocumentID *_Nonnull docID;


                    
                    
                    path

The path to the key in the document that was updated.

Declaration

Objective-C

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


                    
                    
                    -asSet

Return the update result object as a DITUpdateResultSet object.

Declaration

Objective-C

- (nullable DITUpdateResultSet *)asSet;

Return Value

A DITUpdateResultSet object or nil if the update result’s type is not set.


                    
                    
                    -asRemoved

Return the update result object as a DITUpdateResultRemoved object.

Declaration

Objective-C

- (nullable DITUpdateResultRemoved *)asRemoved;

Return Value

A DITUpdateResultRemoved object or nil if the update result’s type is not removed.


                    
                    
                    -asReplacedWithCounter

Return the update result object as a DITUpdateResultReplacedWithCounter object.

Declaration

Objective-C

- (nullable DITUpdateResultReplacedWithCounter *)asReplacedWithCounter;

Return Value

A DITUpdateResultReplacedWithCounter object or nil if the update result’s type is not replacedWithCounter.


                    
                    
                    -asIncremented

Return the update result object as a DITUpdateResultIncremented object.

Declaration

Objective-C

- (nullable DITUpdateResultIncremented *)asIncremented;

Return Value

A DITUpdateResultIncremented object or nil if the update result’s type is not incremented.


                    
                    
                    -asPushed

Return the update result object as a DITUpdateResultPushed object.

Declaration

Objective-C

- (nullable DITUpdateResultPushed *)asPushed;

Return Value

A DITUpdateResultPushed object or nil if the update result’s type is not pushed.


                    
                    
                    -asPopped

Return the update result object as a DITUpdateResultPopped object.

Declaration

Objective-C

- (nullable DITUpdateResultPopped *)asPopped;

Return Value

A DITUpdateResultPopped object or nil if the update result’s type is not popped.


                    
                    
                    -asInserted

Return the update result object as a DITUpdateResultInserted object.

Declaration

Objective-C

- (nullable DITUpdateResultInserted *)asInserted;

Return Value

A DITUpdateResultInserted object or nil if the update result’s type is not inserted.