MPDataSetCacheItem Class Reference

#include <MPDataSetCacheItem.h>

Inheritance diagram for MPDataSetCacheItem:

Instance Methods
(instancetype)	- initWithId:

Properties
NSString *	cachingItemId
NSString *	name
NSString *	language
MPDataSetCachingStrategy	cachingStrategy
MPDataSetCacheScope	cachingScope
BOOL	isCached
BOOL	isSyncing
NSDate *	cachedTimestamp
NSUInteger	cachedSize
NSDate *	syncTimestamp
NSError *	syncResult
NSUInteger	syncSize

Detailed Description

Data set cache item class.

Method Documentation

initWithId:

- (instancetype) initWithId:

(NSString *)

itemId

Initialise a data set cache item with an id.

Parameters

itemId

Item id.

Property Documentation

cachedSize

- (NSUInteger) cachedSize

readnonatomicassign

Disk size in bytes for the currently cached content of this cache item.

cachedTimestamp

- (NSDate*) cachedTimestamp

readnonatomicstrong

Date of last successfull caching performed for this cache item.

cachingItemId

- (NSString*) cachingItemId

readnonatomicstrong

Cache item id.

cachingScope

- (MPDataSetCacheScope) cachingScope

readnonatomicassign

Cache scope for this cache item.

cachingStrategy

- (MPDataSetCachingStrategy) cachingStrategy

readnonatomicassign

Caching strategy for this cache item.

isCached

- (BOOL) isCached

readnonatomicassign

Cache state. If true, content is cached for this cache item.

isSyncing

- (BOOL) isSyncing

readnonatomicassign

If true, content is going to be synchronised. Synchronisation state. If true, content is currently being synchronised for this cache item.

language

- (NSString*) language

readnonatomicstrong

Cache item content language.

name

- (NSString*) name

readnonatomicstrong

Cache item name.

syncResult

- (NSError*) syncResult

readnonatomicstrong

Latest synchronisation result as an error object. If nil, either no synchronisation has been performed or latest synchronisation was successful.

syncSize

- (NSUInteger) syncSize

readnonatomicassign

Estimated possible synchronization size, if no content has been synchronised yet for this cache item.

syncTimestamp

- (NSDate*) syncTimestamp

readnonatomicstrong

Date of last content synchronisation performed for this cache item. Note this does not indicate success or failure, just that a synchronization finished at a certain point in time.