BaseDossierService Class Reference

#import <MicroStrategyMobileSDK-Swift.h>

Inheritance diagram for BaseDossierService:

Instance Methods
(void)	- run
(BOOL)	- isSessionExpired:
(void)	- handleError:request:
(void)	- onSuccess:request:
(nonnull instancetype)	- OBJC_DESIGNATED_INITIALIZER
Instance Methods inherited from MSISessionBasedService
(void)	- getSession
(void)	- populateSessionOnRequest:
(BOOL)	- isSessionMissing
Instance Methods inherited from MSIServiceImpl
(NSString *)	- getBaseURL:task:
(void)	- handleData:request:
(void)	- handleError:request:
(void)	- handleDataProgress:total:request:
(void)	- setTaskGroup:
(NSString *)	- sessionState:
(MSIProjectConfiguration *)	- projectConfigForReport:
(void)	- reportException:report:
(void)	- reportError:report:
(NSString *)	- getSessionState:
(MSIProjectConfiguration *)	- getProjectConfig:
(MSIDevicePreferences *)	- getDevicePrefs
(void)	- reportException:project:
(void)	- handleServiceFailedError:withProject:
(void)	- handleUnauthorizedError:forRequest:
(BOOL)	- isSessionExpired:
(void)	- setRequest:
(void)	- resetInnerService
(void)	- threadRun
(void)	- handleClientVersionError:
(void)	- handleObjectNotFoundError:
(void)	- handleSessionExpiredError:

Properties
MSIProjectInfo *_Nullable	project
Properties inherited from MSISessionBasedService
NSString *	sessionState
NSString *	sessionID
BOOL	automaticallyGetSessionStateWhenRun
MSIProjectInfo *	projectInfo
BOOL	ignoreAccessProjectError
MSIServiceImpl *	parentService
MSTRException *	sessionException
ErrorInfo *	sessionErrorInfo
NSInteger	credentialsPromptReturnValue
MSIConnectionManager *	connectionManager
NSInteger	applicationMode
Properties inherited from MSIServiceImpl
id< ServiceHandler >	handler
BOOL	suppressLoginPrompt
id< Service >	innerService

Additional Inherited Members
Protected Attributes inherited from MSIServiceImpl
NSInteger	state
id< MSINetworkRequest >	request
id< ServiceHandler > __weak	handler
TaskGroup *	taskGroup
TaskInfo *	taskInfo
id< Service > __weak	innerService
id< Service >	innerServiceStrongRef
BOOL	suppressNetworkErrorAlerts
NSString *	incrementalFileLocation
double	priority
ClientRequestExecutionHandlerFlags	requestExeFlag
BOOL	makeIncrementalAvailable

Method Documentation

handleError:request:()

- (void) handleError:		(MSTRError *_Null_unspecified)	error
request:		(id< MSINetworkRequest > _Null_unspecified)	request

Implemented in ValidateDossierPageService, UpdateBookmarkService, UpdateDossierService, RenameBookmarkService, MSTRDownloadService, KeepSessionAliveService, GetUserInfoService, GetSingleDossierService, GetUserGroupInfoService, GetPageCacheInfoService, GetPrivilegeService, GetDossierJSONService, GetDossierLibraryService, GetDossierPageService, GetDossierRecommendationsService, GetObjectInfoService, GetDocumentBinaryService, GetDocumentShortcutLightService, GetDocumentViewMediaService, GetDossierCollaborationServerService, GetBookmarksService, ExecuteDossierService, ExecuteDossierPageService, DossierUnregisterDeviceTokenService, DossierRepromptService, DossierRegisterDeviceTokenService, DossierQuickSearchUserAndGroupService, DossierPageManipulationService, DossierGetD3WidgetFilesListService, DossierGetMapConfigService, DossierGetMultiMapConfigService, DossierGetPluginVisListService, DossierGetProjectsService, DossierGetSharedInstanceService, DossierGetCacheBinaryService, DossierGetCollaborationUserListService, DossierGetBinaryDataService, DossierGetAvailableCacheListService, DossierGDDEService, DossierAuthGetIdentityTokenService, DeleteSessionService, DeleteBookmarkService, DeleteDossierService, CreateDossierPersonalViewService, ChangeDossierPageService, and AddBookmarkService.

isSessionExpired:()

- (BOOL) isSessionExpired:

(MSTRError *_Nonnull)

SWIFT_WARN_UNUSED_RESULT

OBJC_DESIGNATED_INITIALIZER()

- (nonnull instancetype) OBJC_DESIGNATED_INITIALIZER

Implemented in ValidateDossierPageService, UpdateBookmarkService, UpdateDossierService, RenameBookmarkService, MSTRDownloadService, KeepSessionAliveService, GetUserInfoService, GetSingleDossierService, GetUserGroupInfoService, GetPageCacheInfoService, GetPrivilegeService, GetDossierJSONService, GetDossierLibraryService, GetDossierPageService, GetDossierRecommendationsService, GetObjectInfoService, GetDocumentBinaryService, GetDocumentShortcutLightService, GetDocumentViewMediaService, GetDossierCollaborationServerService, GenerateDossierBinaryCacheService, GetBookmarksService, ExecuteDossierService, ExecuteDossierPageService, DossierUnregisterDeviceTokenService, DossierRepromptService, DossierRegisterDeviceTokenService, DossierQuickSearchUserAndGroupService, DossierPageManipulationService, DossierGetD3WidgetFilesListService, DossierGetMapConfigService, DossierGetMultiMapConfigService, DossierGetPluginVisListService, DossierGetProjectsService, DossierGetSharedInstanceService, DossierGetCacheBinaryService, DossierGetCollaborationUserListService, DossierGetBinaryDataService, DossierGetAvailableCacheListService, DossierElementsSearchService, DossierGDDEService, DossierBinaryService, DossierAuthGetIdentityTokenService, DeleteSessionService, DeleteBookmarkService, DeleteDossierService, CreateDossierPersonalViewService, ChangeDossierPageService, and AddBookmarkService.

onSuccess:request:()

- (void) onSuccess:		(NSData *_Null_unspecified)	data
request:		(id< MSINetworkRequest > _Null_unspecified)	request

Implemented in DossierBinaryService.

run()

- (void) run

Implements MSIServiceImpl.

Implemented in GetDossierRecommendationsService, and GetDocumentViewMediaService.

Property Documentation

project

- (MSIProjectInfo* _Nullable) project

readwritenonatomicstrong