Library Mobile API Reference for iPad  MicroStrategy 2019
PromptsService Class Reference

#import <PromptsService.h>

Inheritance diagram for PromptsService:
MSISessionBasedService <MSTRHandler> MSIServiceImpl

Instance Methods

(void) - onSuccess:
 
(void) - onFailure:
 
(BOOL) - isStatusPrompting
 
- Instance Methods inherited from MSISessionBasedService
(void) - getSession
 
(void) - populateSessionOnRequest:
 
(BOOL) - isSessionMissing
 
- 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) - handleUnauthorizedError:forRequest:
 
(BOOL) - isSessionExpired:
 
(void) - setRequest:
 
(void) - resetInnerService
 
(void) - threadRun
 
(void) - handleClientVersionError:
 
(void) - handleObjectNotFoundError:
 
(void) - handleSessionExpiredError:
 
- Instance Methods inherited from <MSTRHandler>
(void) - doStartElement:namespaceURI:attributes:level:support:
 
(void) - doEndElement:namespaceURI:level:support:
 

Protected Attributes

MSIReportDisplayInfodocument
 
BOOL savePromptsToMessage
 
NSInteger newMessageStatus
 
NSString * newMessageID
 
NSInteger newStateID
 
BOOL failIfOffline
 
- Protected Attributes inherited from MSIServiceImpl
NSInteger state
 
id< MSINetworkRequestrequest
 
id< ServiceHandler > __weak handler
 
TaskGroup * taskGroup
 
TaskInfo * taskInfo
 
id< Service > __weak innerService
 
id< Service > innerServiceStrongRef
 
BOOL suppressNetworkErrorAlerts
 
NSString * incrementalFileLocation
 
double priority
 
ClientRequestExecutionHandlerFlags requestExeFlag
 
BOOL makeIncrementalAvailable
 

Properties

NSData * orignalData
 
CommonDependenciescommonDependencies
 
BOOL refreshMessage
 
- Properties inherited from MSISessionBasedService
NSString * sessionState
 
NSString * sessionID
 
BOOL automaticallyGetSessionStateWhenRun
 
MSIProjectInfoprojectInfo
 
BOOL ignoreAccessProjectError
 
MSIServiceImplparentService
 
MSTRExceptionsessionException
 
ErrorInfo * sessionErrorInfo
 
NSInteger credentialsPromptReturnValue
 
MSIConnectionManagerconnectionManager
 
NSInteger applicationMode
 
- Properties inherited from MSIServiceImpl
id< ServiceHandler > handler
 
BOOL suppressLoginPrompt
 
id< Service > innerService
 

Method Documentation

◆ isStatusPrompting()

- (BOOL) isStatusPrompting

PromptsService will get the result from server that the prompt answer is still required or not.

Returns
YES if server still requires prompt answer. - by yxi, 2/16/2012

◆ onFailure:()

- (void) onFailure: (MSTRError *)  anError

◆ onSuccess:()

- (void) onSuccess: (id)  data

Member Data Documentation

◆ document

- (MSIReportDisplayInfo *) document
readwritenonatomicstrongprotected

◆ failIfOffline

- (BOOL) failIfOffline
readwriteprotected

◆ newMessageID

- (NSString*) newMessageID
protected

◆ newMessageStatus

- (NSInteger) newMessageStatus
protected

◆ newStateID

- (NSInteger) newStateID
protected

◆ savePromptsToMessage

- (BOOL) savePromptsToMessage
readwriteprotected

Property Documentation

◆ commonDependencies

- (CommonDependencies*) commonDependencies
readwritenonatomicstrong

◆ orignalData

- (NSData*) orignalData
readnonatomicweak

◆ refreshMessage

- (BOOL) refreshMessage
readwriteatomic