Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Context Abstract

An abstract class to information about an environment. It supports APIs to interact with DART-Platform's system.

api-version

1

user

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

  • new Context(packageName: string, componentId: string): Context

Properties

Readonly componentId

componentId: string

The component id. If the context is inherits SystemContext then this is set as 'system'.

api-version

1

user

Readonly packageName

packageName: string

The unique name of the module package. If the context is inherits SystemContext then this is set as 'system'.

api-version

1

user

Static Readonly AI_MANAGER

AI_MANAGER: "AiManager" = "AiManager"

Use with getSystemManager to retrieve IAiManager.

api-version

2

user

Static Readonly ARCWELDING_MANAGER

ARCWELDING_MANAGER: "ArcweldingManager" = "ArcweldingManager"

Use with getSystemManager to retrieve IArcweldingManager.

api-version

2

user

Static Readonly AUTHORITY_MANGER

AUTHORITY_MANGER: "AuthorityManager" = "AuthorityManager"

Use with getSystemManager to retrieve IAuthorityManager.

api-version

1

user

Static Readonly CLIPBOARD_MANAGER

CLIPBOARD_MANAGER: "ClipboardManager" = "ClipboardManager"

Use with getSystemManager to retrieve IClipboardManager.

api-version

2

system

Static Readonly COMMUNICATION_MANAGER

COMMUNICATION_MANAGER: "CommunicationManager" = "CommunicationManager"

Use with getSystemManager to retrieve ICommunicationManager.

api-version

1

user

Static Readonly CONFIGURATION_MANAGER

CONFIGURATION_MANAGER: "ConfigurationManager" = "ConfigurationManager"

Use with getSystemManager to retrieve IConfigurationManager.

api-version

1

user

Static Readonly DART_BRIDGE_MANAGER

DART_BRIDGE_MANAGER: "DartBridgeManager" = "DartBridgeManager"

Use with getSystemManager to retrieve IDartBridgeManager.

api-version

3

system

Static Readonly DART_DATABASE

DART_DATABASE: "dart_database" = "dart_database"

Use with getSystemLibrary to retrieve IDartDatabase. It enables interacting with the file system in Windows, linux, macOS and Android.

api-version

1

user

Static Readonly DART_FILE_SYSTEM

DART_FILE_SYSTEM: "dart_file_system" = "dart_file_system"

Use with getSystemLibrary to retrieve IDartFileSystem. It enables interacting with the file system in Windows, linux, macOS and Android.

api-version

1

user

Static Readonly DART_IDE_MANAGER

DART_IDE_MANAGER: "DartIdeManager" = "DartIdeManager"

Use with getSystemManager to retrieve IDartIdeManager.

api-version

1

system

Static Readonly DART_PROCESS

DART_PROCESS: "dart_process" = "dart_process"

Use with getSystemLibrary to retrieve IDartProcess.ts The library provide APIs to control process.

api-version

1

system

Static Readonly DART_STORE_MANAGER

DART_STORE_MANAGER: "DartStoreManager" = "DartStoreManager"

Use with getSystemManager to retrieve IDartStoreManager.

api-version

1

system

Static Readonly DEV_MANAGER

DEV_MANAGER: "DevManager" = "DevManager"

Use with getSystemManager to retrieve IDevManager.

api-version

1

system

Static Readonly EXTERNAL_PROCESS

EXTERNAL_PROCESS: "external_process" = "external_process"

Use with getSystemLibrary to retrieve IExternalProcess.ts The library provide APIs to control process.

api-version

2

system

Static Readonly FILE_PICKER

FILE_PICKER: "file_picker" = "file_picker"

Use with getSystemLibrary to retrieve IFilePicker. The library provide APIs to get file from local storage.

api-version

2

user

Static Readonly MATH_LIBRARY

MATH_LIBRARY: "MathLib" = "MathLib"

Use with getSystemLibrary to retrieve IMathLibrary.

api-version

1

user

Static Readonly MEASURE_MANAGER

MEASURE_MANAGER: "MeasureManager" = "MeasureManager"

Use with getSystemManager to retrieve IMeasureManager.

api-version

1

user

Static Readonly MODULE_PACKAGE_MANAGER

MODULE_PACKAGE_MANAGER: "ModulePackageManager" = "ModulePackageManager"

Use with getSystemManager to retrieve IModulePackageManager.

api-version

1

user

Static Readonly MODULE_SCREEN_MANAGER

MODULE_SCREEN_MANAGER: "ModuleScreenManager" = "ModuleScreenManager"

Use with getSystemManager to retrieve IModuleScreenManager.

api-version

1

user

Static Readonly MODULE_SERVICE_MANAGER

MODULE_SERVICE_MANAGER: "ModuleServiceManager" = "ModuleServiceManager"

Use with getSystemManager to retrieve IModuleServiceManager.

api-version

1

user

Static Readonly MOTION_MANAGER

MOTION_MANAGER: "MotionManager" = "MotionManager"

Use with getSystemManager to retrieve IMotionManager.

api-version

1

user

Static Readonly NETWORK_MANAGER

NETWORK_MANAGER: "NetworkManager" = "NetworkManager"

Use with getSystemManager to retrieve INetworkManager.

api-version

1

user

Static Readonly POSITION_MANAGER

POSITION_MANAGER: "PositionManager" = "PositionManager"

Use with getSystemManager to retrieve IPositionManager.

api-version

1

user

Static Readonly PROGRAM_MANAGER

PROGRAM_MANAGER: "ProgramManager" = "ProgramManager"

Use with getSystemManager to retrieve IProgramManager.

api-version

1

user

Static Readonly RESET_RESTORE_MANAGER

RESET_RESTORE_MANAGER: "ResetAndRestoreManager" = "ResetAndRestoreManager"

Use with getSystemManager to retrieve IResetAndRestoreManager.

api-version

1

system

Static Readonly ROBOT_MANAGER

ROBOT_MANAGER: "RobotManager" = "RobotManager"

Use with getSystemManager to retrieve IRobotManager.

api-version

1

user

Static Readonly ROBOT_PARAMETER_MANAGER

ROBOT_PARAMETER_MANAGER: "RobotParameterManager" = "RobotParameterManager"

Use with getSystemManager to retrieve IRobotParameterManager.

api-version

1

user

Static Readonly SAFETYPASSWORD_MANAGER

SAFETYPASSWORD_MANAGER: "SafetyPasswordManager" = "SafetyPasswordManager"

Use with getSystemManager to retrieve ISafetyPasswordManager.

api-version

1

user

Static Readonly TCP_SOCKET_LIBRARY

TCP_SOCKET_LIBRARY: "TcpSocketLibrary" = "TcpSocketLibrary"

Use with getSystemLibrary to retrieve ITcpSocketLibrary.

api-version

2

user

Static Readonly UPDATE_AND_RESTORE_MANAGER

UPDATE_AND_RESTORE_MANAGER: "UpdateAndRestoreManager" = "UpdateAndRestoreManager"

Use with getSystemManager to retrieve IUpdateAndRestoreManager.

api-version

1

system

Static Readonly USER_MANAGER

USER_MANAGER: "UserManager" = "UserManager"

Use with getSystemManager to retrieve IUserManager.

api-version

1

user

Methods

Abstract getString

  • getString(stringResourceName: string, options?: string | TOptions<{}>): string

  • Return the string value associated with a particular resource ID. It will be stripped of any styled text information.

    api-version

    3

    user

    Parameters

    • stringResourceName: string

      The desired resource key name.

    • Optional options: string | TOptions<{}>

      Options i18next options (https://www.i18next.com/).

    Returns string

    A string matched with {@link stringResourceName}.

Abstract getSystemLibrary

  • getSystemLibrary(name: string, options?: any): any

Abstract getSystemManager

Abstract setConfigurations

  • setConfigurations(configs: { i18n?: i18n; stringResources?: Resource; t?: TFunction<string, undefined> }): Promise<void>

  • Whether the context has been destroyed or not.

    api-version

    3

    system

    Parameters

    • configs: { i18n?: i18n; stringResources?: Resource; t?: TFunction<string, undefined> }
      • Optional i18n?: i18n
      • Optional stringResources?: Resource
      • Optional t?: TFunction<string, undefined>

    Returns Promise<void>

Generated using TypeDoc