Mobile API Reference  MicroStrategy 2019
<IWidgetProtocol > Protocol Reference

#import <IViewer.h>

Inheritance diagram for <IWidgetProtocol >:
<IViewer>

Instance Methods

(id) - initViewer:withCommanderDelegate:withProps:
 
(void) - addViewToBaseView:
 
(void) - displayError:
 
(BOOL- supportsFitToScreen
 
- Instance Methods inherited from <IViewer>
(void) - detachViewer
 
(void) - handleEvent:
 
(CGFloat) - getMeasuredWidth
 
(CGFloat) - getMeasuredHeight
 
(void) - evaluateConditionalTransactionThreshold
 
(void) - measure
 
(NSString *) - getViewerID
 
(NSData *) - getViewerStatus
 

Class Methods

(MSTROrientation+ supportedOrientation
 

Method Documentation

◆ addViewToBaseView:()

- (void IWidgetProtocol) addViewToBaseView: (UIView *)  view

remove all subviews and use the specific view as the base view of the widget, use this method to customize the error view and pass it in, the error view is the one when the widget fails to render and we need to show something like error label to the user

◆ displayError:()

- (void IWidgetProtocol) displayError: (NSString *)  errorMessage

display error message, override this method to customize the error label, note by doing this, you will use the default error label that is defined in WidgetViewer.mm

◆ initViewer:withCommanderDelegate:withProps:()

- (id IWidgetProtocol) initViewer: (ViewerDataModel *)  _viewerDataModel
withCommanderDelegate: (id< MSICommanderDelegate >)  _commander
withProps: (NSString *)  _props 

Init method of the widget. If the _props is not required, set it as nil this is the initializtation of the widget, do things that only needs to be initialized once, like initialization of parameters, preparing data

◆ supportedOrientation()

+ (MSTROrientation IWidgetProtocol) supportedOrientation

call this method to get the supported orientations for widget in iPhone if no overridden, just use the default definition which is defined in WidgetViewer.mm

◆ supportsFitToScreen()

- (BOOL IWidgetProtocol) supportsFitToScreen

Whethter the widget supports fit to screen on iPhone, could be overridden to define different behavior from default one