Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
64695707
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
“20a665917e7b6ebe373dedb2d3ab8252d5857520”上不存在“doc/v2/git@gitcode.net:s920243400/PaddleDetection.git”
提交
64695707
编写于
9月 30, 2022
作者:
L
LVB8189
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Signed-off-by: LVB8189 <lvbai1@huawei.com>
Changes to be committed:
上级
5e908941
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
727 addition
and
21 deletion
+727
-21
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
+140
-16
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
+587
-5
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @
64695707
...
@@ -20,6 +20,11 @@ isScreenLocked(callback: AsyncCallback<boolean>): void
...
@@ -20,6 +20,11 @@ isScreenLocked(callback: AsyncCallback<boolean>): void
判断屏幕是否锁屏,使用callback作为异步方法。
判断屏幕是否锁屏,使用callback作为异步方法。
> **说明:**
> 从API version 9开始废弃。建议使用[screenlock.isScreenLockedSync<sup>9+</sup>](#isScreenLockedSync9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**参数:**
**参数:**
...
@@ -47,6 +52,11 @@ isScreenLocked(): Promise<boolean>
...
@@ -47,6 +52,11 @@ isScreenLocked(): Promise<boolean>
判断屏幕是否锁屏,使用Promise作为异步方法。
判断屏幕是否锁屏,使用Promise作为异步方法。
> **说明:**
> 从API version 9开始废弃。建议使用[screenlock.isScreenLockedSync<sup>9+</sup>](#isScreenLockedSync9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**返回值**
:
**返回值**
:
...
@@ -66,17 +76,44 @@ isScreenLocked(): Promise<boolean>
...
@@ -66,17 +76,44 @@ isScreenLocked(): Promise<boolean>
```
```
## screenlock.isLocked<sup>9+</sup>
isLocked(): boolean;
判断屏幕是否锁屏,使用同步方法。
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**返回值**
:
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回true表示当前屏幕已锁定,返回false表示当前屏幕未锁定。 |
**示例**
:
```
js
screenlock
.
isLocked
().
then
((
data
)
=>
{
console
.
log
(
'
isLocked success: data -> ${JSON.stringify(data)}
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
isLocked fail:err -> ${JSON.stringify(err)}
'
);
});
```
## screenlock.isSecureMode
## screenlock.isSecureMode
isSecureMode(callback: AsyncCallback
<
boolean
>
): void
isSecureMode(callback: AsyncCallback
<
boolean
>
): void
判断设备是否处于安全模式下,使用callback作为异步方法。
判断设备是否处于安全模式下,使用callback作为异步方法。
> **说明:**
> 从API version 9开始废弃。建议使用[screenlock.isSecureModeSync<sup>9+</sup>](#isSecureModeSync9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**参数**
:
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -102,6 +139,11 @@ isSecureMode(): Promise<boolean>
...
@@ -102,6 +139,11 @@ isSecureMode(): Promise<boolean>
判断设备是否处于安全模式下,使用Promise作为异步方法。
判断设备是否处于安全模式下,使用Promise作为异步方法。
> **说明:**
> 从API version 9开始废弃。建议使用[screenlock.isSecureModeSync<sup>9+</sup>](#isSecureModeSync9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**返回值**
:
**返回值**
:
...
@@ -121,17 +163,44 @@ isSecureMode(): Promise<boolean>
...
@@ -121,17 +163,44 @@ isSecureMode(): Promise<boolean>
```
```
## screenlock.isSecure<sup>9+</sup>
isSecure(): boolean;
判断设备是否处于安全模式下,使用同步方法。
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**返回值**
:
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回true表示屏幕处于安全模式下,返回false表示屏幕当前不在安全模式下。 |
**示例**
:
```
js
screenlock
.
isSecure
().
then
((
data
)
=>
{
console
.
log
(
'
isSecure success: data -> ${JSON.stringify(data)}
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
isSecure fail:err -> ${JSON.stringify(err)}
'
);
});
```
## screenlock.unlockScreen
## screenlock.unlockScreen
unlockScreen(callback: AsyncCallback
<
void
>
): void
unlockScreen(callback: AsyncCallback
<
void
>
): void
解锁屏幕,使用callback作为异步方法。
解锁屏幕,使用callback作为异步方法。
> **说明:**
> 从API version 9开始废弃。建议使用[screenlock.unlockScreenWithException<sup>9+</sup>](#unlockScreenWithException9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**参数**
:
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -157,6 +226,11 @@ unlockScreen(): Promise<void>
...
@@ -157,6 +226,11 @@ unlockScreen(): Promise<void>
解锁屏幕,使用Promise作为异步方法。
解锁屏幕,使用Promise作为异步方法。
> **说明:**
> 从API version 9开始废弃。建议使用[screenlock.unlockScreenWithException<sup>9+</sup>](#unlockScreenWithException9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**返回值**
:
**返回值**
:
...
@@ -176,13 +250,63 @@ unlockScreen(): Promise<void>
...
@@ -176,13 +250,63 @@ unlockScreen(): Promise<void>
```
```
## screenlock.
lockScreen
<sup>9+</sup>
## screenlock.
unlock
<sup>9+</sup>
lockScreen
(callback: AsyncCallback
<
boolean
>
): void
unlock
(callback: AsyncCallback
<
boolean
>
): void
解锁屏幕,使用callback作为异步方法。
锁定屏幕,使用callback作为异步方法。
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。返回true表示屏幕解锁成功,返回false表示屏幕解锁失败。 |
**示例**
:
```
js
screenlock
.
unlock
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
unlock error -> ${JSON.stringify(err)}
'
);
return
;
}
console
.
info
(
'
unlock success data -> ${JSON.stringify(data)}
'
);
});
```
## screenlock.unlock<sup>9+</sup>
unlock(): Promise
<
boolean
>
解锁屏幕,使用Promise作为异步方法。
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**返回值**
:
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 以Promise形式返回结果。 |
**示例**
:
```
js
screenlock
.
unlock
().
then
((
data
)
=>
{
console
.
log
(
'
unlock success
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
unlock fail, : err->${JSON.stringify(err)}
'
);
});
```
## screenlock.lock<sup>9+</sup>
lock(callback: AsyncCallback
<
boolean
>
): void
锁定屏幕,使用callback作为异步方法。
**系统能力**
: SystemCapability.MiscServices.ScreenLock
**系统能力**
: SystemCapability.MiscServices.ScreenLock
...
@@ -192,23 +316,23 @@ lockScreen(callback: AsyncCallback<boolean>): void
...
@@ -192,23 +316,23 @@ lockScreen(callback: AsyncCallback<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数
,失败时返回错误信息
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数
。返回true表示屏幕锁定成功,返回false表示屏幕锁定失败
。 |
**示例**
:
**示例**
:
```
js
```
js
screenlock
.
lock
Screen
((
err
)
=>
{
screenlock
.
lock
((
err
)
=>
{
if
(
err
)
{
if
(
err
)
{
console
.
error
(
'
lock
Screen
callback error -> ${JSON.stringify(err)}
'
);
console
.
error
(
'
lock callback error -> ${JSON.stringify(err)}
'
);
return
;
return
;
}
}
console
.
info
(
'
lock
Screen
callback success
'
);
console
.
info
(
'
lock callback success
'
);
});
});
```
```
## screenlock.lock
Screen
<sup>9+</sup>
## screenlock.lock<sup>9+</sup>
lock
Screen
(): Promise
<
boolean
>
lock(): Promise
<
boolean
>
锁定屏幕,使用Promise作为异步方法。
锁定屏幕,使用Promise作为异步方法。
...
@@ -225,10 +349,10 @@ lockScreen(): Promise<boolean>
...
@@ -225,10 +349,10 @@ lockScreen(): Promise<boolean>
**示例**
:
**示例**
:
```
js
```
js
screenlock
.
lock
Screen
().
then
(()
=>
{
screenlock
.
lock
().
then
(()
=>
{
console
.
log
(
'
lock
Screen
success
'
);
console
.
log
(
'
lock success
'
);
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
console
.
error
(
'
lock
Screen
fail, promise: err->${JSON.stringify(err)}
'
);
console
.
error
(
'
lock fail, promise: err->${JSON.stringify(err)}
'
);
});
});
```
```
...
...
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
浏览文件 @
64695707
...
@@ -32,6 +32,11 @@ getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array<Rgba
...
@@ -32,6 +32,11 @@ getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array<Rgba
获取指定类型壁纸的主要颜色信息。
获取指定类型壁纸的主要颜色信息。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getColorsSync<sup>9+</sup>](#getColorsSync9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
**参数:**
...
@@ -60,6 +65,11 @@ getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>
...
@@ -60,6 +65,11 @@ getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>
获取指定类型壁纸的主要颜色信息。
获取指定类型壁纸的主要颜色信息。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getColorsSync<sup>9+</sup>](#getColorsSync9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
**参数:**
...
@@ -85,12 +95,48 @@ getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>
...
@@ -85,12 +95,48 @@ getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>
```
```
## wallpaper.getColorsSync<sup>9+</sup>
getColorsSync(wallpaperType: WallpaperType): Arrayy
<
RgbaColory
<
;
获取指定类型壁纸的主要颜色信息。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
**返回值**
:
| 类型 | 说明 |
| -------- | -------- |
| Array
<
[RgbaColor](#rgbacolor)
>
| 返回壁纸的主要颜色信息。 |
**示例**
:
```
js
wallpaper
.
getColorsSync
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
console
.
log
(
'
success to getColors.
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
failed to getColors because:
'
+
JSON
.
stringify
(
error
));
});
```
## wallpaper.getId
## wallpaper.getId
getId(wallpaperType: WallpaperType, callback: AsyncCallback
<
number
>
): void
getId(wallpaperType: WallpaperType, callback: AsyncCallback
<
number
>
): void
获取指定类型壁纸的ID。
获取指定类型壁纸的ID。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getIdSync<sup>9+</sup>](#getIdSync9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
**参数:**
...
@@ -119,8 +165,12 @@ getId(wallpaperType: WallpaperType): Promise<number>
...
@@ -119,8 +165,12 @@ getId(wallpaperType: WallpaperType): Promise<number>
获取指定类型壁纸的ID。
获取指定类型壁纸的ID。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getIdSync<sup>9+</sup>](#getIdSync9)代替。
>
> 从 API version 7开始支持
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
**参数:**
...
@@ -145,12 +195,47 @@ getId(wallpaperType: WallpaperType): Promise<number>
...
@@ -145,12 +195,47 @@ getId(wallpaperType: WallpaperType): Promise<number>
```
```
## wallpaper.getIdSync<sup>9+</sup>
getIdSync(wallpaperType: WallpaperType): number;
获取指定类型壁纸的ID。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
**返回值**
:
| 类型 | 说明 |
| -------- | -------- |
| number | 返回壁纸的ID。如果配置了这种壁纸类型的壁纸就返回一个大于等于0的数,否则返回-1。取值范围是-1~2^31-1。 |
**示例**
:
```
js
wallpaper
.
getIdSync
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
((
data
)
=>
{
console
.
log
(
'
success to getIdSync:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
failed to getIdSync because:
'
+
JSON
.
stringify
(
error
));
});
##
wallpaper
.
getMinHeight
##
wallpaper
.
getMinHeight
getMinHeight
(
callback
:
AsyncCallback
&
lt
;
number
&
gt
;):
void
getMinHeight
(
callback
:
AsyncCallback
&
lt
;
number
&
gt
;):
void
获取壁纸的最小高度值
。
获取壁纸的最小高度值
。
>
**
说明
:
**
>
从API
version
9
开始废弃
。
建议使用
[
wallpaper
.
getMinHeightSync
<
sup
>
9
+<
/sup>]
(
#getMinHeightSync9
)
代替
。
>
>
从
API
version
7
开始支持
**
系统能力
**
:
SystemCapability
.
MiscServices
.
Wallpaper
**
系统能力
**
:
SystemCapability
.
MiscServices
.
Wallpaper
**
参数
:
**
**
参数
:
**
...
@@ -178,8 +263,12 @@ getMinHeight(): Promise<number>
...
@@ -178,8 +263,12 @@ getMinHeight(): Promise<number>
获取壁纸的最小高度值。
获取壁纸的最小高度值。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getMinHeightSync<sup>9+</sup>](#getMinHeightSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值:**
**返回值:**
...
@@ -198,14 +287,43 @@ getMinHeight(): Promise<number>
...
@@ -198,14 +287,43 @@ getMinHeight(): Promise<number>
```
```
## wallpaper.getMinHeightSync<sup>9+</sup>
getMinHeightSync(): number
获取壁纸的最小高度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回壁纸的最小高度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的高度值代替。 |
**示例:**
```
js
wallpaper.getMinHeightSync().then((data) => {
console.log(
`success to getMinHeightSync: `
+ JSON.stringify(data));
}).catch((error) => {
console.error(
`failed to getMinHeightSync because: `
+ JSON.stringify(error));
});
```
## wallpaper.getMinWidth
## wallpaper.getMinWidth
getMinWidth(callback: AsyncCallback<number>): void
getMinWidth(callback: AsyncCallback<number>): void
获取壁纸的最小宽度值。
获取壁纸的最小宽度值。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getMinWidthSync<sup>9+</sup>](#getMinWidthSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数:**
**参数:**
...
@@ -232,6 +350,11 @@ getMinWidth(): Promise<number>
...
@@ -232,6 +350,11 @@ getMinWidth(): Promise<number>
获取壁纸的最小宽度值。
获取壁纸的最小宽度值。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getMinWidthSync<sup>9+</sup>](#getMinWidthSync9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值:**
**返回值:**
...
@@ -251,12 +374,42 @@ getMinWidth(): Promise<number>
...
@@ -251,12 +374,42 @@ getMinWidth(): Promise<number>
```
```
## wallpaper.getMinWidthSync<sup>9+</sup>
getMinWidthSync(): number
获取壁纸的最小宽度值。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 壁纸的最小宽度值,单位是像素。如果返回值等于0,说明没有设置壁纸,调用者应该使用默认显示的宽度值代替。 |
**示例:**
```
js
wallpaper.getMinWidthSync().then((data) => {
console.log(
`success to getMinWidthSync: `
+ JSON.stringify(data));
}).catch((error) => {
console.error(
`failed to getMinWidthSync because: `
+ JSON.stringify(error));
});
```
## wallpaper.isChangePermitted
## wallpaper.isChangePermitted
isChangePermitted(callback: AsyncCallback<boolean>): void
isChangePermitted(callback: AsyncCallback<boolean>): void
是否允许应用改变当前用户的壁纸。
是否允许应用改变当前用户的壁纸。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.isChangeAllowed<sup>9+</sup>](#isChangeAllowed9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数:**
**参数:**
...
@@ -284,6 +437,11 @@ isChangePermitted(): Promise<boolean>
...
@@ -284,6 +437,11 @@ isChangePermitted(): Promise<boolean>
是否允许应用改变当前用户的壁纸。
是否允许应用改变当前用户的壁纸。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.isChangeAllowed<sup>9+</sup>](#isChangeAllowed9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值:**
**返回值:**
...
@@ -303,12 +461,42 @@ isChangePermitted(): Promise<boolean>
...
@@ -303,12 +461,42 @@ isChangePermitted(): Promise<boolean>
```
```
## wallpaper.isChangeAllowed<sup>9+</sup>
isChangeAllowed(): boolean
是否允许应用改变当前用户的壁纸。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回是否允许应用改变当前用户的壁纸。如果允许返回true,否则返回false。 |
**示例:**
```
js
wallpaper.isChangeAllowed().then((data) => {
console.log(
`success to isChangeAllowed: `
+ JSON.stringify(data));
}).catch((error) => {
console.error(
`failed to isChangeAllowed because: `
+ JSON.stringify(error));
});
```
## wallpaper.isOperationAllowed
## wallpaper.isOperationAllowed
isOperationAllowed(callback: AsyncCallback<boolean>): void
isOperationAllowed(callback: AsyncCallback<boolean>): void
是否允许用户设置壁纸。
是否允许用户设置壁纸。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.isUserChangeAllowed<sup>9+</sup>](#isUserChangeAllowed9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数:**
**参数:**
...
@@ -336,6 +524,11 @@ isOperationAllowed(): Promise<boolean>
...
@@ -336,6 +524,11 @@ isOperationAllowed(): Promise<boolean>
是否允许用户设置壁纸。
是否允许用户设置壁纸。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.isUserChangeAllowed<sup>9+</sup>](#isUserChangeAllowed9)代替。
>
> 从 API version 7开始支持
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值:**
**返回值:**
...
@@ -355,12 +548,42 @@ isOperationAllowed(): Promise<boolean>
...
@@ -355,12 +548,42 @@ isOperationAllowed(): Promise<boolean>
```
```
## wallpaper.isUserChangeAllowed<sup>9+</sup>
isUserChangeAllowed(): boolean
是否允许用户设置壁纸。
**系统能力**: SystemCapability.MiscServices.Wallpaper
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回是否允许用户设置壁纸。如果允许返回true,否则返回false。 |
**示例:**
```
js
wallpaper.isUserChangeAllowed().then((data) => {
console.log(
`success to isUserChangeAllowed: `
+ JSON.stringify(data));
}).catch((error) => {
console.error(
`failed to isUserChangeAllowed because: `
+ JSON.stringify(error));
});
```
## wallpaper.reset
## wallpaper.reset
reset(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
reset(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
移除指定类型的壁纸,恢复为默认显示的壁纸。
移除指定类型的壁纸,恢复为默认显示的壁纸。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.recovery<sup>9+</sup>](#recovery9)代替。
>
> 从 API version 7开始支持
**需要权限**:ohos.permission.SET_WALLPAPER
**需要权限**:ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
...
@@ -391,6 +614,11 @@ reset(wallpaperType: WallpaperType): Promise<void>
...
@@ -391,6 +614,11 @@ reset(wallpaperType: WallpaperType): Promise<void>
移除指定类型的壁纸,恢复为默认显示的壁纸。
移除指定类型的壁纸,恢复为默认显示的壁纸。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.recovery<sup>9+</sup>](#recovery9)代替。
>
> 从 API version 7开始支持
**需要权限**:ohos.permission.SET_WALLPAPER
**需要权限**:ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
...
@@ -418,6 +646,69 @@ reset(wallpaperType: WallpaperType): Promise<void>
...
@@ -418,6 +646,69 @@ reset(wallpaperType: WallpaperType): Promise<void>
```
```
## wallpaper.recovery<sup>9+</sup>
recovery(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
移除指定类型的壁纸,恢复为默认显示的壁纸。
**需要权限**:ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
| callback | AsyncCallback<void> | 是 | 回调函数,调用成功则返回是否移除成功的结果,调用失败则返回error信息。 |
**示例:**
```
js
wallpaper.recovery(wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
if (error) {
console.error(
`failed to recovery because: `
+ JSON.stringify(error));
return;
}
console.log(
`success to recovery.`
);
});
```
## wallpaper.recovery<sup>9+</sup>
recovery(wallpaperType: WallpaperType): Promise<void>
移除指定类型的壁纸,恢复为默认显示的壁纸。
**需要权限**:ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | 调用成功则返回是否移除成功的结果,调用失败则返回error信息。 |
**示例:**
```
js
wallpaper.recovery(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(
`success to recovery.`
);
}).catch((error) => {
console.error(
`failed to recovery because: `
+ JSON.stringify(error));
});
```
## wallpaper.setWallpaper
## wallpaper.setWallpaper
setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
...
@@ -526,12 +817,127 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Pro
...
@@ -526,12 +817,127 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Pro
});
});
```
```
## wallpaper.setImage<sup>9+</sup>
setImage(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
将指定资源设置为指定类型的壁纸。
**需要权限**:ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | string \|[PixelMap](js-apis-image.md#pixelmap7) | | JPEG或PNG文件的Uri路径,或者PNG格式文件的位图。 |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
| callback | AsyncCallback<void> | 是 | 回调函数,调用成功则返回是返回设置的结果,调用失败则返回error信息。 |
**示例:**
```
js
// source类型为string
let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg";
wallpaper.setImage(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
if (error) {
console.error(
`failed to setImage because: `
+ JSON.stringify(error));
return;
}
console.log(
`success to setImage.`
);
});
// source类型为image.PixelMap
import image from '@ohos.multimedia.image';
let imageSource = image.createImageSource("file://" + wallpaperPath);
let opts = {
"desiredSize": {
"height": 3648,
"width": 2736
}
};
imageSource.createPixelMap(opts).then((pixelMap) => {
wallpaper.setImage(pixelMap, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => {
if (error) {
console.error(
`failed to setImage because: `
+ JSON.stringify(error));
return;
}
console.log(
`success to setImage.`
);
});
}).catch((error) => {
console.error(
`failed to createPixelMap because: `
+ JSON.stringify(error));
});
```
## wallpaper.setImage<sup>9+</sup>
setImage(source: string | image.PixelMap, wallpaperType: WallpaperType): Promise<void>
将指定资源设置为指定类型的壁纸。
**需要权限**:ohos.permission.SET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | string \|[PixelMap](js-apis-image.md#pixelmap7) | 是 | JPEG或PNG文件的Uri路径,或者PNG格式文件的位图。 |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | 调用成功则返回是返回设置的结果,调用失败则返回error信息。 |
**示例:**
```
js
// source类型为string
let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg";
wallpaper.setImage(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(
`success to setImage.`
);
}).catch((error) => {
console.error(
`failed to setImage because: `
+ JSON.stringify(error));
});
// source类型为image.PixelMap
import image from '@ohos.multimedia.image';
let imageSource = image.createImageSource("file://" + wallpaperPath);
let opts = {
"desiredSize": {
"height": 3648,
"width": 2736
}
};
imageSource.createPixelMap(opts).then((pixelMap) => {
wallpaper.setImage(pixelMap, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(
`success to setImage.`
);
}).catch((error) => {
console.error(
`failed to setImage because: `
+ JSON.stringify(error));
});
}).catch((error) => {
console.error(
`failed to createPixelMap because: `
+ JSON.stringify(error));
});
```
## wallpaper.getFile<sup>8+</sup>
## wallpaper.getFile<sup>8+</sup>
getFile(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void
getFile(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void
获取指定类型的壁纸文件。
获取指定类型的壁纸文件。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getFileSync<sup>9+</sup>](#getFileSync9)代替。
>
> 从 API version 8开始支持
**需要权限**:ohos.permission.GET_WALLPAPER
**需要权限**:ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
...
@@ -561,6 +967,11 @@ getFile(wallpaperType: WallpaperType): Promise<number>
...
@@ -561,6 +967,11 @@ getFile(wallpaperType: WallpaperType): Promise<number>
获取指定类型的壁纸文件。
获取指定类型的壁纸文件。
> **说明:**
> 从API version 9开始废弃。建议使用[wallpaper.getFileSync<sup>9+</sup>](#getFileSync9)代替。
>
> 从 API version 8开始支持
**需要权限**:ohos.permission.GET_WALLPAPER
**需要权限**:ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统能力**: SystemCapability.MiscServices.Wallpaper
...
@@ -588,6 +999,39 @@ getFile(wallpaperType: WallpaperType): Promise<number>
...
@@ -588,6 +999,39 @@ getFile(wallpaperType: WallpaperType): Promise<number>
```
```
## wallpaper.getFileSync<sup>8+</sup>
getFileSync(wallpaperType: WallpaperType): number;
获取指定类型的壁纸文件。
**需要权限**:ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 调用成功则返回壁纸文件描述符ID,调用失败则返回error信息。 |
**示例:**
```
js
wallpaper.getFileSync(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.log(
`success to getFileSync: `
+ JSON.stringify(data));
}).catch((error) => {
console.error(
`failed to getFileSync because: `
+ JSON.stringify(error));
});
```
## wallpaper.getPixelMap
## wallpaper.getPixelMap
getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback<image.PixelMap>): void;
getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback<image.PixelMap>): void;
...
@@ -654,7 +1098,145 @@ getPixelMap(wallpaperType: WallpaperType): Promise<image.PixelMap>
...
@@ -654,7 +1098,145 @@ getPixelMap(wallpaperType: WallpaperType): Promise<image.PixelMap>
```
```
## wallpaper.on('colorChange')
## wallpaper.getImage<sup>9+</sup>
getImage(wallpaperType: WallpaperType, callback: AsyncCallback<image.PixelMap>): void;
获取壁纸图片的像素图。
**需要权限**:ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统接口**:此接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
| callback | AsyncCallback<void> | 是 | 回调函数,调用成功则返回壁纸图片的像素图大小,调用失败则返回error信息。 |
**示例:**
```
js
wallpaper.getImage(wallpaper.WallpaperType.WALLPAPER_SYSTEM, function (err, data) {
console.info('wallpaperXTS ===> testgetImageCallbackSystem err : ' + JSON.stringify(err));
console.info('wallpaperXTS ===> testgetImageCallbackSystem data : ' + JSON.stringify(data));
});
```
## wallpaper.getImage<sup>9+</sup>
getImage(wallpaperType: WallpaperType): Promise<image.PixelMap>
获取壁纸图片的像素图。
**需要权限**:ohos.permission.GET_WALLPAPER
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统接口**:此接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType | [WallpaperType](#wallpapertype) | 是 | 壁纸类型。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | 调用成功则返回壁纸图片的像素图大小,调用失败则返回error信息。 |
**示例:**
```
js
wallpaper.getImage(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
console.info('wallpaperXTS ===> testgetImagePromiseSystem data : ' + data);
console.info('wallpaperXTS ===> testgetImagePromiseSystem data : ' + JSON.stringify(data));
}).catch((err) => {
console.info('wallpaperXTS ===> testgetImagePromiseSystem err : ' + err);
console.info('wallpaperXTS ===> testgetImagePromiseSystem err : ' + JSON.stringify(err));
});
```
## wallpaper.screenshotLiveWallpaper<sup>9+</sup>
screenshotLiveWallpaper(scale: number, pixelFormat: image.PixelMapFormat, callback: AsyncCallback<image.PixelMap>): void;
截取当前屏幕壁纸,当前暂不支持该功能。
**需要权限**:ohos.permission.CAPTURE_SCREEN
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统接口**:此接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| scale | number | 是 | 图片的缩放模式。 |
| pixelFormat | [PixelMap](js-apis-image.md#PixelMapFormat7) | 是 | 图片像素格式。 |
| callback | AsyncCallback<void> | 是 | 回调函数,调用成功则返回当前壁纸图片的像素图大小,调用失败则返回error信息。 |
**示例:**
```
js
import image from '@ohos.multimedia.image';
var pixelFormat = image.PixelMapFormat.UNKNOWN;
wallpaper.screenshotLiveWallpaper(0, pixelFormat, function (err, data) {
console.info('wallpaperXTS ===> screenShotLiveWallpaperCallback err : ' + JSON.stringify(err));
console.info('wallpaperXTS ===> screenShotLiveWallpaperCallback data : ' + JSON.stringify(data));
});
```
## wallpaper.screenshotLiveWallpaper<sup>9+</sup>
screenshotLiveWallpaper(scale: number, pixelFormat: image.PixelMapFormat): Promise<image.PixelMap>
截取当前屏幕壁纸, 当前暂不支持该功能。
**需要权限**:ohos.permission.CAPTURE_SCREEN
**系统能力**: SystemCapability.MiscServices.Wallpaper
**系统接口**:此接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| scale | number | 是 | 图片的缩放模式。 |
| pixelFormat | [PixelMap](js-apis-image.md#PixelMapFormat7) | 是 | 图片像素格式。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | 调用成功则返回当前壁纸图片的像素图大小,调用失败则返回error信息。 |
**示例:**
```
js
import image from '@ohos.multimedia.image';
var pixelFormat = image.PixelMapFormat.UNKNOWN;
wallpaper.screenshotLiveWallpaper(0, pixelFormat).then((data) => {
console.info('wallpaperXTS ===> screenShotLiveWallpaperPromise data : ' + data);
console.info('wallpaperXTS ===> screenShotLiveWallpaperPromise data : ' + JSON.stringify(data));
}).catch((err) => {
console.info('wallpaperXTS ===> screenShotLiveWallpaperPromise err : ' + err);
console.info('wallpaperXTS ===> screenShotLiveWallpaperPromise err : ' + JSON.stringify(err));
});
```
## wallpaper.on('colorChange')<sup>9+</sup>
on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void
on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void
...
@@ -679,7 +1261,7 @@ on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType
...
@@ -679,7 +1261,7 @@ on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType
```
```
## wallpaper.off('colorChange')
## wallpaper.off('colorChange')
<sup>9+</sup>
off(type: 'colorChange', callback?: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void
off(type: 'colorChange', callback?: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录