提交 47afda52 编写于 作者: DCloud-yyl's avatar DCloud-yyl

usercapturescreen统一interface.uts

上级 4826d827
export type UserCaptureScreenResult = {
export type OnUserCaptureScreenCallbackResult = {
/** /**
* 错误码 * 错误码
* 0:成功 * 0:成功
* -1:permission denied * -1:permission denied(仅Android返回)
* 12001:system not support
* 12010:system internal error
*/ */
errCode : number, errCode ?: number,
/** /**
* 调用API的名称 * 错误的详细信息
*/ */
errSubject : string, errMsg ?: string,
/** /**
* 错误的详细信息 * 截屏文件路径(仅Android返回)
*/ */
errMsg : string, path ?: string
}
/**
* uni.onUserCaptureScreen/uni.offUserCaptureScreen回调函数定义
*/
export type UserCaptureScreenCallback = (res : OnUserCaptureScreenResult) => void
/**
* uni.onUserCaptureScreen函数定义
* 开启截屏监听
*
* @param {UserCaptureScreenCallback} callback
* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 3.6.8
*/
export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
/**
* 关闭截屏监听
*
* @param {UserCaptureScreenCallback} callback
* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 3.6.8
*/
export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
/**
* uni.setUserCaptureScreen成功回调参数
*/
export type SetUserCaptureScreenSuccess = {
} }
export type OnUserCaptureScreenResult = { /**
* uni.setUserCaptureScreen失败回调参数
*/
export type SetUserCaptureScreenFail = {
/** /**
* 错误码 * 错误码
* 0:成功 * 0:成功
* -1:permission denied(仅Android返回) * -1:permission denied
* 12001:system not support
* 12010:system internal error
*/ */
errCode : number, errCode : number,
/** /**
...@@ -32,12 +71,26 @@ export type OnUserCaptureScreenResult = { ...@@ -32,12 +71,26 @@ export type OnUserCaptureScreenResult = {
* 错误的详细信息 * 错误的详细信息
*/ */
errMsg : string, errMsg : string,
/**
* 截屏文件路径(仅Android返回)
*/
path : string | null
} }
/**
* 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 = { export type SetUserCaptureScreenOptions = {
/** /**
* true: 允许用户截屏 false: 不允许用户截屏,防止用户截屏到应用页面内容 * true: 允许用户截屏 false: 不允许用户截屏,防止用户截屏到应用页面内容
...@@ -46,39 +99,20 @@ export type SetUserCaptureScreenOptions = { ...@@ -46,39 +99,20 @@ export type SetUserCaptureScreenOptions = {
/** /**
* 接口调用成功的回调函数 * 接口调用成功的回调函数
*/ */
success ?: (res : UserCaptureScreenResult) => void, //success : SetUserCaptureScreenSuccessCallback | null,
success ?: SetUserCaptureScreenSuccessCallback,
/** /**
* 接口调用失败的回调函数 * 接口调用失败的回调函数
*/ */
fail ?: (res : UserCaptureScreenResult) => void, //fail : SetUserCaptureScreenFailCallback | null,
fail ?: SetUserCaptureScreenFailCallback,
/** /**
* 接口调用结束的回调函数(调用成功、失败都会执行) * 接口调用结束的回调函数(调用成功、失败都会执行)
*/ */
complete ?: (res : UserCaptureScreenResult) => void //complete : SetUserCaptureScreenSuccessCallback |SetUserCaptureScreenFailCallback | null
complete ?: SetUserCaptureScreenCompleteCallback
} }
export type UserCaptureScreenCallback = (res : OnUserCaptureScreenResult) => void
/**
* 开启截屏监听
*
* @param {UserCaptureScreenCallback} callback
* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 3.6.8
*/
export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
/**
* 关闭截屏监听
*
* @param {UserCaptureScreenCallback} callback
* @tutorial https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen
* @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
* @since 3.6.8
*/
export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
/** /**
* 设置防截屏 * 设置防截屏
* *
...@@ -89,9 +123,9 @@ export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) ...@@ -89,9 +123,9 @@ export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null)
*/ */
export type SetUserCaptureScreen = (options : SetUserCaptureScreenOptions) => void export type SetUserCaptureScreen = (options : SetUserCaptureScreenOptions) => void
interface uni { interface uni {
onUserCaptureScreen : OnUserCaptureScreen, onUserCaptureScreen : OnUserCaptureScreen,
offUserCaptureScreen : OffUserCaptureScreen, offUserCaptureScreen : OffUserCaptureScreen,
setUserCaptureScreen : SetUserCaptureScreen setUserCaptureScreen : SetUserCaptureScreen
} }
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册