Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IModulePackageInfo

Overall information about the contents of a module package. This corresponds to all the information collected from manifest.json.

api-version

1

user

Hierarchy

  • IModulePackageInfo

Index

Properties

activated: boolean

Whether the paid module package is activated or not.

api-version

1

user
allowedControllers: string[]

An array of Controller's serial ID which are allowed to install.

api-version

1

user
certificated: boolean

Whether the module has been certificated through Dart-Store.

api-version

1

user
compatibleRobotModels: string[]

An array of compatible Robot's model names.

api-version

1

user
databases: IModuleDatabaseInfo[]

An array of database component info (IModuleDatabaseInfo). Comes from 'databases' of the manifest.json.

api-version

1

user
developer: string

A developer name.

api-version

1

user
drcfModulePackageFile: null | string

A path of framework module package file (.dm)

api-version

1

user
drscModulePackageFile: null | string

A path of user module package file (.dm)

api-version

1

user
frameworkModules: IFrameworkModuleInfo[]

An array of framework module info (IFrameworkModuleInfo). Comes from manifest.json of framework module.

api-version

1

user
icon: string

An icon file path that represented the module package. It must be set as a reference to image resource like as: 'assets/images/icon.png"

api-version

1

user
installedDate: number

The package installed date.

api-version

1

user
isEssentialPackage: boolean

Whether the module package is essential package or not. If it is essential package then the module cannot delete from Dart-Platform.

api-version

1

user
isSystemPackage: boolean

Whether the module package has system permission or not.

api-version

1

user
main: string

A main script file path that is contains a main class which is inherited BaseModule. The script file will be loaded by system on HTML to get a main class of the module.

api-version

1

user
name: string

The name of the module. Comes from 'name' of the manifest.json. It is used to display name on DART-Platform's Home or DART-Store.

api-version

1

user
packageDirPath: string

A directory path where is installed the module package.

api-version

1

user
packageName: string

The unique name of the module package. Comes from 'packageName' of the manifest.json. It is used as unique key to distinguish each module package in DART-Store and DART-Platform. If DART-Store has already an uploaded content as same package name, then you cannot upload your module package.

api-version

1

user
packageSize: number

Size of package in bytes.

api-version

1

user
packageState: number
paid: boolean

Whether paid module package or not.

api-version

1

user
requiredPackageNames: string[]

An array of package name which are needed package to run this. Comes from 'requiredPackageNames' of the manifest.json.

api-version

1

user

An array of screen component info (IModuleScreenInfo). Comes from 'screens' of the manifest.json.

api-version

1

user
sdkVersion: string

An integer designating the DART-API version that the module package targets. Comes from 'skdVersion' of the manifest.json.

api-version

1

user
services: IModuleServiceInfo[]

An array of service component info (IModuleServiceInfo). Comes from 'services' of the manifest.json.

api-version

1

user
supportedLanguages: string[]

A supported language code array that are supported language on this module package. Comes from 'supportedLanguages' of the manifest.json.

api-version

1

user
type: string

The type of the module package. Comes from 'type' of the manifest.json. Available types are:

  • {@link Manifest.USER_TYPE.HOME}
  • {@link Manifest.USER_TYPE.STORE}
  • {@link Manifest.USER_TYPE.RECOVERY}
  • {@link Manifest.USER_TYPE.SETTING}
  • {@link Manifest.USER_TYPE.PROCESS}
  • {@link Manifest.USER_TYPE.TASK_EDITOR}
  • {@link Manifest.USER_TYPE.DEVICE_SETTING}
  • {@link Manifest.USER_TYPE.USER_COMMAND}
  • {@link Manifest.USER_TYPE.JOG}
  • {@link Manifest.USER_TYPE.DASHBOARD}
  • {@link Manifest.USER_TYPE.ETC}
api-version

1

user
updatedDate: number

The package updated date.

api-version

1

user
usesPermissions: string[]

A permissions array that are needed to run this module package. Comes from 'usesPermissions' of the manifest.json.

api-version

1

user
version: string

The version of the module package. Comes from 'version' of the manifest.json. It is used to determine whether one version is more recent than another, with higher numbers indicating more recent versions.

It has a naming rule below as:

  • It must have three segments (one or more dots).
  • Each segment must be consists with only numeric [0-9].
  • We recommend that you follow the Semantic Versioning({major}. {Minor}. {Patch}).
  • (e.g. 1.10.13)
api-version

1

user

Methods

  • compareVersion(version: string): number
  • Compare versions and the desired version for order.

    api-version

    1

    user

    Parameters

    • version: string

      A version to be compared.

    Returns number

    A negative integer, zero, or a positive integer as this version is less than, equal to, or greater than the argument.

  • dump(): string
  • Return information as formatted string about this module package.

    api-version

    1

    user

    Returns string

  • getBuyerAccount(context: Context): null | string
  • An account information of the paid module's buyer.

    api-version

    1

    system

    Parameters

    • context: Context

      A context to check a permission.

    Returns null | string

    An account information or null.

  • getFrameworkModuleSubTypeNames(): null | string[]
  • Get display names about {@link IFrameworkModuleInfo.subType}.

    api-version

    1

    user

    Returns null | string[]

    An array of display name about framework module sub types if package has framework modules, otherwise null.

  • getFrameworkModuleTypeNames(): null | string[]
  • Get display names about {@link IFrameworkModuleInfo.type}.

    api-version

    1

    user

    Returns null | string[]

    An array of display name about framework module types if package has framework modules, otherwise null.

  • getUserModuleTypeName(): null | string
  • Get a display name about type.

    api-version

    1

    user

    Returns null | string

    A display name about user module type if package has a user module, otherwise null.

  • hasPermission(permission: string): boolean
  • Whether the module package has a permission.

    api-version

    1

    user

    Parameters

    • permission: string

      The permission name to check.

    Returns boolean

    Return true if the module package has the permission.

Generated using TypeDoc