Mobile API Reference  MicroStrategy 2019
BrowseElementsService Class Reference

#import <BrowseElementsService.h>

Inheritance diagram for BrowseElementsService:
MSIServiceImpl

Properties

MSIReportDisplayInfodocument
 
- Properties inherited from MSIServiceImpl
id< ServiceHandler > handler
 
BOOL suppressLoginPrompt
 
id< Service > innerService
 

Additional Inherited Members

- Instance Methods inherited from MSIServiceImpl
(void) - run
 
(NSString *) - getBaseURL:task:
 
(void) - handleData:request:
 
(void) - handleError:request:
 
(void) - handleDataProgress:Total:request:
 
(void) - setTaskGroup:
 
(NSString *) - sessionState:
 
(MSIProjectConfiguration *) - projectConfigForReport:
 
(void) - reportException:report:
 
(void) - reportError:report:
 
(NSString *) - getSessionState:
 
(MSIProjectConfiguration *) - getProjectConfig:
 
(MSIDevicePreferences *) - getDevicePrefs
 
(void) - reportException:project:
 
(void) - handleServiceFailedError:withProject:
 
(void) - resetInnerService
 
(void) - threadRun
 
(void) - handleClientVersionError:
 
(void) - handleObjectNotFoundError:
 
(void) - handleSessionExpiredError:
 
- Protected Attributes inherited from MSIServiceImpl
NSInteger state
 
id< MSINetworkRequestrequest
 
id< ServiceHandler > __weak handler
 
TaskGroup * taskGroup
 
TaskInfo * taskInfo
 
id< Service > __weak innerService
 
BOOL suppressNetworkErrorAlerts
 
NSString * incrementalFileLocation
 
double priority
 
ClientRequestExecutionHandlerFlags requestExeFlag
 
BOOL makeIncrementalAvailable
 

Detailed Description

The BrowseElementsService will find all the elements matching the given criteria.

Parameters
handlerid<MSTRHandler> object to receive the blocks as an NSArray of Elemetns, or handle the error.
asyncSet to YES for asynchronous execution, NO for synchronous.
attributeIdthe object ID of the attribute (e.g. Category or Region) on the mobile server
projectThe ProjectInfo for the project to browse. One way it can be found is via MSIPreferencesStore -> MSIDevicePreferences -> WebServerList -> WebServerConfiguration -> ProjectList -> ProjectConfiguration -> ProjectInfo
blockBegin1-based index of the items to return. This is useful for retrieving incrementally.
blockCountNumber of items to return. Use -1 to retrieve all matching Elements.
searchPatternString that is matched against the displayName. A nil or empty string matches all. You can use SQL wildcards "%" and "_" to match a pattern. If a displayName contains the pattern, it matches. E.g. "Electronics" matches "tron" and it matches "E%"
filterXMLTo Be Documented.
shortFilterXMLTo Be Documented.
totalSize(read-only) The number of items that matched, even if blockCount was set to fewer.
Returns
an array of Element objects.
See also
The PromptTypesSample project for an example of usage.

Property Documentation

◆ document

- (MSIReportDisplayInfo*) document
readwritenonatomicweak