interface.uts 3.3 KB
Newer Older
1 2 3
/**
	* uni.onUserCaptureScreen/uni.offUserCaptureScreen回调参数
	*/
4
export type OnUserCaptureScreenCallbackResult = {
5
	/**
6
		* 截屏文件路径(仅Android返回)
7
		*/
8
	path ?: string
9 10
}

11 12 13
/**
	* uni.onUserCaptureScreen/uni.offUserCaptureScreen回调函数定义
	*/
14
export type UserCaptureScreenCallback = (res : OnUserCaptureScreenCallbackResult) => void
15

16
/**
17
	* uni.onUserCaptureScreen函数定义
18 19
	* 开启截屏监听 
	* 
20
	* @param {UserCaptureScreenCallback} callback 
21
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen
22
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^4.4
23
	* @since 3.7.7
24
	*/
25
export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
26 27

/**
28
	* uni.offUserCaptureScreen函数定义
29 30
	* 关闭截屏监听  
	* 
31
	* @param {UserCaptureScreenCallback} callback 
32
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen
33
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^4.4
34
	* @since 3.7.7
35
	*/
36
export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
37

38 39 40 41 42 43 44 45 46 47
/**
	* uni.setUserCaptureScreen成功回调参数
	*/
export type SetUserCaptureScreenSuccess = {
}

/**
	* uni.setUserCaptureScreen失败回调参数
	*/
export type SetUserCaptureScreenFail = {
48 49
	/**
		* 错误码
50 51
		* 12001:system not support
		* 12010:system internal error
52 53 54 55 56 57 58 59 60 61 62 63
		*/
	errCode : number,
	/**
		* 调用API的名称
		*/
	errSubject : string,
	/**
		* 错误的详细信息
		*/
	errMsg : string,
}

64
/**
65 66
	* uni.setUserCaptureScreen成功回调函数定义
	*/
67 68 69
export type SetUserCaptureScreenSuccessCallback = (res : SetUserCaptureScreenSuccess) => void

/**
70 71
	* uni.setUserCaptureScreen失败回调函数定义
	*/
72 73 74
export type SetUserCaptureScreenFailCallback = (res : SetUserCaptureScreenFail) => void

/**
75 76
	* uni.setUserCaptureScreen完成回调函数定义
	*/
77 78 79 80 81
export type SetUserCaptureScreenCompleteCallback = (res : any) => void

/**
	* uni.setUserCaptureScreen参数
	*/
lizhongyi_'s avatar
lizhongyi_ 已提交
82

83
export type SetUserCaptureScreenOptions = {
84
	/**
85 86
	* true: 允许用户截屏 false: 不允许用户截屏,防止用户截屏到应用页面内容
	*/
87
	enable : boolean;
88
	/**
89 90
	* 接口调用成功的回调函数
	*/
91
	// success : SetUserCaptureScreenSuccessCallback | null,
92
	success ?: SetUserCaptureScreenSuccessCallback,
93
	/**
94 95
	* 接口调用失败的回调函数
	*/
96
	// fail : SetUserCaptureScreenFailCallback | null,
97
	fail ?: SetUserCaptureScreenFailCallback,
98
	/**
99 100
	* 接口调用结束的回调函数(调用成功、失败都会执行)
	*/
101
	// complete : SetUserCaptureScreenSuccessCallback | SetUserCaptureScreenFailCallback | null
102
	complete ?: SetUserCaptureScreenCompleteCallback
103 104 105
}


lizhongyi_'s avatar
lizhongyi_ 已提交
106 107
/**
 * * uni.setUserCaptureScreen函数定义
108 109 110

	* 设置防截屏  
	* 
111
	* @param {SetUserCaptureScreenOptions} options 
112
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#setusercapturescreen
113
	* @platforms APP-IOS = ^13.0,APP-ANDROID = ^4.4
114
	* @since 3.7.7
115
	*/
116
export type SetUserCaptureScreen = (options : SetUserCaptureScreenOptions) => void
117

118
export interface Uni {
119 120 121
	onUserCaptureScreen : OnUserCaptureScreen,
	offUserCaptureScreen : OffUserCaptureScreen,
	setUserCaptureScreen : SetUserCaptureScreen
122
}