Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Message

A Message is a description of an operation to be performed. It can be used with IModulePackageManager.getModulePackageInfo, IModuleScreenManager.startModuleScreen, etc. Execution condition about each component of module package must be defined in messageFilters of manifest.json like as:

"screens": [
  {
      "name": "Jog+",
      "id": "JogPlusMainScreen",
      "messageFilters": [
          {
              "action": "dart.message.action.MAIN",
              "category": "dart.message.category.SCREEN"
          }
      ]
  },
],
api-version

1

user

Hierarchy

  • Message

Index

Constructors

Properties

Constructors

constructor

  • new Message(args?: { action?: string; category?: string; componentId?: string; data?: Record<string, any>; packageName?: string }): Message

  • A constructor to instantiate Message.

    api-version

    1

    user

    Parameters

    • Optional args: { action?: string; category?: string; componentId?: string; data?: Record<string, any>; packageName?: string }
      • Optional action?: string
      • Optional category?: string
      • Optional componentId?: string
      • Optional data?: Record<string, any>
      • Optional packageName?: string

    Returns Message

Properties

Optional action

action?: string

The action to be performed, such as ACTION_MAIN, etc.

api-version

1

user

Optional category

category?: string

Additional information about the action to execute, such as CATEGORY_SCREEN, CATEGORY_SERVICE, etc.

api-version

1

user

Optional componentId

componentId?: string

Specifies an explicit service or screen component id of packageName module. This property should be used with packageName, if not it will be ignored.

api-version

1

user

Optional data

data?: Record<string, any>

The data to operate on the action. It is a {@link Record} with a set of properties key ({@link string}) of value ({@link any}).

api-version

1

user

Optional packageName

packageName?: string

Specifies an explicit module's package name to operate.

api-version

1

user

Static Readonly ACTION_BACKDRIVE

ACTION_BACKDRIVE: "dart.message.action.BACKDRIVE" = "dart.message.action.BACKDRIVE"

ModuleScreen Action: Represents a backdrive screen component in your Backdrive & Recovery module.

Now it is used with:

api-version

1

user

Static Readonly ACTION_DEVICE_SETTINGS_DATABASE_READER

ACTION_DEVICE_SETTINGS_DATABASE_READER: "dart.message.action.DEVICE_SETTINGS_DATABASE_READER" = "dart.message.action.DEVICE_SETTINGS_DATABASE_READER"

IDartDatabase Action: Represents a IDartDatabaseReader which is contains records of 'deviceSettings' table.

Now it is used with:

api-version

1

user

Static Readonly ACTION_GET_REST_APIS_TO_COMMUNICATE_WITH_AI_SERVER

ACTION_GET_REST_APIS_TO_COMMUNICATE_WITH_AI_SERVER: "dart.message.action.GET_REST_APIS_TO_COMMUNICATE_WITH_AI_SERVER" = "dart.message.action.GET_REST_APIS_TO_COMMUNICATE_WITH_AI_SERVER"

ModuleService Action: Represents a service component to provide REST APIs to communicate with 3rd party AI Server.

Now it is used with:

api-version

2

user

Static Readonly ACTION_GNB_SIMULATOR

ACTION_GNB_SIMULATOR: "dart.message.action.GNB_SIMULATOR" = "dart.message.action.GNB_SIMULATOR"

ModuleScreen Action: Represents a GNB simulator screen component in your GNB simulator module.

Now it is used with:

api-version

1

user

Static Readonly ACTION_MAIN

ACTION_MAIN: "dart.message.action.MAIN" = "dart.message.action.MAIN"

ModuleScreen Action: Represent as main screen component. Module screens that ACTION_MAIN and CATEGORY_SCREEN declared together in the messageFilter of manifest.json can be run through icon in the home module.

api-version

1

user

Static Readonly ACTION_RECOVERY

ACTION_RECOVERY: "dart.message.action.RECOVERY" = "dart.message.action.RECOVERY"

ModuleScreen Action: Represents a recovery screen component in your Backdrive & Recovery module.

Now it is used with:

api-version

1

user

Static Readonly ACTION_RUN_PROGRAM

ACTION_RUN_PROGRAM: "dart.message.action.RUN_PROGRAM" = "dart.message.action.RUN_PROGRAM"

ModuleScreen Action: Request a run (DRL) program. When user click the play button on Program Player at footer.

api-version

1

user

Static Readonly CATEGORY_DATABASE

CATEGORY_DATABASE: "dart.message.category.DATABASE" = "dart.message.category.DATABASE"

ModuleService Category: A category for database component.

Now it is used with:

  • custom actions
api-version

1

user

Static Readonly CATEGORY_FULL_SCREEN

CATEGORY_FULL_SCREEN: "dart.message.category.FULL_SCREEN" = "dart.message.category.FULL_SCREEN"

ModuleScreen Category: A category for screen component which should be executed as Full screen.

Now it is used with:

api-version

1

system

Static Readonly CATEGORY_PIP_SCREEN

CATEGORY_PIP_SCREEN: "dart.message.category.PIP_SCREEN" = "dart.message.category.PIP_SCREEN"

ModuleScreen Category: A category for screen component which should be executed as Picture-in-Picture.

Now it is used with:

  • custom actions
api-version

1

user

Static Readonly CATEGORY_POPUP_SCREEN

CATEGORY_POPUP_SCREEN: "dart.message.category.POPUP_SCREEN" = "dart.message.category.POPUP_SCREEN"

ModuleScreen Category: A category for screen component which should be executed as Popup screen.

Now it is used with:

api-version

1

system

Static Readonly CATEGORY_SCREEN

CATEGORY_SCREEN: "dart.message.category.SCREEN" = "dart.message.category.SCREEN"

ModuleScreen Category: A category for screen component.

Now it is used with:

api-version

1

user

Static Readonly CATEGORY_SERVICE

CATEGORY_SERVICE: "dart.message.category.SERVICE" = "dart.message.category.SERVICE"

ModuleService Category: A category for service component.

Now it is used with:

  • custom actions
api-version

1

user

Generated using TypeDoc