Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModuleService Abstract

An abstract class to be inherited on a service component class of the module package. Service component is an executable unit on DART-Platform. The service component is managed by IModuleServiceManager;

This component has a lifecycle.

constructor()
     ↓
onStart()
     ↓
onBind()
     ↓
onUnbind()
     ↓
onStop()
api-version

1

user

Hierarchy

  • ModuleService

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Properties

Readonly moduleContext

moduleContext: ModuleContext

An object that is described about an environment of the service component. It is initialized in constructor through props.

api-version

1

user

Methods

onBind

  • Called when a client has been bound to this service component.

    api-version

    1

    system

    Parameters

    Returns boolean

    Return true if you implemented events on the IModuleChannel which is sent as parameter. May return false if the service component doesn't support interface about the {@link message}.

onDataSynchronized

  • onDataSynchronized(): void

  • Called when the module's data have been synchronized. When Dart-Platform gets control, it initializes the Dart-Platform's system and modules internal data to the data that is synchronized with the Controller.

    api-version

    1

    system

    Returns void

onStart

  • onStart(): void

onStop

  • onStop(): void

onUnbind

  • Called when a client has been unbound from this service component.

    api-version

    1

    system

    Parameters

    • message: Message

      A Message the was used to bind to this service component.

    Returns void

Generated using TypeDoc