interface.uts 3.3 KB
Newer Older
1 2 3
/**
	* uni.onUserCaptureScreen/uni.offUserCaptureScreen回调参数
	*/
4
export type OnUserCaptureScreenCallbackResult = {
5 6 7
	/**
		* 截屏文件路径(仅Android返回)
		*/
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 24
	* @since 3.6.8
	*/
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 35
	* @since 3.6.8
	*/
36
export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
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 65
/**
	* uni.setUserCaptureScreen成功回调参数
	*/
export type SetUserCaptureScreenSuccess = {
}

/**
	* uni.setUserCaptureScreen失败回调参数
	*/
export type SetUserCaptureScreenFail = {
	/**
		* 错误码
		* 0:成功
		* 12001:system not support
		* 12010:system internal error
		*/
	errCode : number,
	/**
		* 调用API的名称
		*/
	errSubject : string,
	/**
		* 错误的详细信息
		*/
	errMsg : string,
}

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

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

/**
76 77
	* uni.setUserCaptureScreen完成回调函数定义
	*/
78 79 80 81 82 83 84 85 86 87 88 89 90
export type SetUserCaptureScreenCompleteCallback = (res : any) => void

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

105
/**
106
	* uni.setUserCaptureScreen函数定义
107 108
	* 设置防截屏  
	* 
109
	* @param {SetUserCaptureScreenOptions} options 
110
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#setusercapturescreen
111
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^4.4
112 113
	* @since 3.7.3
	*/
114
export type SetUserCaptureScreen = (options : SetUserCaptureScreenOptions) => void
115

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