Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
9476860e
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
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看板
提交
9476860e
编写于
3月 15, 2023
作者:
W
wangdongqi
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Signed-off-by: wangdongqi <wangdongqi2@huawei.com>
Changes to be committed: Changes to be committed:
上级
d295f420
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
60 addition
and
154 deletion
+60
-154
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
+12
-26
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
+48
-128
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @
9476860e
...
...
@@ -58,6 +58,8 @@ isLocked(): boolean
**系统能力:**
SystemCapability.MiscServices.ScreenLock
**系统接口**
:此接口为系统接口。
**返回值:**
| 类型 | 说明 |
...
...
@@ -70,26 +72,6 @@ isLocked(): boolean
let
isLocked
=
screenlock
.
isLocked
();
```
## screenlock.isSecure<sup>9+</sup>
isSecure(): boolean
判断当前设备的屏幕锁定是否安全(安全屏幕锁定意味着解锁屏幕需要密码、图案或其他用户身份识别)。
**系统能力:**
SystemCapability.MiscServices.ScreenLock
**返回值:**
| 类型 | 说明 |
| ------- | ------------------------------------------------------------ |
| boolean | 返回true表示当前设备的屏幕锁定安全;返回false表示当前设备的屏幕锁定不安全。 |
**示例:**
```
js
let
isSecure
=
screenlock
.
isSecure
();
```
## screenlock.unlock<sup>9+</sup>
unlock(callback: AsyncCallback
<
boolean
>
): void
...
...
@@ -98,6 +80,8 @@ unlock(callback: AsyncCallback<boolean>): void
**系统能力:**
SystemCapability.MiscServices.ScreenLock
**系统接口**
:此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
@@ -132,6 +116,8 @@ unlock(): Promise<boolean>
**系统能力:**
SystemCapability.MiscServices.ScreenLock
**系统接口**
:此接口为系统接口。
**返回值:**
| 类型 | 说明 |
...
...
@@ -347,7 +333,7 @@ isScreenLocked(callback: AsyncCallback<boolean>): void
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃
,建议使用[screenlock.isLocked<sup>9+</sup>](#screenlockislocked9)代替
。
> 从API version 7开始支持,从API version 9开始废弃。
**系统能力:**
SystemCapability.MiscServices.ScreenLock
...
...
@@ -377,7 +363,7 @@ isScreenLocked(): Promise<boolean>
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃
,建议使用[screenlock.isLocked<sup>9+</sup>](#screenlockislocked9)代替
。
> 从API version 7开始支持,从API version 9开始废弃。
**系统能力:**
SystemCapability.MiscServices.ScreenLock
...
...
@@ -405,7 +391,7 @@ isSecureMode(callback: AsyncCallback<boolean>): void
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃
,建议使用[screenlock.isSecure<sup>9+</sup>](#screenlockissecure9)代替
。
> 从API version 7开始支持,从API version 9开始废弃。
**系统能力:**
SystemCapability.MiscServices.ScreenLock
...
...
@@ -435,7 +421,7 @@ isSecureMode(): Promise<boolean>
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃
,建议使用[screenlock.isSecure<sup>9+</sup>](#screenlockissecure9)代替
。
> 从API version 7开始支持,从API version 9开始废弃。
**系统能力:**
SystemCapability.MiscServices.ScreenLock
...
...
@@ -462,7 +448,7 @@ unlockScreen(callback: AsyncCallback<void>): void
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃
,建议使用[screenlock.unlock<sup>9+</sup>](#screenlockunlock9)代替
。
> 从API version 7开始支持,从API version 9开始废弃。
**系统能力:**
SystemCapability.MiscServices.ScreenLock
...
...
@@ -492,7 +478,7 @@ unlockScreen(): Promise<void>
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃
,建议使用[screenlock.unlock<sup>9+</sup>](#screenlockunlock9)代替
。
> 从API version 7开始支持,从API version 9开始废弃。
**系统能力:**
SystemCapability.MiscServices.ScreenLock
...
...
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
浏览文件 @
9476860e
...
...
@@ -14,7 +14,7 @@
import
wallpaper
from
'
@ohos.wallpaper
'
;
```
## WallpaperType
## WallpaperType
<sup>7+</sup>
定义壁纸的枚举类型。
...
...
@@ -26,12 +26,14 @@ import wallpaper from '@ohos.wallpaper';
| WALLPAPER_LOCKSCREEN | 1 |锁屏壁纸标识。 |
## RgbaColor
## RgbaColor
<sup>9+</sup>
定义壁纸颜色信息结构。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| red | number | 是 | 是 | 表示红色值,范围为 0 到 255。 |
...
...
@@ -48,6 +50,8 @@ getColorsSync(wallpaperType: WallpaperType): Array<RgbaColor>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
@@ -71,37 +75,6 @@ try {
}
```
## 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
try
{
let
id
=
wallpaper
.
getIdSync
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
);
console
.
log
(
`success to getIdSync:
${
JSON
.
stringify
(
id
)}
`
);
}
catch
(
error
)
{
console
.
error
(
`failed to getIdSync because:
${
JSON
.
stringify
(
error
)}
`
);
}
```
## wallpaper.getMinHeightSync<sup>9+</sup>
getMinHeightSync(): number
...
...
@@ -110,6 +83,8 @@ getMinHeightSync(): number
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**返回值:**
| 类型 | 说明 |
...
...
@@ -130,6 +105,8 @@ getMinWidthSync(): number
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**返回值:**
| 类型 | 说明 |
...
...
@@ -142,46 +119,6 @@ getMinWidthSync(): number
let
minWidth
=
wallpaper
.
getMinWidthSync
();
```
## wallpaper.isChangeAllowed<sup>9+</sup>
isChangeAllowed(): boolean
是否允许应用改变当前用户的壁纸。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回是否允许应用改变当前用户的壁纸。如果允许返回true,否则返回false。 |
**示例:**
```
js
let
isChangeAllowed
=
wallpaper
.
isChangeAllowed
();
```
## wallpaper.isUserChangeAllowed<sup>9+</sup>
isUserChangeAllowed(): boolean
是否允许用户设置壁纸。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 返回是否允许用户设置壁纸。如果允许返回true,否则返回false。 |
**示例:**
```
js
let
isUserChangeAllowed
=
wallpaper
.
isUserChangeAllowed
();
```
## wallpaper.restore<sup>9+</sup>
restore(wallpaperType: WallpaperType, callback: AsyncCallback
<
void
>
): void
...
...
@@ -192,6 +129,8 @@ restore(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
@@ -221,6 +160,8 @@ restore(wallpaperType: WallpaperType): Promise<void>
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
@@ -253,6 +194,8 @@ setImage(source: string | image.PixelMap, wallpaperType: WallpaperType, callback
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
@@ -306,6 +249,8 @@ setImage(source: string | image.PixelMap, wallpaperType: WallpaperType): Promise
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
@@ -350,39 +295,6 @@ imageSource.createPixelMap(opts).then((pixelMap) => {
});
```
## wallpaper.getFileSync<sup>9+</sup>
getFileSync(wallpaperType: WallpaperType): number;
获取指定类型的壁纸文件。
**需要权限**
:ohos.permission.GET_WALLPAPER
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 调用成功则返回壁纸文件描述符ID,调用失败则返回error信息。 |
**示例:**
```
js
try
{
let
file
=
wallpaper
.
getFileSync
(
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
);
console
.
log
(
`success to getFileSync:
${
JSON
.
stringify
(
file
)}
`
);
}
catch
(
error
)
{
console
.
error
(
`failed to getFileSync because:
${
JSON
.
stringify
(
error
)}
`
);
}
```
## wallpaper.getImage<sup>9+</sup>
getImage(wallpaperType: WallpaperType, callback: AsyncCallback
<
image.PixelMap
>
): void;
...
...
@@ -449,12 +361,16 @@ wallpaper.getImage(wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => {
});
```
## wallpaper.on('colorChange')<sup>
9+
</sup>
## wallpaper.on('colorChange')<sup>
(deprecated)
</sup>
on(type: 'colorChange', callback: (colors: Array
<
RgbaColor
>
, wallpaperType: WallpaperType) =
>
void): void
订阅壁纸颜色变化结果上报事件。
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
...
...
@@ -477,12 +393,16 @@ try {
}
```
## wallpaper.off('colorChange')<sup>
9+
</sup>
## wallpaper.off('colorChange')<sup>
(deprecated)
</sup>
off(type: 'colorChange', callback?: (colors: Array
<
RgbaColor
>
, wallpaperType: WallpaperType) =
>
void): void
取消订阅壁纸颜色变化结果上报事件。
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**参数:**
...
...
@@ -527,7 +447,7 @@ getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array<Rgba
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getColorsSync<sup>9+</sup>](#wallpapergetcolorssync9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -558,7 +478,7 @@ getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getColorsSync<sup>9+</sup>](#wallpapergetcolorssync9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -592,7 +512,7 @@ getId(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getIdSync<sup>9+</sup>](#wallpapergetidsync9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -623,7 +543,7 @@ getId(wallpaperType: WallpaperType): Promise<number>
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getIdSync<sup>9+</sup>](#wallpapergetidsync9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -657,7 +577,7 @@ getMinHeight(callback: AsyncCallback<number>): void
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getMinHeightSync<sup>9+</sup>](#wallpapergetminheightsync9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -687,7 +607,7 @@ getMinHeight(): Promise<number>
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getMinHeightSync<sup>9+</sup>](#wallpapergetminheightsync9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -715,7 +635,7 @@ getMinWidth(callback: AsyncCallback<number>): void
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getMinWidthSync<sup>9+</sup>](#wallpapergetminwidthsync9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -745,7 +665,7 @@ getMinWidth(): Promise<number>
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getMinWidthSync<sup>9+</sup>](#wallpapergetminwidthsync9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -773,7 +693,7 @@ isChangePermitted(callback: AsyncCallback<boolean>): void
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.isChangeAllowed<sup>9+</sup>](#wallpaperischangeallowed9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -803,7 +723,7 @@ isChangePermitted(): Promise<boolean>
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.isChangeAllowed<sup>9+</sup>](#wallpaperischangeallowed9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -831,7 +751,7 @@ isOperationAllowed(callback: AsyncCallback<boolean>): void
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.isUserChangeAllowed<sup>9+</sup>](#wallpaperisuserchangeallowed9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -861,7 +781,7 @@ isOperationAllowed(): Promise<boolean>
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.isUserChangeAllowed<sup>9+</sup>](#wallpaperisuserchangeallowed9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**系统能力**
: SystemCapability.MiscServices.Wallpaper
...
...
@@ -889,7 +809,7 @@ reset(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.restore<sup>9+</sup>](#wallpaperrestore9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**需要权限**
:ohos.permission.SET_WALLPAPER
...
...
@@ -922,7 +842,7 @@ reset(wallpaperType: WallpaperType): Promise<void>
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.restore<sup>9+</sup>](#wallpaperrestore9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**需要权限**
:ohos.permission.SET_WALLPAPER
...
...
@@ -958,7 +878,7 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType, call
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.setImage<sup>9+</sup>](#wallpapersetimage9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**需要权限**
:ohos.permission.SET_WALLPAPER
...
...
@@ -1015,7 +935,7 @@ setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Pro
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.setImage<sup>9+</sup>](#wallpapersetimage9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**需要权限**
:ohos.permission.SET_WALLPAPER
...
...
@@ -1074,7 +994,7 @@ getFile(wallpaperType: WallpaperType, callback: AsyncCallback<number>): vo
> **说明:**
>
> 从 API version 8开始支持,从API version 9开始废弃。
建议使用[wallpaper.getFileSync<sup>9+</sup>](#wallpapergetfilesync9)代替。
> 从 API version 8开始支持,从API version 9开始废弃。
**需要权限**
:ohos.permission.GET_WALLPAPER
...
...
@@ -1107,7 +1027,7 @@ getFile(wallpaperType: WallpaperType): Promise<number>
> **说明:**
>
> 从 API version 8开始支持,从API version 9开始废弃。
建议使用[wallpaper.getFileSync<sup>9+</sup>](#wallpapergetfilesync9)代替。
> 从 API version 8开始支持,从API version 9开始废弃。
**需要权限**
:ohos.permission.GET_WALLPAPER
...
...
@@ -1143,7 +1063,7 @@ getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback<image.Pixel
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getImage<sup>9+</sup>](#wallpapergetimage9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**需要权限**
:ohos.permission.GET_WALLPAPER
...
...
@@ -1178,7 +1098,7 @@ getPixelMap(wallpaperType: WallpaperType): Promise<image.PixelMap>
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃。
建议使用[wallpaper.getImage<sup>9+</sup>](#wallpapergetimage9)代替。
> 从 API version 7开始支持,从API version 9开始废弃。
**需要权限**
:ohos.permission.GET_WALLPAPER
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录