interface.uts 3.3 KB
Newer Older
1

2
export type OnUserCaptureScreenCallbackResult = {
3 4 5 6 7
	/**
		* 错误码
		* 0:成功
		* -1:permission denied(仅Android返回)
		*/
8
	errCode ?: number,
9 10 11
	/**
		* 错误的详细信息
		*/
12
	errMsg ?: string,
13 14 15
	/**
		* 截屏文件路径(仅Android返回)
		*/
16
	path ?: string
17 18
}

19 20 21
/**
	* uni.onUserCaptureScreen/uni.offUserCaptureScreen回调函数定义
	*/
22 23
export type UserCaptureScreenCallback = (res : OnUserCaptureScreenResult) => void

24

25
/**
26
	* uni.onUserCaptureScreen函数定义
27 28
	* 开启截屏监听 
	* 
29
	* @param {UserCaptureScreenCallback} callback 
30 31 32 33
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
	* @since 3.6.8
	*/
34
export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
35

36

37 38 39
/**
	* 关闭截屏监听  
	* 
40
	* @param {UserCaptureScreenCallback} callback 
41 42 43 44
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
	* @since 3.6.8
	*/
45
export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
46

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

/**
	* uni.setUserCaptureScreen成功回调参数
	*/
export type SetUserCaptureScreenSuccess = {
}

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

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

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

/**
 * uni.setUserCaptureScreen完成回调函数定义
 */
export type SetUserCaptureScreenCompleteCallback = (res : any) => void

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

116 117 118
/**
	* 设置防截屏  
	* 
119
	* @param {SetUserCaptureScreenOptions} options 
120 121 122 123
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#setusercapturescreen
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
	* @since 3.7.3
	*/
124
export type SetUserCaptureScreen = (options : SetUserCaptureScreenOptions) => void
125

126

127 128 129 130
interface uni {
	onUserCaptureScreen : OnUserCaptureScreen,
	offUserCaptureScreen : OffUserCaptureScreen,
	setUserCaptureScreen : SetUserCaptureScreen
131
}