Library Mobile API Reference for iPhone  MicroStrategy 2019
SessionStateWrapper Class Reference

#import <MSISessionConnectionManager.h>

Inheritance diagram for SessionStateWrapper:

Instance Methods

(id) - initWithSessionState:
 
(id) - initWithSessionState:andSessionID:
 
(BOOL) - isDummyWrapper
 

Properties

NSString * sessionState
 
NSDate * timeStamp
 
BOOL hasMobileRWPrivilege
 
NSString * sessionID
 
NSString * identityToken
 
BOOL isShowingCredentialsPrompt
 

Detailed Description

SessionStateWrapper wraps the session state, the timestamp when the session state is accessed last time and whether the session state has mobile Read Write privilege.

Method Documentation

◆ initWithSessionState:()

- (id) initWithSessionState: (NSString *)  sessionState

Initialize with the session state and set the timestamp as the current time

Parameters
sessionStatesession state
Returns
self

◆ initWithSessionState:andSessionID:()

- (id) initWithSessionState: (NSString *)  sessionState
andSessionID: (NSString *)  sessionID 

Initialize with the session state and set the timestamp as the current time

Parameters
sessionStatesession state
sessionIDsession ID
Returns
self

◆ isDummyWrapper()

- (BOOL) isDummyWrapper

return YES if sessionState.length == 0; only used as placeholder in this case

Property Documentation

◆ hasMobileRWPrivilege

- (BOOL) hasMobileRWPrivilege
readwriteatomic

whether the session state has mobile Read Write privilege Default is NO.

◆ identityToken

- (NSString*) identityToken
readatomiccopy

identity token for collaboration server login

◆ isShowingCredentialsPrompt

- (BOOL) isShowingCredentialsPrompt
readwriteatomic

whether showing credentials prompt for the wrapper's project Default is NO.

◆ sessionID

- (NSString*) sessionID
readatomiccopy

sessionID for RESTful API

◆ sessionState

- (NSString*) sessionState
readatomiccopy

session state

◆ timeStamp

- (NSDate*) timeStamp
readwriteatomiccopy

timestamp when the session state is last accessed Default is current time.