VMDFileCollection
Objective-C
@interface VMDFileCollection : NSObject
Swift
class VMDFileCollection : NSObject
A collection of venue map data files
Since
1.1-
The VMD files base directory path
Since
2.0Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nonnull basePath;
Swift
var basePath: String { get set }
-
The venueId
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nonnull venueId;
Swift
var venueId: String { get set }
-
Deprecated
Deprecated since 2.0. Use VMDLegacyFileCollection instead.
Legacy
Since
1.3Warning
Deprecated in 2.0. This property has moved to VMDLegacyFileCollection -
Deprecated
Deprecated since 2.0. Use VMDLegacyFileCollection instead.
Legacy
Since
1.3Warning
Deprecated in 2.0. This property has moved to VMDLegacyFileCollection
-
Create file collection with individual xml, geojson, and custom map info
Declaration
Parameters
mapXmlFile
xml file
mapGeojsonFile
geojson file
customMapInfoJsonFile
custom map info file
Return Value
a file collection
-
-initWithMapXmlFile:
coreGeojsonFile: labelsGeojsonFile: amenitiesGeojsonFile: wayfindingGeojsonFile: customMapInfoJsonFile: Undocumented
Declaration
Objective-C
- (instancetype)initWithMapXmlFile:(id<VMDFile>)mapXmlFile coreGeojsonFile:(id<VMDFile>)coreGeojsonFile labelsGeojsonFile:(nullable id<VMDFile>)labelsGeojsonFile amenitiesGeojsonFile:(nullable id<VMDFile>)amenitiesGeojsonFile wayfindingGeojsonFile:(nullable id<VMDFile>)wayfindingGeojsonFile customMapInfoJsonFile:(nullable id<VMDFile>)customMapInfoJsonFile;
-
Create file collection using root directory containing VMD map files. The names of the files are expected to be:
- map.xml
- map.geojson
customMapInfo.json
Declaration
Objective-C
- (nonnull instancetype)initWithBaseDirectory:(nonnull NSString *)baseDirectory;
Swift
init(baseDirectory: String)
Parameters
baseDirectory
the root directory
Return Value
a file collection
-
Create file collection using a root URL that can be used to build URLs for other VMD files. The names of the files are expected to be:
- map.xml
- map.geojson
customMapInfo.json
Declaration
Objective-C
- (nonnull instancetype)initWithBaseUrl:(nonnull NSURL *)baseUrl;
Swift
init(baseUrl: URL)
Parameters
baseUrl
the base url
Return Value
a file collection
-
Create file colleciton using an XML File and zip file containing other VMD files.
Declaration
Objective-C
- (nonnull instancetype)initWithBasePath:(nonnull NSString *)basePath andVenueId:(nonnull NSString *)venueId;
Swift
init(basePath: String, andVenueId venueId: String)
Parameters
basePath
the base directory path
venueId
the venue id
Return Value
a file collection @since 2.0
-
Create file colleciton using an XML File and zip file containing other VMD files.
Declaration
Objective-C
- (nonnull instancetype)initWithBaseXMLFile:(nonnull id<VMDFile>)mapXmlFile;
Swift
init(baseXMLFile mapXmlFile: VMDFile)
Parameters
mapXmlFile
the xml file
Return Value
a file collection @since 2.0
-
Assigns map zip file to file Collection.
Declaration
Objective-C
- (void)assignZipFileAtPath:(nonnull NSString *)zipDirectory andFilename:(nonnull NSString *)filename;
Swift
func assignZipFile(atPath zipDirectory: String, andFilename filename: String)
Parameters
zipDirectory
the base directory path
filename
the venue id @since 2.0
-
Create file colleciton using a zip file containing other VMD files. The names of the files are expecte to be:
- map.xml
- map.geojson
- customMapInfo.json
Warning
Deprecated in 2.0. Use initWithBasePath instead.
Declaration
Objective-C
- (nonnull instancetype)initWithBaseZipFile:(nonnull id<VMDFile>)mapZipFile;
Swift
init(baseZip mapZipFile: VMDFile)
Parameters
mapZipFile
the zip file
Return Value
a file collection
-
Unzip vmd files from zip file to the specified path
Declaration
Objective-C
- (BOOL)unzipFilesAtPath:(nonnull NSString *)zipPath;
Swift
func unzipFiles(atPath zipPath: String) -> Bool
Parameters
zipPath
the location to unzip files to