MSFPackageInfo

Objective-C


@interface MSFPackageInfo : NSObject {
  void *swigCPtr;
  BOOL swigCMemOwn;
}

Swift

class MSFPackageInfo : NSObject

Information about map package. This includes id, type, version, name, description and size.

  • Checks if this object is equal to the specified object.

    Declaration

    Objective-C

    - (BOOL)isEqual:(id)object;

    Swift

    func isEqual(_ object: Any!) -> Bool

    Parameters

    object

    The reference object.

    Return Value

    True when objects are equal, false otherwise.

  • Returns the hash value of this object.

    Declaration

    Objective-C

    - (NSUInteger)hash;

    Swift

    func hash() -> UInt

    Return Value

    The hash value of this object.

  • Constructs a new package info instance.

    Declaration

    Objective-C

    - (id)initWithPackageId:(NSString *)packageId
            packageType:(enum MSFPackageType)packageType
                version:(int)version
                   size:(unsigned long long)size
              serverURL:(NSString *)serverURL
               tileMask:(MSFPackageTileMask *)tileMask
               metaInfo:(MSFPackageMetaInfo *)metaInfo;

    Swift

    init!(packageId: String!, packageType: MSFPackageType, version: Int32, size: UInt64, serverURL: String!, tileMask: MSFPackageTileMask!, metaInfo: MSFPackageMetaInfo!)

    Parameters

    packageId

    The unique id of the package
    packageType

    The type of the package
    version

    The increasing version number of the package
    size

    Size of the package in bytes
    serverURL

    Location of the package
    tileMask

    The tile mask of the package
    metaInfo

    Package meta info

  • Returns the internal package id. This should not be displayed to the user.

    Declaration

    Objective-C

    - (NSString *)getPackageId;

    Swift

    func getPackageId() -> String!

    Return Value

    The unique package id

  • Returns the package type.

    Declaration

    Objective-C

    - (enum MSFPackageType)getPackageType;

    Swift

    func getPackageType() -> MSFPackageType

    Return Value

    The package type (map, routing, etc)

  • Returns the package version. This should not be displayed to the user.

    Declaration

    Objective-C

    - (int)getVersion;

    Swift

    func getVersion() -> Int32

    Return Value

    The increasing package version number

  • Returns the default name (short description) of the package. It is better to use getNames method instead, as each package may contain multiple names. The name returned is generic name or if that is not available, then English name.

    Declaration

    Objective-C

    - (NSString *)getName;

    Swift

    func getName() -> String!

    Return Value

    The list of names for the package in the specified language (if not available, generic/English names are returned)

  • Returns the names (short description) of the package. This can be displayed to the user. Each package may have multiple names, if the package has multiple classifications. Note: this information is dervied from package meta info, “name_XXX” fields.

    Declaration

    Objective-C

    - (MSFStringVector *)getNames:(NSString *)lang;

    Swift

    func getNames(_ lang: String!) -> MSFStringVector!

    Parameters

    lang

    The language for the name

    Return Value

    The list of names for the package in the specified language (if not available, generic/English names are returned)

  • Returns the size of the package in bytes. This can be displayed to the user.

    Declaration

    Objective-C

    - (unsigned long long)getSize;

    Swift

    func getSize() -> UInt64

    Return Value

    The size of the package in bytes

  • Returns the encoded tile mask of the package. This is available for map packages but not for routing packages. This should not be displayed to the user.

    Declaration

    Objective-C

    - (MSFPackageTileMask *)getTileMask;

    Swift

    func getTileMask() -> MSFPackageTileMask!

    Return Value

    The tile mask of the package

  • Returns package meta info. If package contains no meta info, null is returned.

    Declaration

    Objective-C

    - (MSFPackageMetaInfo *)getMetaInfo;

    Swift

    func getMetaInfo() -> MSFPackageMetaInfo!

    Return Value

    The package meta info.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()