Object 内置对象

对象 Service

系统服务管理对象

继承关系

构造函数

Service

系统服务管理对象构造函数

1 2 3
new Service(String name, Function worker, Object event = {});

调用参数:

  • name: String, 服务名称
  • worker: Function, 服务运行函数
  • event: Object, 服务事件处理

静态属性

defaultMaxListeners

Integer, 默认全局最大监听器数

1
static Integer Service.defaultMaxListeners;

成员属性

name

String, 查询和设置服务名称

1
String Service.name;

onstop

Function, 查询和绑定服务停止事件,相当于 on("stop", func);

1
Function Service.onstop;

onpause

Function, 查询和绑定服务暂停事件,相当于 on("pause", func);

1
Function Service.onpause;

oncontinue

Function, 查询和绑定服务恢复事件,相当于 on("continue", func);

1
Function Service.oncontinue;

成员函数

install

安装服务到系统

1 2 3
Service.install(String cmd, String displayName = "", String description = "");

调用参数:

  • cmd: String, 服务命令行
  • displayName: String, 服务显示名称
  • description: String, 服务描述信息

remove

从系统中卸载服务

1
Service.remove();

start

启动服务

1
Service.start();

stop

停止服务

1
Service.stop();

restart

重启服务

1
Service.restart();

run

开始运行服务实体

1
Service.run() async;

isInstalled

检测服务是否安装

1
Boolean Service.isInstalled();

返回结果:

  • Boolean, 服务安装返回 True

isRunning

检测服务是否运行

1
Boolean Service.isRunning();

返回结果:

  • Boolean, 服务运行返回 True

on

绑定一个事件处理函数到对象

1 2
Object Service.on(String ev, Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回成功绑定的数量,如果函数已绑定则返回 0

绑定一个事件处理函数到对象

1
Object Service.on(Object map);

调用参数:

  • map: Object, 指定事件映射关系,对象属性名称将作为事件名称,属性的值将作为事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

addListener

绑定一个事件处理函数到对象

1 2
Object Service.addListener(String ev, Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

绑定一个事件处理函数到对象

1
Object Service.addListener(Object map);

调用参数:

  • map: Object, 指定事件映射关系,对象属性名称将作为事件名称,属性的值将作为事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

prependListener

绑定一个事件处理函数到对象起始

1 2
Object Service.prependListener(String ev, Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回成功绑定的数量,如果函数已绑定则返回 0

绑定一个事件处理函数到对象起始

1
Object Service.prependListener(Object map);

调用参数:

  • map: Object, 指定事件映射关系,对象属性名称将作为事件名称,属性的值将作为事件处理函数

返回结果:

  • Object, 返回成功绑定的数量,如果函数已绑定则返回 0

once

绑定一个一次性事件处理函数到对象,一次性处理函数只会触发一次

1 2
Object Service.once(String ev, Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

绑定一个一次性事件处理函数到对象,一次性处理函数只会触发一次

1
Object Service.once(Object map);

调用参数:

  • map: Object, 指定事件映射关系,对象属性名称将作为事件名称,属性的值将作为事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

prependOnceListener

绑定一个事件处理函数到对象起始

1 2
Object Service.prependOnceListener(String ev, Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回成功绑定的数量,如果函数已绑定则返回 0

绑定一个事件处理函数到对象起始

1
Object Service.prependOnceListener(Object map);

调用参数:

  • map: Object, 指定事件映射关系,对象属性名称将作为事件名称,属性的值将作为事件处理函数

返回结果:

  • Object, 返回成功绑定的数量,如果函数已绑定则返回 0

off

从对象处理队列中取消指定函数

1 2
Object Service.off(String ev, Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

取消对象处理队列中的全部函数

1
Object Service.off(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Object, 返回事件对象本身,便于链式调用

从对象处理队列中取消指定函数

1
Object Service.off(Object map);

调用参数:

  • map: Object, 指定事件映射关系,对象属性名称作为事件名称,属性的值作为事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

removeListener

从对象处理队列中取消指定函数

1 2
Object Service.removeListener(String ev, Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

取消对象处理队列中的全部函数

1
Object Service.removeListener(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Object, 返回事件对象本身,便于链式调用

从对象处理队列中取消指定函数

1
Object Service.removeListener(Object map);

调用参数:

  • map: Object, 指定事件映射关系,对象属性名称作为事件名称,属性的值作为事件处理函数

返回结果:

  • Object, 返回事件对象本身,便于链式调用

removeAllListeners

从对象处理队列中取消所有事件的所有监听器, 如果指定事件,则移除指定事件的所有监听器。

1
Object Service.removeAllListeners(Array evs = []);

调用参数:

  • evs: Array, 指定事件的名称

返回结果:

  • Object, 返回事件对象本身,便于链式调用

setMaxListeners

监听器的默认限制的数量,仅用于兼容

1
Service.setMaxListeners(Integer n);

调用参数:

  • n: Integer, 指定事件的数量

getMaxListeners

获取监听器的默认限制的数量,仅用于兼容

1
Integer Service.getMaxListeners();

返回结果:

  • Integer, 返回默认限制数量

listeners

查询对象指定事件的监听器数组

1
Array Service.listeners(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Array, 返回指定事件的监听器数组

listenerCount

查询对象指定事件的监听器数量

1
Integer Service.listenerCount(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Integer, 返回指定事件的监听器数量

eventNames

查询监听器事件名称

1
Array Service.eventNames();

返回结果:

  • Array, 返回事件名称数组

emit

主动触发一个事件

1 2
Boolean Service.emit(String ev, ...args);

调用参数:

  • ev: String, 事件名称
  • args: ..., 事件参数,将会传递给事件处理函数

返回结果:

  • Boolean, 返回事件触发状态,有响应事件返回 true,否则返回 false

dispose

强制回收对象,调用此方法后,对象资源将立即释放

1
Service.dispose();

equals

比较当前对象与给定的对象是否相等

1
Boolean Service.equals(object expected);

调用参数:

  • expected: object, 制定比较的目标对象

返回结果:

  • Boolean, 返回对象比较的结果

toString

返回对象的字符串表示,一般返回 "[Native Object]",对象可以根据自己的特性重新实现

1
String Service.toString();

返回结果:

  • String, 返回对象的字符串表示

toJSON

返回对象的 JSON 格式表示,一般返回对象定义的可读属性集合

1
Value Service.toJSON(String key = "");

调用参数:

  • key: String, 未使用

返回结果:

  • Value, 返回包含可 JSON 序列化的值