interface.uts 2.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
export type UserCaptureScreenResult = {
	/**
		* 错误码
		* 0:成功
		* 12001:system not support
		* 12010:system internal error
		*/
	errCode : number,
	/**
		* 调用API的名称
		*/
	errSubject : string,
	/**
		* 错误的详细信息
		*/
	errMsg : string,
}

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
export type OnUserCaptureScreenResult = {
	/**
		* 错误码
		* 0:成功
		* -1:permission denied(仅Android返回)
		*/
	errCode : number,
	/**
		* 调用API的名称
		*/
	errSubject : string,
	/**
		* 错误的详细信息
		*/
	errMsg : string,
	/**
		* 截屏文件路径(仅Android返回)
		*/
	path : string | null
}

export type SetUserCaptureScreenOptions = {
41
	/**
42
		* true: 允许用户截屏 false: 不允许用户截屏,防止用户截屏到应用页面内容
43
		*/
44
	enable : boolean;
45 46 47 48 49 50 51 52 53 54 55 56 57 58
	/**
		* 接口调用成功的回调函数
		*/
	success ?: (res : UserCaptureScreenResult) => void,
	/**
		* 接口调用失败的回调函数
		*/
	fail ?: (res : UserCaptureScreenResult) => void,
	/**
		* 接口调用结束的回调函数(调用成功、失败都会执行)
		*/
	complete ?: (res : UserCaptureScreenResult) => void
}

59 60
export type UserCaptureScreenCallback = (res : OnUserCaptureScreenResult) => void

61 62 63
/**
	* 开启截屏监听 
	* 
64
	* @param {UserCaptureScreenCallback} callback 
65 66 67 68
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
	* @since 3.6.8
	*/
69
export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
70 71 72 73

/**
	* 关闭截屏监听  
	* 
74
	* @param {UserCaptureScreenCallback} callback 
75 76 77 78
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
	* @since 3.6.8
	*/
79
export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
80 81 82 83 84 85 86 87 88

/**
	* 设置防截屏  
	* 
	* @param {SetUserCaptureScreenOption} options 
	* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#setusercapturescreen
	* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
	* @since 3.7.3
	*/
89
export type SetUserCaptureScreen = (options : SetUserCaptureScreenOptions) => void
90 91 92 93 94

interface uni {
	onUserCaptureScreen : OnUserCaptureScreen,
	offUserCaptureScreen : OffUserCaptureScreen,
	setUserCaptureScreen : SetUserCaptureScreen
95
}