SDKEnvSettings Class Reference

#import <MSIGeneric.h>

Inheritance diagram for SDKEnvSettings:

Instance Methods
(void)	- setServerParam:forKey:
(NSArray *)	- getServerParamKeys
(NSString *)	- getServerParamForKey:
(void)	- removeServerParamForKey:
(void)	- clearServerParams
(void)	- setValue:forHTTPHeaderField:
(NSArray *)	- getHTTPHeaderFields
(NSString *)	- valueForHTTPHeaderField:
(void)	- removeHTTPHeaderField:
(void)	- clearHTTPHeaderFields

Properties
BOOL	isUserDeviceUUID
BOOL	isEnforceShowCloseForRetry
BOOL	isNavBarItemsSuppressed
BOOL	isEnforceEnableDocumentZoom
BOOL	isUsingFBConnect
CGFloat	zoomFactor

Detailed Description

SDKEnvSettings allows user to control some behavior of MicroStrategy SDK by expose settings to SDK user. SDK user can set settings value, and SDK will use these settings inside.

Method Documentation

clearHTTPHeaderFields()

- (void) clearHTTPHeaderFields

Remove all customized request headers

clearServerParams()

- (void) clearServerParams

Remove all server parameters

getHTTPHeaderFields()

- (NSArray *) getHTTPHeaderFields

Get all fields in the customized request header dictionary.

Returns

all fields

getServerParamForKey:()

- (NSString*) getServerParamForKey:

(NSString *)

aKey

Get a server parameter value for a key

Parameters

aKey

key

Returns

value

getServerParamKeys()

- (NSArray *) getServerParamKeys

Get all keys in the server parameters dictionary.

Returns

all keys

removeHTTPHeaderField:()

- (void) removeHTTPHeaderField:

(NSString *)

field

Remove a customized request header value for a field

Parameters

field

field

removeServerParamForKey:()

- (void) removeServerParamForKey:

(NSString *)

aKey

Remove a server parameter value for a key

Parameters

aKey

key

setServerParam:forKey:()

- (void) setServerParam:		(NSString *)	aValue
forKey:		(NSString *)	aKey

Use this property to get or set the facebook app id. If facebook connect is enabled, fbConnectAppID must to specified. set extra parameter used by server login task

Parameters

aValue	parameter value
aKey	parameter key

setValue:forHTTPHeaderField:()

- (void) setValue:		(NSString *)	value
forHTTPHeaderField:		(NSString *)	field

set customized request header for network requests

Parameters

value	customized request header's value
field	customized request header's field

valueForHTTPHeaderField:()

- (NSString*) valueForHTTPHeaderField:

(NSString *)

field

Get a customized request header value for a field

Parameters

field

field

Returns

value

Property Documentation

isEnforceEnableDocumentZoom

- (BOOL) isEnforceEnableDocumentZoom

readwriteatomic

Use this property to enable document zoom which will overwrite the document level setting of enabling zoom by pinch or double tap.

isEnforceShowCloseForRetry

- (BOOL) isEnforceShowCloseForRetry

readwriteatomic

Use this property to determine whether to show a "Close" button in an alert besides the "Retry" button when execution document fails. Default is NO.

isNavBarItemsSuppressed

- (BOOL) isNavBarItemsSuppressed

readwriteatomic

Use this property to determine whether the button items in the navigation bar of data controller is hidden. Default is NO.

isUserDeviceUUID

- (BOOL) isUserDeviceUUID

readwriteatomic

Use this property to determine whether to send the device UUID to server in the login request. Server side can do statistic analysis about operations from a device. Default is NO. By default, device UUID is sent only when it's connecting to MicroStrategy demo project.

isUsingFBConnect

- (BOOL) isUsingFBConnect

readwriteatomic

Use this property to determine whether facebook connect is enabled. If enabled, there will be a new "Facebook" authentication mode for project. Default is NO.

zoomFactor

- (CGFloat) zoomFactor

readwriteatomic

Use this property to set the zoom factor of the document view Default is 1.