Mobile API Reference  MicroStrategy 2019
PromptHelper Class Reference

#import <PromptHelper.h>

Inheritance diagram for PromptHelper:
<CalendarDelegate> IPadPromptHelper IPhonePromptHelper

Instance Methods

(id) - initWithPrompts:
 
(Prompts *) - prompts
 
(void) - setPrompts:
 
(void) - displayElementListScreen:parentViewController:
 
(void) - displayCustomPromptScreenWithParentViewController:
 
(void) - storePersonalization:dismissPreviousView:
 
(void) - validateCustomSaveAndDismissPreviousView:
 
(MSIProjectConfiguration *) - project
 
(void) - displayPrompt:
 
(EnumPromptAnswerStatus- getCurrentPromptAnswerStatus
 
(BOOL- validatePromptAnswer:
 
(BOOL- validateConstantLocationPromptAnswers
 
(void) - barcodeScannerDone:
 
(void) - elementSelectionDone
 
(void) - elementSelectionCancelled
 
(void) - displayPromptAtIndex:
 
(void) - savePromptAnswers
 
(void) - saveAnswersAndDisplayReport
 
(BOOL- didElementsChange:
 
(void) - saveExistingPromptAnswers
 
(BOOL- promptAnswersChanged
 
(void) - saveExistingConstantPromptAnswers
 
(BOOL- constantPromptAnswersChanged
 
(void) - locationUpdated:
 
(NSArray *) - locationFromConstantPrompts
 
(void) - displayCalendar:
 
(BOOL- shouldDisplayDateTime:
 
(void) - cancelPrompts
 
(void) - doneSummaryPrompts
 
(void) - cancelModalPrompts
 
(void) - displayBarcodeScanner:
 
(void) - displayPromptsFromCache:
 
(void) - completeSaveAndDisplay
 
(void) - cancelRunningThread
 
(void) - displayWaitView
 
(void) - hideWaitView
 
(void) - calendarCanceled
 
(void) - expressionEditingDone
 
(MIPromptViewController *) - getPromptViewController
 
(BOOL- isPromptInPromptInDocument:
 
(void) - setCurrentPrompt:
 
(NSArray *) - getCachedPrompts
 
- Instance Methods inherited from <CalendarDelegate>
(void) - dateSelectionDone:
 
(void) - dateSelectionCancelled
 

Class Methods

(void) + setBarcodeXmlValue:prompt:
 
(NSString *) + getBarcodeValue:
 
(BOOL+ isPromptInPrompt:inDocument:
 

Protected Attributes

PromptspromptCache
 
id< PromptHelperDelegate > __weak delegate
 
MIPromptViewControllermpPromptViewController
 
NSMutableArray * prevPromptAnswers
 
NSMutableArray * prevConstantPromptAnswers
 
CLLocationManager * locationManager
 
MKMapView * locationHelperMap
 
EnumPromptAnswerStatus currentPromptAnswerStatus
 
UIView * backgroundCoveringView
 

Properties

MSIReportDisplayInforeport
 
BOOL multiSelect
 
BOOL searchRequired
 
PromptSelectorControllercurrentSelectorController
 
NSInteger currentPromptIndex
 
MSIObjectInfoattribute
 
id< PromptHelperDelegatedelegate
 
UIViewController * currentController
 
BOOL animateInitially
 
BOOL anyPromptAnswerChanged
 
PromptsService * promptsService
 
NSThread * currentThread
 
BOOL isReprompt
 
BOOL isLinkDrill
 
NSDictionary * answerModes
 
BOOL containsLocationPrompt
 
BOOL currentlyAnsweringLocPrompts
 
NSInteger currentLocErrorCode
 
BOOL isAutoDisplayDetails
 
ThemeType themetype
 
UIColor * accentColor
 
BOOL isBackgroundNavigationBarHidden
 

Method Documentation

◆ barcodeScannerDone:()

- (void) barcodeScannerDone: (NSString *)  newSelection

◆ calendarCanceled()

- (void) calendarCanceled

◆ cancelModalPrompts()

- (void) cancelModalPrompts

◆ cancelPrompts()

- (void) cancelPrompts

◆ cancelRunningThread()

- (void) cancelRunningThread

◆ completeSaveAndDisplay()

- (void) completeSaveAndDisplay

◆ constantPromptAnswersChanged()

- (BOOL) constantPromptAnswersChanged

◆ didElementsChange:()

- (BOOL) didElementsChange: (NSMutableArray *)  elements

◆ displayBarcodeScanner:()

- (void) displayBarcodeScanner: (MSIConstantPrompt *)  curPrompt

◆ displayCalendar:()

- (void) displayCalendar: (MSIConstantPrompt *)  curPrompt

◆ displayCustomPromptScreenWithParentViewController:()

- (void) displayCustomPromptScreenWithParentViewController: (UIViewController *)  parent

Displays a modal view for custom editing of a prompt answer.

◆ displayElementListScreen:parentViewController:()

- (void) displayElementListScreen: (MSIObjectInfo *)  promptAttribute
parentViewController: (UIViewController *)  parent 

Displays a modal view for editing an Element list.

◆ displayPrompt:()

- (void) displayPrompt: (BOOL animate

Gets the prompt answers into the cache if they are not already there and displays the prompts from the cache.

◆ displayPromptAtIndex:()

- (void) displayPromptAtIndex: (NSInteger)  index

◆ displayPromptsFromCache:()

- (void) displayPromptsFromCache: (Prompts *)  data

◆ displayWaitView()

- (void) displayWaitView

◆ doneSummaryPrompts()

- (void) doneSummaryPrompts

◆ elementSelectionCancelled()

- (void) elementSelectionCancelled

◆ elementSelectionDone()

- (void) elementSelectionDone

◆ expressionEditingDone()

- (void) expressionEditingDone

◆ getBarcodeValue:()

+ (NSString*) getBarcodeValue: (MSIConstantPrompt *)  curPrompt

◆ getCachedPrompts()

- (NSArray *) getCachedPrompts

◆ getCurrentPromptAnswerStatus()

- (EnumPromptAnswerStatus) getCurrentPromptAnswerStatus

◆ getPromptViewController()

- (MIPromptViewController*) getPromptViewController

◆ hideWaitView()

- (void) hideWaitView

◆ initWithPrompts:()

- (id) initWithPrompts: (Prompts *)  prompts

Implemented in IPadPromptHelper, and IPhonePromptHelper.

◆ isPromptInPrompt:inDocument:()

+ (BOOL) isPromptInPrompt: (Prompts *)  prompts
inDocument: (MSIReportDisplayInfo *)  document 

◆ isPromptInPromptInDocument:()

- (BOOL) isPromptInPromptInDocument: (MSIReportDisplayInfo *)  document

◆ locationFromConstantPrompts()

- (NSArray *) locationFromConstantPrompts

◆ locationUpdated:()

- (void) locationUpdated: (CLLocation *)  newLocation

◆ project()

◆ promptAnswersChanged()

- (BOOL) promptAnswersChanged

◆ prompts()

- (Prompts*) prompts

◆ saveAnswersAndDisplayReport()

- (void) saveAnswersAndDisplayReport

◆ saveExistingConstantPromptAnswers()

- (void) saveExistingConstantPromptAnswers

◆ saveExistingPromptAnswers()

- (void) saveExistingPromptAnswers

◆ savePromptAnswers()

- (void) savePromptAnswers

◆ setBarcodeXmlValue:prompt:()

+ (void) setBarcodeXmlValue: (NSString *)  value
prompt: (MSIConstantPrompt *)  curPrompt 

◆ setCurrentPrompt:()

- (void) setCurrentPrompt: (MSIPrompt *)  prompt

◆ setPrompts:()

- (void) setPrompts: (Prompts *)  p

◆ shouldDisplayDateTime:()

- (BOOL) shouldDisplayDateTime: (MSIPrompt *)  curPrompt

◆ storePersonalization:dismissPreviousView:()

- (void) storePersonalization: (NSMutableArray *)  elements
dismissPreviousView: (BOOL iDismiss 

◆ validateConstantLocationPromptAnswers()

- (BOOL) validateConstantLocationPromptAnswers

◆ validateCustomSaveAndDismissPreviousView:()

- (void) validateCustomSaveAndDismissPreviousView: (BOOL dismiss

Used when a custom prompt editor is done. It validates the answer for the current prompt and then dismisses the custom editor.

◆ validatePromptAnswer:()

- (BOOL) validatePromptAnswer: (MSIPrompt *)  curPrompt

Member Data Documentation

◆ backgroundCoveringView

- (UIView*) backgroundCoveringView
protected

◆ currentPromptAnswerStatus

- (EnumPromptAnswerStatus) currentPromptAnswerStatus
protected

◆ delegate

- (id<PromptHelperDelegate> __weak) delegate
protected

◆ locationHelperMap

- (MKMapView*) locationHelperMap
protected

◆ locationManager

- (CLLocationManager*) locationManager
protected

◆ mpPromptViewController

- (MIPromptViewController*) mpPromptViewController
protected

◆ prevConstantPromptAnswers

- (NSMutableArray*) prevConstantPromptAnswers
protected

◆ prevPromptAnswers

- (NSMutableArray*) prevPromptAnswers
protected

◆ promptCache

- (Prompts*) promptCache
protected

Property Documentation

◆ accentColor

- (UIColor *) accentColor
readwritenonatomiccopy

◆ animateInitially

- (BOOL) animateInitially
readwriteatomic

◆ answerModes

- (NSDictionary *) answerModes
readwritenonatomiccopy

◆ anyPromptAnswerChanged

- (BOOL) anyPromptAnswerChanged
readwriteatomic

◆ attribute

- (MSIObjectInfo *) attribute
readwritenonatomicstrong

◆ containsLocationPrompt

- (BOOL) containsLocationPrompt
readwriteatomic

◆ currentController

- (UIViewController *) currentController
readwritenonatomicstrong

◆ currentLocErrorCode

- (NSInteger) currentLocErrorCode
readatomicassign

◆ currentlyAnsweringLocPrompts

- (BOOL) currentlyAnsweringLocPrompts
readatomicassign

◆ currentPromptIndex

- (NSInteger) currentPromptIndex
readatomicassign

◆ currentSelectorController

- (PromptSelectorController *) currentSelectorController
readwritenonatomicstrong

◆ currentThread

- (NSThread *) currentThread
readwritenonatomicstrong

◆ delegate

- (id<PromptHelperDelegate>) delegate
readwritenonatomicweak

◆ isAutoDisplayDetails

- (BOOL) isAutoDisplayDetails
readatomicassign

◆ isBackgroundNavigationBarHidden

- (BOOL) isBackgroundNavigationBarHidden
readwriteatomic

◆ isLinkDrill

- (BOOL) isLinkDrill
readwriteatomic

◆ isReprompt

- (BOOL) isReprompt
readwriteatomic

◆ multiSelect

- (BOOL) multiSelect
readwriteatomic

◆ promptsService

- (PromptsService *) promptsService
readatomicassign

◆ report

- (MSIReportDisplayInfo *) report
readwritenonatomicstrong

◆ searchRequired

- (BOOL) searchRequired
readwriteatomic

◆ themetype

- (ThemeType) themetype
readwritenonatomicassign