#import <MSIDevicePreferences.h>
Class Methods | |
| (MSIDevicePreferences *) | + getDefaultDevicePreferences |
Detailed Description
MSIDevicePreferences holds all of the MicroStrategy preferences, including general settings, connectivity settings, home screen settings and so on.
Method Documentation
◆ getAccentColor()
| - (MSIStringPreference *) getAccentColor |
Use this method to get the accent color
- Returns
- accent color
◆ getAcceptableNetworkResponseTime()
| - (IntegerPreference *) getAcceptableNetworkResponseTime |
Use this method to get the acceptable network response time in seconds. Default is 2 seconds.
- Returns
- the acceptable network response time in seconds.
◆ getAllowAuthenticationViaSystemPasscodeForTouchID()
| - (BooleanPreference *) getAllowAuthenticationViaSystemPasscodeForTouchID |
◆ getAllowSettingsAccess()
| - (BooleanPreference *) getAllowSettingsAccess |
Use this method to get whether settings access is allowed. It's allowed by default.
- Returns
- whether settings access is allowed
◆ getAPPTheme()
| - (IntegerPreference *) getAPPTheme |
◆ getAutoupdateConfiguration()
| - (IntegerPreference *) getAutoupdateConfiguration |
Use this method to get the auto update configuration in minutes. Application will check whether the configuration if updated periodically when the time is reached. The default value is -1, means configuration is not checked.
- Returns
- auto update configuration
◆ getCacheClearMode()
| - (IntegerPreference *) getCacheClearMode |
Use this method to get the cache clear mode Cache clear mode can be CacheClearModeOnClose or CacheClearModeAutomatic. Default value is CacheClearModeAutomatic.
- Returns
- the cache clear mode
◆ getCacheFolders()
| - (BooleanPreference *) getCacheFolders |
Use this method to get whether folder caching is enabled. It's enabled by default. Application will connect to server every time of folder browsing if folder cache is disabled.
- Returns
- whether folders will be cached
◆ getCachePreLoadMode()
| - (IntegerPreference *) getCachePreLoadMode |
Use this method to get the cache preload mode Cache preload mode can be CachePreLoadModeAutomatic or CachePreLoadModeOff. Default value is CachePreLoadModeOff.
- Returns
- cache preload mode
◆ getCacheRealTimeDataTime()
| - (IntegerPreference *) getCacheRealTimeDataTime |
Use this method to get the cache real-time data time. Default is 0.
- Returns
- cache real-time data time in seconds.
◆ getCacheValidationInterval()
| - (IntegerPreference *) getCacheValidationInterval |
Use this method to get the cache validation interval in seconds. Default value is 600. Application will check cache from server when the time interval is reached periodically.
- Returns
- the cache validation interval in seconds.
◆ getCertificateServerURL()
| - (MSIStringPreference *) getCertificateServerURL |
Use this method to get the certificate server url. Default is empty string. Application will connect to certificate server to download certificate.
- Returns
- the certificate server url
◆ getDataWipeOnCertificateError()
| - (BooleanPreference *) getDataWipeOnCertificateError |
Use this method to get whether or not wipe data when client certificate contains error.
- Returns
- whether to wipe data
◆ getDefaultDevicePreferences()
| + (MSIDevicePreferences *) getDefaultDevicePreferences |
◆ getDiagnosticsEnabled()
| - (BooleanPreference *) getDiagnosticsEnabled |
Use this method to get whether diagnostics is enabled. Default is disabled.
- Returns
- whether diagnostics is enabled
◆ getDisableBuiltInPDFViewer()
| - (BooleanPreference *) getDisableBuiltInPDFViewer |
Use this method to get whether the built in PDF viewer is disabled. Default is NO.
- Returns
- whether built in PDF viewer is disabled
◆ getDisableUnavailableLinks()
| - (BooleanPreference *) getDisableUnavailableLinks |
Use this method to get whether unavailable links is disabled. Default is disabled.
- Returns
- whether unavailable links is disabled
◆ getDisplayMyReports()
| - (BooleanPreference *) getDisplayMyReports |
◆ getEnableAnnotation()
| - (BooleanPreference *) getEnableAnnotation |
Use this method to get whether annotation is enabled. Default is YES. If enabled, a annotation option will be displayed in the navigation bar of data controller.
- Returns
- whether annotation is enabled
◆ getEnableBackgroundDownload()
| - (BooleanPreference *) getEnableBackgroundDownload |
Use this method to identify whether to enable background download
- Returns
- whether enable background download
◆ getEnableEmailPrintSave()
| - (BooleanPreference *) getEnableEmailPrintSave |
Use this method to get whether email screen print save is enabled, for new server. Default is YES. A is Enable emailing, annotating and printing in old server B is Enable emailing, printing and saving to photos in new server C is Enable annotating in new server All properties is default YES in both client and server.
#1,if A uncheck, its an old server with disable all features, client will disable both B and C. #2,if A check, it may be old or new, but we will always get right result. For old server , server will not send B and C, client will use default B and C, which is both check. For new server, we will get B and C from the server, which is current behavior for new server.
◆ getEnableEmailScreen()
| - (BooleanPreference *) getEnableEmailScreen |
Use this method to get whether email screen print annotation is enabled for old server. Default is YES.
◆ getEnableFullScreen()
| - (BooleanPreference *) getEnableFullScreen |
Use this method to get whether full screen is enabled. Default is YES. Data controller will show a full screen button if it's enabled.
- Returns
- whether full screen is enabled
◆ getEnableOpenPDF()
| - (BooleanPreference *) getEnableOpenPDF |
Use this method to get whether pdf is enabled to open. Default is YES.
- Returns
- whether pdf is enabled to open
◆ getGridPageCellLimitation()
| - (IntegerPreference *) getGridPageCellLimitation |
◆ getIgnorePrivilegeError()
| - (BooleanPreference *) getIgnorePrivilegeError |
Use this method to get whether privelege error is to be ignored. Default is NO.
- Returns
- whether priveledge error is to be ignored
◆ getIsOfflineMode()
| - (BooleanPreference *) getIsOfflineMode |
Use this method to get offline mode status
- Returns
- the offline mode status
◆ getLearnMoreLink()
| - (MSIStringPreference *) getLearnMoreLink |
Use this method to get the learn more link.
- Returns
- the learn more link.
◆ getLogLevel()
| - (IntegerPreference *) getLogLevel |
Use this method to get the current log level. Default is Warning. Logs will be displayed according to the log level.
- Returns
- the current log level
◆ getMaxGridColumns()
| - (IntegerPreference*) getMaxGridColumns |
Use this method to get the maximum grid columns. IPad default value is 50. IPhone default value is 10.
- Returns
- maximum grid columns supported
◆ getMaxLogEntryCount()
| - (IntegerPreference *) getMaxLogEntryCount |
Use this method to get the number of max log entries stored on device. Default value is 250.
- Returns
- maximum log count stored
◆ getMaxPDFSize()
| - (IntegerPreference *) getMaxPDFSize |
Use this method to get the maximum pdf size supported by the application in kilo pixels. Default value is 2048.
- Returns
- maximum pdf size suppported by the application
◆ getMaxStatusCount()
| - (IntegerPreference *) getMaxStatusCount |
Use this method to get the max number of status entries stored on device Default value is 50.
- Returns
- max status count
◆ getMaxStatusInterval()
| - (IntegerPreference *) getMaxStatusInterval |
Use this method to get the number of days corresponding to the time period before a status entry is deleted from the status store Default value is 7 days.
- Returns
- max status interval
◆ getMonitorNetworkStatus()
| - (BooleanPreference *) getMonitorNetworkStatus |
Use this method to get the monitor network status setting
- Returns
- the monitor network status
◆ getNetworkTimeout()
| - (IntegerPreference*) getNetworkTimeout |
Use this method to get the network timeout, in seconds, after which network request will be terminated. Default value is 60.
- Returns
- network timeout
◆ getNeverPersistCredentials()
| - (BooleanPreference *) getNeverPersistCredentials |
Use this method to get whether don't persist credentials. The default value is NO (the original behavior in pre-9.3 releases), which means that credentials are saved in Preferences.xml from one app session to the next.
- Returns
- whether don't persist credentials
◆ getPasswordExpiration()
| - (IntegerPreference *) getPasswordExpiration |
Use this method to get the password expiration limit in minutes. Login and password will be cleared if expiration time is reached. Default value is -1 means password won't expire.
- Returns
- the password expiration limit in minutes.
◆ getProjectConfiguration:()
| - (MSIProjectConfiguration*) getProjectConfiguration: | (MSIProjectInfo *) | project |
Use this method to get the ProjectConfiguration from the ProjectInfo object. If it is not found, returns nil.
- Parameters
-
project project
- Returns
- ProjectConfiguration
◆ getProjectConfigurationByProjectID:()
| - (MSIProjectConfiguration*) getProjectConfigurationByProjectID: | (NSString *) | projectID |
Use this method to get the ProjectConfiguration from the ProjectID. If it is not found, returns nil.
- Parameters
-
projectID projectID
- Returns
- ProjectConfiguration
◆ getProjectConfigurationByProjectID:serverUrl:()
| - (MSIProjectConfiguration*) getProjectConfigurationByProjectID: | (NSString *) | projectID | |
| serverUrl: | (NSString *) | serverUrl | |
◆ getProjectConfigurationByProjectName:()
| - (MSIProjectConfiguration*) getProjectConfigurationByProjectName: | (NSString *) | projectName |
Use this method to get the ProjectConfiguration from the ProjectName. If it is not found, returns nil.
- Parameters
-
projectName projectName
- Returns
- ProjectConfiguration
◆ getPromptsRequiredFirst:()
| - (BooleanPreference *) getPromptsRequiredFirst: | (MSIProjectInfo *) | project |
◆ getPushNotificationMode()
| - (IntegerPreference *) getPushNotificationMode |
Use this method to get the push notification mode The push notification mode can be on or off. Default is PushNotificationOff.
- Returns
- the push notification mode
◆ getShouldClearCacheOnLogOut()
| - (BooleanPreference *) getShouldClearCacheOnLogOut |
Use this method to identify whether should clear cache after users log out
- Returns
- whether should clear cache after users log out
◆ getShouldDisplayLogOutOption()
| - (BooleanPreference *) getShouldDisplayLogOutOption |
Use this method to identify whether to allow users to log out
- Returns
- whether allow users to log out
◆ getShouldShowTimestampOptions()
| - (BooleanPreference *) getShouldShowTimestampOptions |
◆ getShowAuthenticationErrorDuringReconcile()
| - (BooleanPreference *) getShowAuthenticationErrorDuringReconcile |
◆ getShowCache()
| - (BooleanPreference *) getShowCache |
Use this method to get whether to show cache section in the advanced settings page. Default is YES.
- Returns
- whether to show cache
◆ getShowCachedLoginOnAuthenticationPrompt()
| - (BooleanPreference *) getShowCachedLoginOnAuthenticationPrompt |
Use this method to get whether we need to show cached login on authentication prompt
- Returns
- whether cached login should be shown
◆ getShowDiagnostic()
| - (BooleanPreference *) getShowDiagnostic |
Use this method to get whether to show diagnostics section in the advanced settings page. Default is YES.
- Returns
- whether to show diagnostics
◆ getShowLearnMoreLink()
| - (BooleanPreference *) getShowLearnMoreLink |
Use this method to get whether show learn link.
- Returns
- whether show learn link
◆ getShowLogging()
| - (BooleanPreference *) getShowLogging |
Use this method to whether to show logging section in the advanced settings page. Default is YES.
- Returns
- whether to show logging
◆ getStartWeekday()
| - (IntegerPreference *) getStartWeekday |
Use this method to get the weekday to start week on. Default is -1, means user hasn't set it and we should get the value by [NSCalendar autoupdatingCalendar].firstweekday. Logs will be displayed according to the log level.
- Returns
- -1 or the weekday number use set (between 1 to 7)
◆ getSubscriptionCheckInterval()
| - (IntegerPreference *) getSubscriptionCheckInterval |
Use this method to get the subscription check interval in seconds. Default value is 600. Application will check subscription from server when the time interval is reached periodically.
- Returns
- the subscription check interval in seconds.
◆ getThemeTest()
| - (IntegerPreference *) getThemeTest |
◆ getUseCertificateServer()
| - (BooleanPreference *) getUseCertificateServer |
Use this method to get whether to use certificate server. Default is NO.
- Returns
- whether to use certificate server
◆ getUseExternalAppToOpenKeynote()
| - (BooleanPreference *) getUseExternalAppToOpenKeynote |
Use this method to get whether we need to use external application to open keynote files
- Returns
- whether we need to use external app or not
◆ getWebServerConfiguration:()
| - (WebServerConfiguration*) getWebServerConfiguration: | (WebServerInfo *) | server |
Use this method to get the WebServerConfiguration from the WebServerInfo object. If it is not found, returns nil.
- Parameters
-
webserver webserver
- Returns
- WebServerConfiguration
◆ getWebServers()
| - (WebServerList*) getWebServers |
Use this method to get list of web servers connected by the application
- Returns
- list of webservers
◆ setPreference:forKey:()
| - (void) setPreference: | (id) | preference | |
| forKey: | (NSString *) | fKey | |
