forked from dcloudio/uni-app
-
Notifications
You must be signed in to change notification settings - Fork 0
/
UniServiceJSBridge.d.ts
64 lines (64 loc) · 2.22 KB
/
UniServiceJSBridge.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
export interface UniServiceJSBridge {
/**
* 监听 service 层的自定义事件。事件由 emit 触发,回调函数会接收所有传入事件触发函数的额外参数。
* @param event
* @param callback
*/
on(event: string | string[], callback: Function);
/**
* 监听 service 层的自定义事件。仅触发一次,在第一次触发之后移除监听器。
* @param event
* @param callback
*/
once(event: string, callback: Function);
/**
* 移除 service 层的自定义事件监听器。
* 如果没有提供参数,则移除所有的事件监听器;
* 如果只提供了事件,则移除该事件所有的监听器;
* 如果同时提供了事件与回调,则只移除这个回调的监听器。
* @param event
* @param callback
*/
off(event?: string | string[], callback?: Function);
/**
* 触发 Service 层的事件。附加参数都会传给监听器回调。
* @param event
* @param args
*/
emit(event: string, ...args: any[]);
/**
* 订阅 View 的自定义事件,回调函数会接收所有传入事件触发函数的额外参数。
* @param event
* @param callback
*/
subscribe(event: string, callback: Function);
/**
* 取消订阅 View 的自定义事件
* 如果没有提供参数,则移除所有的事件监听器;
* 如果只提供了事件,则移除该事件所有的监听器;
* 如果同时提供了事件与回调,则只移除这个回调的监听器。
* @param event
* @param callback
*/
unsubscribe(event: string, callback?: Function);
/**
* 执行 Service 层 API 回调
* @param callbackId
* @param args
*/
invokeCallbackHandler(callbackId: number, args: any);
/**
* 向 View 层发送事件
* @param event
* @param args
* @param pageId
*/
publishHandler(event: string, args: any, pageId: number);
/**
* 接收 View 层事件(通常由 View 层调用,并暴露至全局 UniServiceJSBridge 对象中)
* @param event
* @param args
* @param pageId
*/
subscribeHandler(event: string, args: any, pageId: number)
}