Library Mobile API Reference for iPad  MicroStrategy 2019
FolderModel Class Reference

#import <FolderModel.h>

Inheritance diagram for FolderModel:

Instance Methods

(id) - initWithHomeScreenSettings:
 
(id) - initWithHomeScreenSettings:selectedSystemFolder:
 
(id) - initWithHomeScreenSettings:selectedSystemFolder:backEnabled:
 
(id) - initWithHomeFolder:Project:
 
(id) - initWithHomeFolder:Project:backEnabled:
 
(id) - initWithRestoreState:
 
(void) - selectFolderItemForEditingAtIndexPath:
 
(void) - selectAllFolderItemForEditing
 
(void) - unselectFolderItemForEditingAtIndexPath:
 
(void) - unselectAllFolderItemForEditing
 
(void) - deleteSelectedFolderItemsForEditing
 
(void) - subscribeFolderItemAtIndexPath:
 
(void) - unsubscribeFolderItemAtIndexPath:
 
(void) - selectFolderItemAtFolderPath:
 
(void) - selectFolderItemAtIndexPath:
 
(void) - selectMultipleFolderItemsWithIndexPaths:
 
(void) - enterSearchMode
 
(BOOL) - isSearchMode
 
(BOOL) - isTransitionMode
 
(BOOL) - isLoadMode
 
(void) - inputSearchText:
 
(void) - searchWithPattern:
 
(void) - cancelSearch
 
(void) - cancelCurrentSearch
 
(void) - removeSearchRecordAtIndex:
 
(void) - clearSearchHistory
 
(NSString *) - getCurrentSearchPattern
 
(void) - selectSystemFolderAtIndex:
 
(void) - loadSystemFolderWithType:
 
(void) - refreshSystemFolderNotification
 
(void) - reloadCurrentFolder
 
(void) - reloadCurrentFolderLocally
 
(void) - refreshCurrentFolder
 
(NSIndexPath *) - deleteFolderItemLocally:updateFolderGroup:shouldDeleteSection:
 
(BOOL) - loadSelectedFolderItem
 
(void) - loadFolderItemWithSearchPath:
 
(void) - fetchFolderItemPath:withCompletionHandler:
 
(void) - setSelectedIndexPath:
 
(FolderRestoreState *) - getRestoreState
 
(BOOL) - canSubscribeFolderItemAtIndexPath:
 
(BOOL) - canUnsubscribeFolderItemAtIndexPath:
 
(BOOL) - canSubscribeFolderItem:
 
(BOOL) - canUnsubscribeFolderItem:
 

Properties

id< FolderModelDelegatedelegate
 
EnumFolderSortMethod sortMethod
 
EnumFolderMode folderMode
 
EnumFolderSearchStatus searchStatus
 
bool editing
 
bool refreshing
 
bool loading
 
bool waiting
 
bool selectionChanged
 
int viewStyle
 

Detailed Description

Folder Model, to be continued...

Method Documentation

◆ cancelCurrentSearch()

- (void) cancelCurrentSearch

◆ cancelSearch()

- (void) cancelSearch

◆ canSubscribeFolderItem:()

- (BOOL) canSubscribeFolderItem: (FolderItem *)  folderItem

Provided by category FolderModel(SubscribeFromMobile).

◆ canSubscribeFolderItemAtIndexPath:()

- (BOOL) canSubscribeFolderItemAtIndexPath: (NSIndexPath *)  indexPath

Provided by category FolderModel(SubscribeFromMobile).

◆ canUnsubscribeFolderItem:()

- (BOOL) canUnsubscribeFolderItem: (FolderItem *)  folderItem

Provided by category FolderModel(SubscribeFromMobile).

◆ canUnsubscribeFolderItemAtIndexPath:()

- (BOOL) canUnsubscribeFolderItemAtIndexPath: (NSIndexPath *)  indexPath

Provided by category FolderModel(SubscribeFromMobile).

◆ clearSearchHistory()

- (void) clearSearchHistory

◆ deleteFolderItemLocally:updateFolderGroup:shouldDeleteSection:()

- (NSIndexPath *) deleteFolderItemLocally: (FolderItem *)  folderItem
updateFolderGroup: (BOOL)  updateFolderGroup
shouldDeleteSection: (BOOL *)  shouldDeleteSection 

◆ deleteSelectedFolderItemsForEditing()

- (void) deleteSelectedFolderItemsForEditing

◆ enterSearchMode()

- (void) enterSearchMode

Search

◆ fetchFolderItemPath:withCompletionHandler:()

- (void) fetchFolderItemPath: (FolderItem *)  folderItem
withCompletionHandler: (void(^)(NSArray *folderPath))  completionHandler 

◆ getCurrentSearchPattern()

- (NSString*) getCurrentSearchPattern

◆ getRestoreState()

- (FolderRestoreState*) getRestoreState

◆ initWithHomeFolder:Project:()

- (id) initWithHomeFolder: (MSIObjectInfo *)  folder
Project: (MSIProjectInfo *)  project 

◆ initWithHomeFolder:Project:backEnabled:()

- (id) initWithHomeFolder: (MSIObjectInfo *)  folder
Project: (MSIProjectInfo *)  project
backEnabled: (bool)  backEnabled 

◆ initWithHomeScreenSettings:()

- (id) initWithHomeScreenSettings: (MSIHomeScreenSettings *)  homeScreenSettings

◆ initWithHomeScreenSettings:selectedSystemFolder:()

- (id) initWithHomeScreenSettings: (MSIHomeScreenSettings *)  homeScreenSettings
selectedSystemFolder: (EnumSystemFolderType selectedSystemFolder 

◆ initWithHomeScreenSettings:selectedSystemFolder:backEnabled:()

- (id) initWithHomeScreenSettings: (MSIHomeScreenSettings *)  homeScreenSettings
selectedSystemFolder: (EnumSystemFolderType selectedSystemFolder
backEnabled: (bool)  backEnabled 

◆ initWithRestoreState:()

- (id) initWithRestoreState: (FolderRestoreState *)  restoreState

◆ inputSearchText:()

- (void) inputSearchText: (NSString *)  searchText

◆ isLoadMode()

- (BOOL) isLoadMode

◆ isSearchMode()

- (BOOL) isSearchMode

◆ isTransitionMode()

- (BOOL) isTransitionMode

◆ loadFolderItemWithSearchPath:()

- (void) loadFolderItemWithSearchPath: (NSArray *)  pathToLoad

◆ loadSelectedFolderItem()

- (BOOL) loadSelectedFolderItem

◆ loadSystemFolderWithType:()

- (void) loadSystemFolderWithType: (EnumSystemFolderType systemFolderType

◆ refreshCurrentFolder()

- (void) refreshCurrentFolder

◆ refreshSystemFolderNotification()

- (void) refreshSystemFolderNotification

◆ reloadCurrentFolder()

- (void) reloadCurrentFolder

◆ reloadCurrentFolderLocally()

- (void) reloadCurrentFolderLocally

◆ removeSearchRecordAtIndex:()

- (void) removeSearchRecordAtIndex: (NSInteger)  index

◆ searchWithPattern:()

- (void) searchWithPattern: (NSString *)  searchPattern

◆ selectAllFolderItemForEditing()

- (void) selectAllFolderItemForEditing

◆ selectFolderItemAtFolderPath:()

- (void) selectFolderItemAtFolderPath: (NSInteger)  selectedIndex

◆ selectFolderItemAtIndexPath:()

- (void) selectFolderItemAtIndexPath: (NSIndexPath *)  indexPath

◆ selectFolderItemForEditingAtIndexPath:()

- (void) selectFolderItemForEditingAtIndexPath: (NSIndexPath *)  indexPath

Editable Mode.

◆ selectMultipleFolderItemsWithIndexPaths:()

- (void) selectMultipleFolderItemsWithIndexPaths: (NSArray *)  indexPaths

◆ selectSystemFolderAtIndex:()

- (void) selectSystemFolderAtIndex: (NSInteger)  index

◆ setSelectedIndexPath:()

- (void) setSelectedIndexPath: (NSIndexPath *)  selectedIndexPath

◆ subscribeFolderItemAtIndexPath:()

- (void) subscribeFolderItemAtIndexPath: (NSIndexPath *)  indexPath

Subscription

◆ unselectAllFolderItemForEditing()

- (void) unselectAllFolderItemForEditing

◆ unselectFolderItemForEditingAtIndexPath:()

- (void) unselectFolderItemForEditingAtIndexPath: (NSIndexPath *)  indexPath

◆ unsubscribeFolderItemAtIndexPath:()

- (void) unsubscribeFolderItemAtIndexPath: (NSIndexPath *)  indexPath

Property Documentation

◆ delegate

- (id<FolderModelDelegate>) delegate
readwritenonatomicweak

◆ editing

- (bool) editing
readwritenonatomicassign

◆ folderMode

- (EnumFolderMode) folderMode
readwritenonatomicassign

◆ loading

- (bool) loading
readwritenonatomicassign

◆ refreshing

- (bool) refreshing
readwritenonatomicassign

◆ searchStatus

- (EnumFolderSearchStatus) searchStatus
readwritenonatomicassign

◆ selectionChanged

- (bool) selectionChanged
readwritenonatomicassign

◆ sortMethod

- (EnumFolderSortMethod) sortMethod
readwritenonatomicassign

◆ viewStyle

- (int) viewStyle
readwritenonatomicassign

◆ waiting

- (bool) waiting
readwritenonatomicassign