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

usercapturescreen统一interface.uts

上级 4826d827
export type UserCaptureScreenResult = {
/**
* 错误码
* 0:成功
* -1:permission denied
* 12001:system not support
* 12010:system internal error
*/
errCode : number,
/**
* 调用API的名称
*/
errSubject : string,
/**
* 错误的详细信息
*/
errMsg : string,
}
export type OnUserCaptureScreenResult = { export type OnUserCaptureScreenCallbackResult = {
/** /**
* 错误码 * 错误码
* 0:成功 * 0:成功
* -1:permission denied(仅Android返回) * -1:permission denied(仅Android返回)
*/ */
errCode : number, errCode ?: number,
/**
* 调用API的名称
*/
errSubject : string,
/** /**
* 错误的详细信息 * 错误的详细信息
*/ */
errMsg : string, errMsg ?: string,
/** /**
* 截屏文件路径(仅Android返回) * 截屏文件路径(仅Android返回)
*/ */
path : string | null path ?: string
}
export type SetUserCaptureScreenOptions = {
/**
* true: 允许用户截屏 false: 不允许用户截屏,防止用户截屏到应用页面内容
*/
enable : boolean;
/**
* 接口调用成功的回调函数
*/
success ?: (res : UserCaptureScreenResult) => void,
/**
* 接口调用失败的回调函数
*/
fail ?: (res : UserCaptureScreenResult) => void,
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete ?: (res : UserCaptureScreenResult) => void
} }
/**
* uni.onUserCaptureScreen/uni.offUserCaptureScreen回调函数定义
*/
export type UserCaptureScreenCallback = (res : OnUserCaptureScreenResult) => void export type UserCaptureScreenCallback = (res : OnUserCaptureScreenResult) => void
/** /**
* uni.onUserCaptureScreen函数定义
* 开启截屏监听 * 开启截屏监听
* *
* @param {UserCaptureScreenCallback} callback * @param {UserCaptureScreenCallback} callback
...@@ -69,6 +33,7 @@ export type UserCaptureScreenCallback = (res : OnUserCaptureScreenResult) => voi ...@@ -69,6 +33,7 @@ export type UserCaptureScreenCallback = (res : OnUserCaptureScreenResult) => voi
*/ */
export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
/** /**
* 关闭截屏监听 * 关闭截屏监听
* *
...@@ -79,6 +44,75 @@ export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null) ...@@ -79,6 +44,75 @@ export type OnUserCaptureScreen = (callback : UserCaptureScreenCallback | null)
*/ */
export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void export type OffUserCaptureScreen = (callback : UserCaptureScreenCallback | null) => void
/**
* 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
}
/** /**
* 设置防截屏 * 设置防截屏
* *
...@@ -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.
先完成此消息的编辑!
想要评论请 注册