VisioMove-Sample  2.1.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Pages
VgMyRemoteMapManager Class Reference

Responisble for downloading a Visioglobe remote map. More...

Inherits NSObject.

Instance Methods

(id) - initWithApplication:andRemoteMapConfigLoginPassword:andMapDirectory:andLocalTempDir:
 Handles downloading of maps from VisioMapServer (usually mapmanager.visioglobe.com) and VisioMapEditor. More...
 
(id) - initWithApplication:andRemoteMapConfigHash:andMapDirectory:andLocalTempDir:
 Handles downloading of maps from VisioMapServer (and VisioMapEditor) More...
 
(BOOL) - list
 Starts a list request. More...
 
(BOOL) - downloadMap:
 start downloading a remote map. More...
 
(BOOL) - getLocalConfigPathForMap:outParam:
 
(BOOL) - removeLocalMap:
 
(BOOL) - removeLocalMaps
 
(void) - cancel
 Cancel any pending requests. More...
 

Detailed Description

Method Documentation

- (void) cancel

Cancel any pending requests.

- (BOOL) downloadMap: (VgMyMapManagerEntry *)  pEntry

start downloading a remote map.

Remarks
only one map can be downloaded at a time.
Parameters
pEntrycontains the mZipFileURL to download and mMapID to identify map.
Returns
true if the request has been queued.
Version
2.1.5 replace pMapID with pEntry since it using direct URL needs additional informaiton.
- (BOOL) getLocalConfigPathForMap: (NSString *)  pMapID
outParam: (NSString *__autoreleasing *)  pOutConfigPath 
Parameters
pMapIDmap id of the relevant map.
pOutConfigPathoutput parameter that will contain the vg_config path for a given map id.
Returns
true if the path exists and pOutConfigPath was filled.
- (id) initWithApplication: (VgApplication::VgIApplication *)  pVgApplication
andRemoteMapConfigHash: (VgMyRemoteMapManagerConfigHash *)  pConfigHash
andMapDirectory: (NSString *)  pLocalMapsDirectory
andLocalTempDir: (NSString *)  pLocalTemporaryDirectory 

Handles downloading of maps from VisioMapServer (and VisioMapEditor)

Parameters
pVgApplicationVgIApplication. Used to determine internal paths, and license information.
pConfigHashremote map manager configuration.
pLocalMapsDirectorylocal Directory where the maps will be downloaded.
pLocalTemporaryDirectorylocal temporary directory where the remote .zip file will be downloaded.
- (id) initWithApplication: (VgApplication::VgIApplication *)  pVgApplication
andRemoteMapConfigLoginPassword: (VgMyRemoteMapManagerConfigLoginPassword *)  pConfigLoginPassword
andMapDirectory: (NSString *)  pLocalMapsDirectory
andLocalTempDir: (NSString *)  pLocalTemporaryDirectory 

Handles downloading of maps from VisioMapServer (usually mapmanager.visioglobe.com) and VisioMapEditor.

Parameters
pVgApplicationVgIApplication. Used to determine internal paths, and license information.
pConfigLoginPasswordremote map manager configuration that uses login/password.
pLocalMapsDirectorylocal Directory where the maps will be downloaded.
pLocalTemporaryDirectorylocal temporary directory where the remote .zip file will be downloaded.
Deprecated:
prefer to use configuration with hash.
- (BOOL) list

Starts a list request.

Returns
false, if there is a network activity already in progress
- (BOOL) removeLocalMap: (NSString *)  pMapID
- (BOOL) removeLocalMaps

The documentation for this class was generated from the following file:
VisioMove 2.1.5, Visioglobe® 2015