Mobile API Reference
MicroStrategy 2019
|
#import <ReportStore.h>
Class Methods | |
(ReportStore *) | + getReportStore |
(void) | + resetReportStore |
(NSString *) | + reportsRootPath |
(void) | + performUpgradeCleanup |
(void) | + dropAllReportCaches:clearSubscribedReportInfo: |
(BOOL) | + clearOnClose |
(BOOL) | + isPredefinedCacheID: |
ReportStore holds reports that have been received from the server and can then be accessed locally.
- (NSInteger) addReport: | (MSIReportDisplayInfo *) | aReport | |
error: | (NSError **) | error | |
- (NSInteger) addReportCache: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
data: | (NSData *) | data | |
error: | (NSError **) | error | |
- (NSInteger) addReportCache: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
data: | (NSData *) | data | |
moveFileAtLocation: | (NSString *) | fileName | |
withServerCache: | (IServerCacheInfo *) | isci | |
error: | (NSError **) | error | |
- (NSInteger) addReportCache: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
data: | (NSData *) | data | |
moveFileAtLocation: | (NSString *) | fileName | |
withServerCache: | (IServerCacheInfo *) | isci | |
isBackground: | (BOOL) | background | |
error: | (NSError **) | error | |
- (NSInteger) addReportCache: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
moveFileAtLocation: | (NSString *) | fileName | |
error: | (NSError **) | error | |
- (NSArray*) allReportsCopy |
- (NSInteger) cacheSetSizeForReport: | (MSIReportDisplayInfo *) | report |
+ (BOOL) clearOnClose |
- (void) copyCacheSet: | (NSString *) | setID | |
forReport: | (MSIReportDisplayInfo *) | aReport | |
- (BOOL) datasetCacheExists: | (DataSetInfo *) | aDatasetInfo |
- (NSArray*) DatasetListCopyForProject: | (MSIProjectInfo *) | project |
- (MSIReportDisplayInfo*) deferExecReportCopyBySubscriptionID: | (NSString *) | subscriptionID | |
projectID: | (NSString *) | projectID | |
- (void) deleteDrillCaches |
- (NSInteger) deleteProjectCaches: | (MSIProjectInfo *) | project | |
error: | (NSError **) | error | |
- (NSInteger) deleteReport: | (MSIReportDisplayInfo *) | aReport | |
error: | (NSError **) | error | |
- (NSInteger) deleteReportCache: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
error: | (NSError **) | error | |
- (NSInteger) deleteReportCacheSet: | (NSString *) | cacheSetID | |
cacheRootID: | (NSString *) | cacheRootID | |
project: | (MSIProjectInfo *) | project | |
status: | (int) | status | |
error: | (NSError **) | error | |
- (NSInteger) deleteReportCacheSet: | (NSString *) | cacheSetID | |
cacheRootID: | (NSString *) | cacheRootID | |
project: | (MSIProjectInfo *) | project | |
status: | (int) | status | |
isBackground: | (BOOL) | background | |
error: | (NSError **) | error | |
+ (void) dropAllReportCaches: | (BOOL) | clearLiveReportInfo | |
clearSubscribedReportInfo: | (BOOL) | clearSubscribedReportInfo | |
When debugging reports, It can be useful to have them start fresh, with no cached info, prompt answers, etc. Use this method to clear out all the cahced info.
- (NSDictionary *) getCacheSetKeys: | (MSIReportDisplayInfo *) | aReport |
- (NSDictionary *) getCacheSetKeysForLinkDrill: | (MSIReportDisplayInfo *) | aReport | |
promptAnswer: | (NSString *) | promptAnswer | |
- (NSArray*) getLockedDocuments |
- (NSString *) getMappedCacheSetID: | (MSIReportDisplayInfo *) | aReport |
- (NSString*) getPath |
- (NSData*) getReportCache: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
- (NSData*) getReportCache: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
status: | (NSInteger *) | oStatus | |
- (NSString*) getReportCachePath: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
status: | (NSInteger *) | oStatus | |
- (NSString*) getReportCachePath: | (MSIReportDisplayInfo *) | document | |
cacheID: | (NSString *) | cacheID | |
status: | (NSInteger *) | oStatus | |
updated: | (BOOL) | isUpdated | |
+ (ReportStore*) getReportStore |
- (void) handlePromptQuestionUpdate: | (MSIReportDisplayInfo *) | aReport | |
data: | (NSData *) | data | |
- (BOOL) hasReportCache: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
- (void) initializeCacheSetMap |
- (NSInteger) invalidateReportCache: | (NSString *) | serverCacheID | |
cacheSet: | (NSString *) | cacheSetID | |
cacheRootID: | (NSString *) | cacheRootID | |
project: | (MSIProjectInfo *) | project | |
error: | (NSError **) | error | |
- (NSInteger) invalidateReportCache: | (MSIReportDisplayInfo *) | aReport | |
error: | (NSError **) | error | |
- (NSInteger) invalidateReportCacheSet: | (NSString *) | cacheSetID | |
cacheRootID: | (NSString *) | cacheRootID | |
project: | (MSIProjectInfo *) | project | |
error: | (NSError **) | error | |
- (BOOL) isFullyCached: | (NSString *) | subscriptionID | |
projectID: | (NSString *) | projectID | |
+ (BOOL) isPredefinedCacheID: | (NSString *) | cacheID |
- (BOOL) isSubscriptionReport: | (MSIReportDisplayInfo *) | report |
- (MSILiveReportInfo*) liveReportCopyByTargetID: | (NSString *) | targetID | |
type: | (NSInteger) | targetType | |
project: | (MSIProjectInfo *) | projectInfo | |
- (NSArray*) liveReportListCopyForProject: | (MSIProjectInfo *) | project |
- (void) moveCacheSet: | (NSString *) | setID | |
forReport: | (MSIReportDisplayInfo *) | aReport | |
- (NSInteger) moveReportCache: | (MSIReportDisplayInfo *) | aReport | |
oldCacheID: | (NSString *) | oldCacheID | |
newCacheID: | (NSString *) | newCacheID | |
error: | (NSError **) | error | |
- (DerivedReportInfo*) newDerivedReport: | (MSIReportDisplayInfo *) | baseReport |
- (MSILiveReportInfo*) newLiveReport: | (MSIObjectInfo *) | object | |
projectInfo: | (MSIProjectInfo *) | projectInfo | |
- (MSILiveReportInfo*) newLiveReport: | (NSString *) | objID | |
type: | (NSInteger) | type | |
projectInfo: | (MSIProjectInfo *) | projectInfo | |
- (NSMutableArray*) newUncachedReportsList |
+ (void) performUpgradeCleanup |
- (BOOL) reportCacheExists: | (MSIReportDisplayInfo *) | aReport | |
cacheID: | (NSString *) | cacheID | |
- (MSIReportDisplayInfo*) reportCopyBySubscriptionID: | (NSString *) | subscriptionID |
- (MSIReportDisplayInfo*) reportCopyBySubscriptionID: | (NSString *) | subscriptionID | |
projectID: | (NSString *) | projectID | |
- (MSIReportDisplayInfo*) reportCopyByTargetID: | (NSString *) | targetID | |
type: | (NSInteger) | targetType | |
- (MSIReportDisplayInfo*) reportCopyByTargetID: | (NSString *) | targetID | |
type: | (NSInteger) | targetType | |
projectID: | (NSString *) | projectID | |
- (MSIReportDisplayInfo*) reportCopyByTargetID: | (NSString *) | targetID | |
type: | (NSInteger) | targetType | |
projectID: | (NSString *) | projectID | |
promptAnswer: | (NSString *) | promptAnswer | |
- (NSArray*) reportListCopy |
- (NSArray*) reportListCopyForProject: | (MSIProjectInfo *) | project |
- (NSArray*) reportsCopyByTargetID: | (NSString *) | targetID | |
type: | (NSInteger) | targetType | |
projectID: | (NSString *) | projectID | |
+ (NSString*) reportsRootPath |
+ (void) resetReportStore |
- (void) setDocument: | (MSIReportDisplayInfo *) | document | |
locked: | (BOOL) | locked | |
- (void) setFullyCached: | (BOOL) | value | |
bytesLoaded: | (NSInteger) | bytesLoaded | |
toReport: | (MSIReportDisplayInfo *) | report | |
- (void) setFullyCached: | (BOOL) | value | |
bytesLoaded: | (NSInteger) | bytesLoaded | |
updateTime: | (BOOL) | updateTime | |
toReport: | (MSIReportDisplayInfo *) | report | |
- (void) setInitialPageForReport: | (MSIReportDisplayInfo *) | report | |
identifier: | (NSString *) | identifier | |
values: | (NSArray *) | values | |
- (void) setPreloadingStateForReport: | (MSIReportDisplayInfo *) | report | |
layoutID: | (NSInteger) | layoutID | |
sliceCount: | (NSInteger) | sliceCount | |
- (NSInteger) updateReport: | (MSIReportDisplayInfo *) | aReport | |
dataAction: | (NSInteger) | action | |
error: | (NSError **) | error | |
- (NSInteger) updateReport: | (MSIReportDisplayInfo *) | aReport | |
deleteData: | (bool) | deleteData | |
error: | (NSError **) | error | |