#import <MSIGeneric.h>

Inheritance diagram for MSIGeneric:

Class Methods
(SDKEnvSettings *)	+ getSDKEnvSettings

(NSString *)	+ getCurrentDate

(NSString *)	+ getCurrentTime

(NSCharacterSet *)	+ characterSetWithEscapeCharacters:

(NSString *)	+ getURLEscapeCharacters

(NSString *)	+ getURLEscapeCharactersForImagePaths

(NSTimeInterval)	+ gmtToCurrentTimezone:

(NSString *)	+ getBaseURL:

(NSString *)	+ getBaseURL:task:

(NSInteger)	+ intFromDict:Key:

(CGFloat)	+ floatFromDict:Key:

(NSString *)	+ stringFromDict:Key:

(NSString *)	+ getBaseURLByWebServerConfig:

(NSString *)	+ getBaseURLByProjectConfig:

(NSString *)	+ getServletPath:

(NSString *)	+ getServletPathByProjectConfig:

(NSString *)	+ taskURL:withObjectInfo:

(BOOL)	+ isAbsoluteURL:

(BOOL)	+ isDataURL:

(NSLocale *)	+ getNumberAndDateLocale

(void)	+ setNumberAndDateLocaleId:

(NSLocale *)	+ getSystemNumberLocale

(void)	+ setSystemNumberLocaleId:

(NSCalendar *)	+ getCalendar

(NSCalendar *)	+ getAutoupdatingCurrentCalendar

(MSIAppContext *)	+ getMSTRAppContext

(void)	+ setStatusBarHidden:

(void)	+ setStatusBarHidden:withAnimation:

(void)	+ setStatusBarStyle:

(void)	+ setStatusBarStyle:animated:

(void)	+ setStatusBarOrientation:animated:

(BOOL)	+ locationServicesEnabled:

(BOOL)	+ iOS4Device

(BOOL)	+ isMultitaskingSupported

(NSUInteger)	+ incrementalFetchSize

(DeviceType)	+ getDeviceType

(UIInterfaceOrientation)	+ applicationInterfaceOrientation

(UINavigationController *)	+ applicationNavigationController

(UIWindow *)	+ applicationWindow

(UIViewController *)	+ applicationTopModalViewController

(UILabel *)	+ errorLabelForDesc:containingViewFrame:

(MSICertificateManager *)	+ getCertificateManager

(NSInteger)	+ authenticationModeForString:

(NSInteger)	+ webAuthenticationModeForString:

(NSInteger)	+ webServerTypeForString:

(DisplayObject *)	+ getRootFolderDisplayObject:

(void)	+ setupConnectInfoFromPlist:

(void)	+ setupConnectInfoFromPlist:withProjUsername:projPassword:

(MSTRError *)	+ errorWithErrorDetails:

(NSInteger)	+ supportedOrientationForEvent:

(NSBundle *)	+ sdkResourcesBundle

(NSBundle *)	+ finalBundle

(NSBundle *)	+ bundleNamed:

(NSString *)	+ apiVersion

(NSString *)	+ pathOfFileNamed:inBundleNamed:

(NSString *)	+ platform

(NSString *)	+ platformString

(NSInteger)	+ iOSMainVersion

(BOOL)	+ addSkipBackupAttributeToItemAtURL:

(NSString *)	+ getApplicationUID

(void)	+ UIGraphicsBeginImageContextByDeviceType:

(BOOL)	+ isUpgradedFromVersion:lastVersion:includingPrevious:

(BOOL)	+ is4inchScreen

(CGRect)	+ navigationControllerFrame:

(bool)	+ isSupportFaceID

(bool)	+ isSupportTouchID

(void)	+ showCoverScreen

(void)	+ hideCoverScreen

(void)	+ displayErrorInAlertViewWithTitle:message:delegate:dismissPrevious:withOtherButton:okButtonTitle:otherButtonTitle:

(NSString *)	+ getDeviceID

(NSURL *)	+ getCompleteURL:withBaseURL:

(NSURL *)	+ getCompleteURL:withBaseURL:urlEncodeAbsoluteUrl:

(BOOL)	+ iOS5OrHigher

(BOOL)	+ iOS7OrHigher

(BOOL)	+ iOS8OrHigher

(BOOL)	+ iOS9OrHigher

(UIButton *)	+ createStdButtonWithTitle:backgroundImage:target:action:

(NSString *)	+ getLaunchImageName:

(NSString *)	+ getLockImageName:

(BOOL)	+ isDeviceiPhone5

(BOOL)	+ isDeviceiPhone6SizeFamily

(BOOL)	+ isDeviceiPhone6PlusSizeFamily

(BOOL)	+ isDeviceiPhoneXSizeFamily

(BOOL)	+ isDeviceiPhoneXRSizeFamily

(BOOL)	+ isDeviceiPhoneXSMaxSizeFamily

(BOOL)	+ isDeviceiPhone6S

(BOOL)	+ isDeviceiPhoneX

(BOOL)	+ isDeviceiPhoneXR

(BOOL)	+ isDeviceiPhoneXS

(BOOL)	+ isDeviceiPhoneXSMax

(BOOL)	+ isDeviceiPadMini4

(BOOL)	+ isDeviceiPadAir2

(BOOL)	+ isDeviceiPadPro

(BOOL)	+ shouldUseSafeArea

(BOOL)	+ networkIsReachable

(BOOL)	+ isNewsstandEnabled

(BOOL)	+ isPushNotificationEnabled

(BOOL)	+ isBackgroundTransferEnabled

(BOOL)	+ softwareEncryptionEnabled

(void)	+ setEncryptionKey:

(NSString *)	+ getEncryptionKey

(BOOL)	+ isIPhone5

(NSString *)	+ binaryFlag1Info:

(NSString *)	+ binaryFlag2Info:

(UIImage *)	+ generateScreenShotAboveiOS7:

(NSString *)	+ longestStringInArray:

(UIImage *)	+ imageWithColor:

(UIImage *)	+ imageWithView:

(BOOL)	+ isRetina

(BOOL)	+ isPersistSelection

(BOOL)	+ enableTemplateMultiSelection

(NSString *)	+ appName

(BOOL)	+ isPreferenceCarryOverThroughServer

(BOOL)	+ isPreferenceDisableRepromptOnPDF

(void)	+ showDocAuthenticationError:isLocalAuth:delegate:

(NSString *)	+ currentNetworkID

(void)	+ logCookiesWithClassName:methodName:

(CGFloat)	+ safeAreaLeftPadding

(CGFloat)	+ safeAreaRightPadding

(CGFloat)	+ safeAreaBottomPadding

(CGFloat)	+ safeAreaTopPadding

(CGRect)	+ applicationFrame

(NSString *_Nonnull)	+ microStrategyBadgeName

(NSString *_Nonnull)	+ microStrategyBadgeShortName

(NSString *_Nonnull)	+ getSecureDocumentErrorMessage:authenticationMethod:

Detailed Description

It is a utility class which provides convienent methods to be used.

Method Documentation

◆ addSkipBackupAttributeToItemAtURL:()

+ (BOOL) addSkipBackupAttributeToItemAtURL: (NSURL *) URL

Set file attribute to skip backup attribute

Parameters

URL	Path of the file

◆ apiVersion()

+ (NSString *) apiVersion

This is the version number of the MicroStrategy API. This is independent of the app version (though for OOTB MSTR Mobile it will be the same), and is generally used for version comparison.

Returns: api version

◆ applicationFrame()

+ (CGRect) applicationFrame

◆ applicationInterfaceOrientation()

+ (UIInterfaceOrientation) applicationInterfaceOrientation

◆ applicationNavigationController()

+ (UINavigationController*) applicationNavigationController

Get the root navigation controller. The Application Delegate should extends from MSIAppDelegate and set a navigation controller to it when a navigation controller is created for this application.

Returns: root navigation controller

◆ applicationTopModalViewController()

+ (UIViewController*) applicationTopModalViewController

◆ applicationWindow()

+ (UIWindow*) applicationWindow

Get the application window The Application Delegate should extends from MSIAppDelegate to get the window.

Returns: application window

◆ appName()

+ (NSString*) appName

◆ authenticationModeForString:()

+ (NSInteger) authenticationModeForString: (NSString *) _authMode

Convert the authentication mode text to enum value.

Parameters

_authMode project authentication mode text

Returns: enum value of AuthModes for the authentication mode

◆ binaryFlag1Info:()

+ (NSString*) binaryFlag1Info: (int) flag1

Binary request flags detailed info

◆ binaryFlag2Info:()

+ (NSString*) binaryFlag2Info: (unsigned) flag2

◆ bundleNamed:()

+ (NSBundle *) bundleNamed: (NSString *) bundleName

Get the bundle from resouce by the bundle name

Parameters

bundleName bundle name

Returns: bundle

◆ characterSetWithEscapeCharacters:()

+ (NSCharacterSet *) characterSetWithEscapeCharacters: (NSString *) string

Get all the allowed characters set from escape string for replacing deprecated CFURLCreateStringByAddingPercentEscapes with stringByAddingPercentEncodingWithAllowedCharacters get the characters set for the escape characters

Returns: NSCharacterSet containing all allowed characters

◆ createStdButtonWithTitle:backgroundImage:target:action:()

+ (UIButton *) createStdButtonWithTitle:	(NSString *)	title
backgroundImage:	(UIImage *)	image
target:	(id)	target
action:	(SEL)	action

return iOS standard barbutton-like button with stretchable background image

Parameters

title	is the title shown on button
image	is the background image
target	is the control target
action	is the action when button is pressed

Returns: button (autoreleased)

◆ currentNetworkID()

+ (NSString *) currentNetworkID

Returns: current wifi's ssid

◆ displayErrorInAlertViewWithTitle:message:delegate:dismissPrevious:withOtherButton:okButtonTitle:otherButtonTitle:()

+ (void) displayErrorInAlertViewWithTitle:	(NSString *)	title
message:	(NSString *)	message
delegate:	(id)	delegate
dismissPrevious:	(BOOL)	dismiss
withOtherButton:	(BOOL)	otherButton
okButtonTitle:	(NSString *)	okButtonTitle
otherButtonTitle:	(NSString *)	otherButtonTitle

◆ enableTemplateMultiSelection()

+ (BOOL) enableTemplateMultiSelection

◆ errorLabelForDesc:containingViewFrame:()

+ (UILabel*) errorLabelForDesc:	(NSString *)	errorDesc
containingViewFrame:	(CGRect)	viewFrame

Creates an error label with the specified string. The containingViewFrame should provide the size of the view which this label will be added to.

Parameters

errorDesc	error string displayed in the label
viewFrame	label frame

Returns: UILabel displays the error string

◆ errorWithErrorDetails:()

+ (MSTRError*) errorWithErrorDetails: (NSString *) details

Utility method to construct an error object from an error string

Parameters

details error message for the error details

Returns: error object

◆ finalBundle()

+ (NSBundle *) finalBundle

Get the bundle of name "FinalBundle" in resource

Returns: final bundle

◆ floatFromDict:Key:()

+ (CGFloat) floatFromDict:	(NSDictionary *)	dictionary
Key:	(NSString *)	key

Returns the float value of the object associated with the key. If not exists returns NSNotFound converted to float

Parameters

dictionary	dictionary created from connect info plist file
key	key

Returns: float value for the key

◆ generateScreenShotAboveiOS7:()

+ (UIImage *) generateScreenShotAboveiOS7: (CGFloat) offset

return screen shot on iOS7 above system

Returns: UIImage generated for screen shot

◆ getApplicationUID()

+ (NSString *) getApplicationUID

Get the UID of this application. It's a string of length 40. The UID is created when it's accessed for the first time and saved to key chain. It will be retrieved from key chain when it's accessed again. It's used to replace the iOS UDID since it's deprecated.

Returns: UID

◆ getAutoupdatingCurrentCalendar()

+ (NSCalendar*) getAutoupdatingCurrentCalendar

Get the autoupdatingCurrentCalendar witch concurrent with iPad/iPhone -> Settings->General->Region/Language. By wenzhou, 12/15/2015. US31530. Locale of this calendar is set to the application's locale if it exists.

Returns: calendar

◆ getBaseURL:()

+ (NSString*) getBaseURL: (WebServerConfiguration *) webserverConfig

Get the base url of a WebServerConfiguration The URL is composed of request type, server name, port and path, example : http://123.43.43.43:8080/MicroStrategyMobile

Parameters

webserverConfig WebServerConfiguration

Returns: base URL for the web server

◆ getBaseURL:task:()

+ (NSString*) getBaseURL:	(MSIProjectInfo *)	aProject
task:	(BOOL)	task

Get the base url of a ProjectInfo and task The URL is composed of request type, server name, port, path, servlet. If it's a task URL, it contains the task name. example, http://123.43.43.43:8080/MicroStrategyMobile/servlet/mstrWeb? if it't not a task http://123.43.43.43:8080/MicroStrategyMobile/servlet/mobile?action=executeTask&taskParams= if it's a task

Parameters

aProject	project info used to get the WebServerConfiguration
task	whether it's a task URL

Returns: base url for the project and task

◆ getBaseURLByProjectConfig:()

+ (NSString*) getBaseURLByProjectConfig: (MSIProjectInfo *) projectInfo

Get the base url of a ProjectInfo The URL is composed of request type, server name, port and path, example : http://123.43.43.43:8080/MicroStrategyMobile

Parameters

projectInfo ProjectInfo to get the WebServerConfiguration

Returns: base URL string for the projectInfo

◆ getBaseURLByWebServerConfig:()

+ (NSString*) getBaseURLByWebServerConfig: (WebServerConfiguration *) webserverConfig

Get the base url of a WebServerConfiguration The URL is composed of request type, server name, port and path, example : http://123.43.43.43:8080/MicroStrategyMobile

Parameters

webserverConfig WebServerConfiguration

Returns: base URL string for the web server

◆ getCalendar()

+ (NSCalendar*) getCalendar

Get Gregorian Calendar. Locale of this calendar is set to the application's locale if it exists.

Returns: calendar

◆ getCertificateManager()

+ (MSICertificateManager *) getCertificateManager

Returns the certificate manager

◆ getCompleteURL:withBaseURL:()

+ (NSURL*) getCompleteURL:	(NSString *)	iURL
withBaseURL:	(NSString *)	iBaseURL

return completeURL after encoding

Parameters

iURL	resource URL
iBaseURL	base URL of the mobile server

Returns: Complete URL

◆ getCompleteURL:withBaseURL:urlEncodeAbsoluteUrl:()

+ (NSURL*) getCompleteURL:	(NSString *)	iURL
withBaseURL:	(NSString *)	iBaseURL
urlEncodeAbsoluteUrl:	(BOOL)	urlencode

return completeURL after encoding

Parameters

iURL	resource URL
iBaseURL	base URL of the mobile server
urlEncodedd

Returns: Complete URL

◆ getCurrentDate()

+ (NSString*) getCurrentDate

Get string representation of the current date

Returns: date string without time

◆ getCurrentTime()

+ (NSString*) getCurrentTime

Get string representation of the current time

Returns: time string without date

◆ getDeviceID()

+ (NSString*) getDeviceID

return deviceID

Returns: device ID

◆ getDeviceType()

+ (DeviceType) getDeviceType

Check the device type, it can be either iPhone or iPad

Returns: device type, it's enum value of DeviceType in Enums.h

◆ getEncryptionKey()

+ (NSString*) getEncryptionKey

◆ getLaunchImageName:()

+ (NSString*) getLaunchImageName: (UIInterfaceOrientation) interfaceOrientation

return the launch image name for the device

Parameters

interfaceOrientation The device orientation

Returns: launch image name

◆ getLockImageName:()

+ (NSString*) getLockImageName: (UIInterfaceOrientation) interfaceOrientation

return the lock image name for touch id security

Parameters

interfaceOrientation The device orientation

Returns: lock image name

◆ getMSTRAppContext()

+ (MSIAppContext*) getMSTRAppContext

Returns the global application context object

Returns: MSIAppContext singleton object

◆ getNumberAndDateLocale()

+ (NSLocale*) getNumberAndDateLocale

Get the locale of this application, if it doesn't have locale, get the current locale

Returns: locale of this application or current locale

◆ getRootFolderDisplayObject:()

+ (DisplayObject*) getRootFolderDisplayObject: (MSIProjectInfo *) projInfo

Get the root folder display object for a project. This information is stored in device preferences. The folder object will be opened when the project is opened.

Parameters

projInfo project to be found

Returns: root folder display object

◆ getSDKEnvSettings()

+ (SDKEnvSettings*) getSDKEnvSettings

Get SDK environment settigs

Returns: SDKEnvSettings

◆ getSecureDocumentErrorMessage:authenticationMethod:()

+ (NSString * _Nonnull) getSecureDocumentErrorMessage:	(int)	errorStatus
authenticationMethod:	(int)	authenticationMode

◆ getServletPath:()

+ (NSString*) getServletPath: (WebServerConfiguration *) webserverConfig

Gets the servlet path of a WebServerConfiguration The URL is composed of request type, server name, port, path and server type. example : http://123.43.43.43:8080/MicroStrategyMobile/servlet/ (J2EE) http://123.43.43.43:8080/MicroStrategyMobile/asp/ (ASP)

Parameters

webserverConfig WebServerConfiguration

Returns: servlet path of the web server

◆ getServletPathByProjectConfig:()

+ (NSString*) getServletPathByProjectConfig: (MSIProjectInfo *) projectInfo

Gets the servlet path for a project info. The URL is composed of request type, server name, port, path and server type. example : http://123.43.43.43:8080/MicroStrategyMobile/servlet/ (J2EE) http://123.43.43.43:8080/MicroStrategyMobile/asp/ (ASP)

Parameters

projectInfo ProjectInfo to get the WebServerConfiguration

Returns: servlet path of the project

◆ getSystemNumberLocale()

+ (NSLocale*) getSystemNumberLocale

Get the number locale of system, if it doesn't have locale, get the current locale

Returns: locale of sytem

◆ getURLEscapeCharacters()

+ (NSString*) getURLEscapeCharacters

Get all the URL escape characters

Returns: string containing all the URL escape characters

◆ getURLEscapeCharactersForImagePaths()

+ (NSString*) getURLEscapeCharactersForImagePaths

Get all the URL escape characters for Image Path

Returns: string containing all the URL escape characters

◆ gmtToCurrentTimezone:()

+ (NSTimeInterval) gmtToCurrentTimezone: (NSTimeInterval) gmtTime

Convert GMT time to the time in current timezone

Parameters

gmtTime GMT time

Returns: current timezone time

◆ hideCoverScreen()

+ (void) hideCoverScreen

◆ imageWithColor:()

+ (UIImage*) imageWithColor: (UIColor *) color

◆ imageWithView:()

+ (UIImage*) imageWithView: (UIView *) view

◆ incrementalFetchSize()

+ (NSUInteger) incrementalFetchSize

Get the incremental fetch size It is used to determine the grid rows to be fetch one time.

Returns: incremential fetch size

◆ intFromDict:Key:()

+ (NSInteger) intFromDict:	(NSDictionary *)	dictionary
Key:	(NSString *)	key

Returns the int value of the object associated with the key. If not exists returns NSNotFound

Parameters

dictionary	dictionary created from connect info plist file
key	key

Returns: int value for the key

◆ iOS4Device()

+ (BOOL) iOS4Device

Check whether the device installs iOS4 and above

Returns: YES if iOS4 and above installed, otherwise NO.

◆ iOS5OrHigher()

+ (BOOL) iOS5OrHigher

return if current device's iOS version is 5.0 or higher

◆ iOS7OrHigher()

+ (BOOL) iOS7OrHigher

return if current device's iOS version is 7.0 or higher

◆ iOS8OrHigher()

+ (BOOL) iOS8OrHigher

return if current device's iOS version is 8.0 or higher

◆ iOS9OrHigher()

+ (BOOL) iOS9OrHigher

return if current device's iOS version is 9.0 or higher

◆ iOSMainVersion()

+ (NSInteger) iOSMainVersion

Get the iOS Main version number

Returns: iOS main version

◆ is4inchScreen()

+ (BOOL) is4inchScreen

If current device is using 4-inch screen, like iPhone5, iPhone 5s

◆ isAbsoluteURL:()

+ (BOOL) isAbsoluteURL: (NSString *) url

Determine whether a url string contains "HTTP" or "HTTPS"

Parameters

url	url string

Returns: YES for url contains "HTTP" or "HTTPS", otherwise NO

◆ isBackgroundTransferEnabled()

+ (BOOL) isBackgroundTransferEnabled

◆ isDataURL:()

+ (BOOL) isDataURL: (NSString *) url

Determine whether a url string is a data url

Parameters

url	url string

Returns: YES for url starts with "data:", otherwise NO

◆ isDeviceiPadAir2()

+ (BOOL) isDeviceiPadAir2

return if the device is ipad air 2

Returns: Whether device is ipad air 2

◆ isDeviceiPadMini4()

+ (BOOL) isDeviceiPadMini4

return if the device is ipad mini 4

Returns: Whether device is ipad mini 4

◆ isDeviceiPadPro()

+ (BOOL) isDeviceiPadPro

return if the device is ipad pro

Returns: Whether device is ipad pro

◆ isDeviceiPhone5()

+ (BOOL) isDeviceiPhone5

return if the device is iphone 5

Returns: Whether device is iphone 5

◆ isDeviceiPhone6PlusSizeFamily()

+ (BOOL) isDeviceiPhone6PlusSizeFamily

return if the device is iphone 6 plus

Returns: Whether device is iphone 6 plus

◆ isDeviceiPhone6S()

+ (BOOL) isDeviceiPhone6S

return if the device is iphone 6S

Returns: Whether device is iphone 6S

◆ isDeviceiPhone6SizeFamily()

+ (BOOL) isDeviceiPhone6SizeFamily

return if the device is iphone 6

Returns: Whether device is iphone 6

◆ isDeviceiPhoneX()

+ (BOOL) isDeviceiPhoneX

return if the device is iphoneX

Returns: Whether device is iphoneX

◆ isDeviceiPhoneXR()

+ (BOOL) isDeviceiPhoneXR

return if the device is iphone XR

Returns: Whether device is iphone XR

◆ isDeviceiPhoneXRSizeFamily()

+ (BOOL) isDeviceiPhoneXRSizeFamily

return if the device is iphone XR

Returns: Whether device is iphone XR

◆ isDeviceiPhoneXS()

+ (BOOL) isDeviceiPhoneXS

return if the device is iphone XS

Returns: Whether device is iphone XS

◆ isDeviceiPhoneXSizeFamily()

+ (BOOL) isDeviceiPhoneXSizeFamily

return if the device is iphone X

Returns: Whether device is iphone X

◆ isDeviceiPhoneXSMax()

+ (BOOL) isDeviceiPhoneXSMax

return if the device is iphone XS Max

Returns: Whether device is iphone XS Max

◆ isDeviceiPhoneXSMaxSizeFamily()

+ (BOOL) isDeviceiPhoneXSMaxSizeFamily

return if the device is iphone XS Max

Returns: Whether device is iphone XS Max

◆ isIPhone5()

+ (BOOL) isIPhone5

◆ isMultitaskingSupported()

+ (BOOL) isMultitaskingSupported

Check whether the device and iOS support muti tasking

Returns: YES if device and iOS support multi tasking, otherwise NO.

◆ isNewsstandEnabled()

+ (BOOL) isNewsstandEnabled

◆ isPersistSelection()

+ (BOOL) isPersistSelection

◆ isPreferenceCarryOverThroughServer()

+ (BOOL) isPreferenceCarryOverThroughServer

◆ isPreferenceDisableRepromptOnPDF()

+ (BOOL) isPreferenceDisableRepromptOnPDF

◆ isPushNotificationEnabled()

+ (BOOL) isPushNotificationEnabled

◆ isRetina()

+ (BOOL) isRetina

◆ isSupportFaceID()

+ (bool) isSupportFaceID

◆ isSupportTouchID()

+ (bool) isSupportTouchID

◆ isUpgradedFromVersion:lastVersion:includingPrevious:()

+ (BOOL) isUpgradedFromVersion:	(NSString *)	oldVersion
lastVersion:	(NSString *)	lastVersion
includingPrevious:	(BOOL)	includingPrevious

Check whether this application is upgraded from an old version. It's considered as upgrading from the old version if the lastVersion equals or less than the old version depending on the includePrevious parameter.

Parameters

oldVersion	old version
lastVersion	the version before this launch whether version older than the oldVersion is consider, if YES, lastVersion can be lower than the oldVersion, if NO, lastVersion should be the same as oldVersion

Returns: YES if the lastVersion equals or less than the oldVersion NO if lastVersion is larger than the oldVersion

◆ locationServicesEnabled:()

+ (BOOL) locationServicesEnabled: (CLLocationManager *) locationManager

Determine whether location service is enabled in this device

Parameters

locationManager location manager

◆ logCookiesWithClassName:methodName:()

+ (void) logCookiesWithClassName:	(NSString *)	className
methodName:	(NSString *)	methodName

◆ longestStringInArray:()

+ (NSString*) longestStringInArray: (NSArray *) strings

◆ microStrategyBadgeName()

+ (NSString * _Nonnull) microStrategyBadgeName

◆ microStrategyBadgeShortName()

+ (NSString * _Nonnull) microStrategyBadgeShortName

◆ navigationControllerFrame:()

+ (CGRect) navigationControllerFrame: (BOOL) isPortrait

return the navigation controller / bar frame

◆ networkIsReachable()

+ (BOOL) networkIsReachable

Check if network is connected

Returns: If network is reachable

◆ pathOfFileNamed:inBundleNamed:()

+ (NSString *) pathOfFileNamed:	(NSString *)	fileName
inBundleNamed:	(NSString *)	bundleName

Get the relativate path of a file in a bundle

Parameters

fileName	file name
bundleName	bundle name where the file locates

Returns: the relative file path

◆ platform()

+ (NSString *) platform

Get the hardware platform of this device, http://stackoverflow.com/questions/448162/determine-device-iphone-ipod-touch-with-iphone-sdk

Returns: hardware platform string

◆ platformString()

+ (NSString*) platformString

Get the platform information String(include network type) of the current device such as "iPad 2 wifi"

Returns: platform information String(include network type)

◆ safeAreaBottomPadding()

+ (CGFloat) safeAreaBottomPadding

◆ safeAreaLeftPadding()

+ (CGFloat) safeAreaLeftPadding

Returns: safe area padding for iPhoneX.

◆ safeAreaRightPadding()

+ (CGFloat) safeAreaRightPadding

◆ safeAreaTopPadding()

+ (CGFloat) safeAreaTopPadding

◆ sdkResourcesBundle()

+ (NSBundle *) sdkResourcesBundle

Get the bundle of name "MicroStrategyMobileSDKResources" from main bundle

Returns: sdk resource bundle

◆ setEncryptionKey:()

+ (void) setEncryptionKey: (NSString *) key

◆ setNumberAndDateLocaleId:()

+ (void) setNumberAndDateLocaleId: (NSString *) lId

Set application locale. If application has locale, do nothing.

Parameters

lId locale id

◆ setStatusBarHidden:()

+ (void) setStatusBarHidden: (BOOL) hidden

Updates state of the status bar.

Parameters

hidden hide status bar or not

◆ setStatusBarHidden:withAnimation:()

+ (void) setStatusBarHidden:	(BOOL)	hidden
withAnimation:	(BOOL)	animation

Updates state of the status bar.

Parameters

hidden	hide status bar or not
animation	whether do animation

◆ setStatusBarOrientation:animated:()

+ (void) setStatusBarOrientation:	(UIInterfaceOrientation)	interfaceOrientation
animated:	(BOOL)	animated

Updates orientation of the status bar.

Parameters

interfaceOrientation	new orientation of the status bar
animated	whether do animation

◆ setStatusBarStyle:()

+ (void) setStatusBarStyle: (UIStatusBarStyle) statusBarStyle

Updates style of the status bar.

Parameters

statusBarStyle new style of the status bar

◆ setStatusBarStyle:animated:()

+ (void) setStatusBarStyle:	(UIStatusBarStyle)	statusBarStyle
animated:	(BOOL)	animated

Updates style of the status bar.

Parameters

statusBarStyle	new style of the status bar
animated	whether do animation

◆ setSystemNumberLocaleId:()

+ (void) setSystemNumberLocaleId: (NSString *) lId

Set system number locale. If application have system number locale, do nothing. System number locale is return by login task.

Parameters

lId locale id

◆ setupConnectInfoFromPlist:()

+ (void) setupConnectInfoFromPlist: (NSString *) plistFileName

Utility method to set up user preferences from a plist file in SDK based custom applications. The username and password for the project are provided statically in the plist itself. If a duplicate project or a duplicate webserver exists it updates the existing settings from the plist file.

Parameters

plistFileName the name of the resource file that specifies the user's connection information (for example: "ConnectionInfo.plist")

◆ setupConnectInfoFromPlist:withProjUsername:projPassword:()

+ (void) setupConnectInfoFromPlist:	(NSString *)	plistFileName
withProjUsername:	(NSString *)	projUID
projPassword:	(NSString *)	projPwd

Utility method to set up user preferences from a plist file in SDK based custom applications. The username and password for the project are provided at runtime. If a duplicate project or a duplicate webserver exists it updates the existing settings from the plist file.

Parameters

plistFileName	the name of the resource file that specifies the user's connection information (for example: "ConnectionInfo.plist")
projUID	the username for the project
projPwd	the password for the project

◆ shouldUseSafeArea()

+ (BOOL) shouldUseSafeArea

◆ showCoverScreen()

+ (void) showCoverScreen

◆ showDocAuthenticationError:isLocalAuth:delegate:()

+ (void) showDocAuthenticationError:	(NSInteger)	error
isLocalAuth:	(BOOL)	localAuth
delegate:	(id)	delegate

◆ softwareEncryptionEnabled()

+ (BOOL) softwareEncryptionEnabled

◆ stringFromDict:Key:()

+ (NSString*) stringFromDict:	(NSDictionary *)	dictionary
Key:	(NSString *)	key

Returns the string value of the object associated with the key. If not exists returns empty string ""

Parameters

dictionary	dictionary created from connect info plist file
key	key

Returns: string value for the key

◆ supportedOrientationForEvent:()

+ (NSInteger) supportedOrientationForEvent: (NSInteger) eventType

Check the support orientiation for certain type of event.

Returns: supported orientiation iPad device supports both portrait and landscape for all the events. iPhone device supports only portrait for SharedLibrary, HomeScreen, Help, Settings and Status.

Parameters

eventType enum value of EventTypes

Returns: MSTROrientation supported

◆ taskURL:withObjectInfo:()

+ (NSString*) taskURL:	(NSString *)	taskName
withObjectInfo:	(MSIReportDisplayInfo *)	objectInfo

Gets a url string for the task of specified name The objectInfo is required to determine the web server base url, and the web server type (J2EE / ASP) example : http://123.43.43.43:8080/MicroStrategyMobile/servlet/taskProc?taskId=taskName (J2EE) http://123.43.43.43:8080/MicroStrategyMobile/asp/taskProc.aspx?taskId=taskName (ASP)

Parameters

taskName	task name
objectInfo	objectInfo to get the project

Returns: task url

◆ UIGraphicsBeginImageContextByDeviceType:()

+ (void) UIGraphicsBeginImageContextByDeviceType: (CGSize) iSize

◆ webAuthenticationModeForString:()

+ (NSInteger) webAuthenticationModeForString: (NSString *) _authMode

Convert the authentication mode text to enum value.

Parameters

_authMode web server authentication mode text

Returns: enum value of WebAuthModes for the authentication mode

◆ webServerTypeForString:()

+ (NSInteger) webServerTypeForString: (NSString *) appType

Convert the web server type text to enum value.

Parameters

appType web server type text, J2EE or ASP

Returns: enum value for the web server type

Class Methods

Detailed Description

Method Documentation

◆ addSkipBackupAttributeToItemAtURL:()

◆ apiVersion()

◆ applicationFrame()

◆ applicationInterfaceOrientation()

◆ applicationNavigationController()

◆ applicationTopModalViewController()

◆ applicationWindow()

◆ appName()

◆ authenticationModeForString:()

◆ binaryFlag1Info:()

◆ binaryFlag2Info:()

◆ bundleNamed:()

◆ characterSetWithEscapeCharacters:()

◆ createStdButtonWithTitle:backgroundImage:target:action:()

◆ currentNetworkID()

◆ displayErrorInAlertViewWithTitle:message:delegate:dismissPrevious:withOtherButton:okButtonTitle:otherButtonTitle:()

◆ enableTemplateMultiSelection()

◆ errorLabelForDesc:containingViewFrame:()

◆ errorWithErrorDetails:()

◆ finalBundle()

◆ floatFromDict:Key:()

◆ generateScreenShotAboveiOS7:()

◆ getApplicationUID()

◆ getAutoupdatingCurrentCalendar()

◆ getBaseURL:()

◆ getBaseURL:task:()

◆ getBaseURLByProjectConfig:()

◆ getBaseURLByWebServerConfig:()

◆ getCalendar()

◆ getCertificateManager()

◆ getCompleteURL:withBaseURL:()

◆ getCompleteURL:withBaseURL:urlEncodeAbsoluteUrl:()

◆ getCurrentDate()

◆ getCurrentTime()

◆ getDeviceID()

◆ getDeviceType()

◆ getEncryptionKey()

◆ getLaunchImageName:()

◆ getLockImageName:()

◆ getMSTRAppContext()

◆ getNumberAndDateLocale()

◆ getRootFolderDisplayObject:()

◆ getSDKEnvSettings()

◆ getSecureDocumentErrorMessage:authenticationMethod:()

◆ getServletPath:()

◆ getServletPathByProjectConfig:()

◆ getSystemNumberLocale()

◆ getURLEscapeCharacters()

◆ getURLEscapeCharactersForImagePaths()

◆ gmtToCurrentTimezone:()

◆ hideCoverScreen()

◆ imageWithColor:()

◆ imageWithView:()

◆ incrementalFetchSize()

◆ intFromDict:Key:()

◆ iOS4Device()

◆ iOS5OrHigher()

◆ iOS7OrHigher()

◆ iOS8OrHigher()

◆ iOS9OrHigher()

◆ iOSMainVersion()

◆ is4inchScreen()

◆ isAbsoluteURL:()

◆ isBackgroundTransferEnabled()

◆ isDataURL:()

◆ isDeviceiPadAir2()

◆ isDeviceiPadMini4()

◆ isDeviceiPadPro()

◆ isDeviceiPhone5()

◆ isDeviceiPhone6PlusSizeFamily()

◆ isDeviceiPhone6S()

◆ isDeviceiPhone6SizeFamily()

◆ isDeviceiPhoneX()

◆ isDeviceiPhoneXR()

◆ isDeviceiPhoneXRSizeFamily()

◆ isDeviceiPhoneXS()

◆ isDeviceiPhoneXSizeFamily()