Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
768eae02
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看板
未验证
提交
768eae02
编写于
6月 13, 2023
作者:
O
openharmony_ci
提交者:
Gitee
6月 13, 2023
浏览文件
操作
浏览文件
下载
差异文件
!19509 【wallpaper】add setCustomWallpaper
Merge pull request !19509 from wangdongqi/master
上级
4c2bbc8a
ff794a43
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
82 addition
and
4 deletion
+82
-4
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
+82
-4
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-wallpaper.md
浏览文件 @
768eae02
...
...
@@ -137,9 +137,87 @@ try {
}
```
## wallpaper.setCustomWallpaper<sup>10+</sup>
setCustomWallpaper(source: string, wallpaperType: WallpaperType, callback: AsyncCallback
<
void
>
): void
将指定uri的内容设置为壁纸资源,仅当com.ohos.sceneboard存在时,支持使用该接口。使用callback异步回调。
**需要权限**
:ohos.permission.SET_WALLPAPER
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | string | 是 | 自定义壁纸的Uri路径。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,设置壁纸成功,error为undefined,否则返回error信息。 |
**示例:**
```
js
let
wallpaperPath
=
"
/data/storage/el2/base/haps/entry/files/test.zip
"
;
try
{
wallpaper
.
setCustomWallpaper
(
wallpaperPath
,
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
,
(
error
)
=>
{
if
(
error
)
{
console
.
error
(
`failed to setCustomWallpaper because:
${
JSON
.
stringify
(
error
)}
`
);
return
;
}
console
.
log
(
`success to setCustomWallpaper.`
);
});
}
catch
(
error
)
{
console
.
error
(
`failed to setCustomWallpaper because:
${
JSON
.
stringify
(
error
)}
`
);
}
```
## wallpaper.setCustomWallpaper<sup>10+</sup>
setCustomWallpaper(source: string, wallpaperType: WallpaperType): Promise
<
void
>
将指定uri的内容设置为壁纸资源,仅当com.ohos.sceneboard存在时,支持使用该接口。使用Promise异步回调。
**需要权限**
:ohos.permission.SET_WALLPAPER
**系统能力**
: SystemCapability.MiscServices.Wallpaper
**系统接口**
:此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | string | 是 | 自定义壁纸的Uri路径。 |
| wallpaperType |
[
WallpaperType
](
#wallpapertype
)
| 是 | 壁纸类型。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
let
wallpaperPath
=
"
/data/storage/el2/base/haps/entry/files/test.zip
"
;
try
{
wallpaper
.
setCustomWallpaper
(
wallpaperPath
,
wallpaper
.
WallpaperType
.
WALLPAPER_SYSTEM
).
then
(()
=>
{
console
.
log
(
`success to setCustomWallpaper.`
);
}).
catch
((
error
)
=>
{
console
.
error
(
`failed to setCustomWallpaper because:
${
JSON
.
stringify
(
error
)}
`
);
});
}
catch
(
error
)
{
console
.
error
(
`failed to setCustomWallpaper because:
${
JSON
.
stringify
(
error
)}
`
);
}
```
## wallpaper.on('wallpaperChange')<sup>10+</sup>
on(type: 'wallpaperChange', callback: (wallpaperType: WallpaperType, resourceType: WallpaperResourceType) =
>
void): void
on(type: 'wallpaperChange', callback: (wallpaperType: WallpaperType, resourceType: WallpaperResourceType
, uri?: string
) =
>
void): void
订阅壁纸变化通知事件。
...
...
@@ -152,7 +230,7 @@ on(type: 'wallpaperChange', callback: (wallpaperType: WallpaperType, resourceTyp
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 事件回调类型。支持的事件为'wallpaperChange',完成壁纸切换后触发该事件。 |
| callback | function | 是 | 壁纸变化触发该回调方法,返回壁纸类型和壁纸资源类型。
<br/>
- wallpaperType
<br/>
壁纸类型。
<br/>
- resourceType
<br/>
壁纸资源类型
。 |
| callback | function | 是 | 壁纸变化触发该回调方法,返回壁纸类型和壁纸资源类型。
<br/>
- wallpaperType
:壁纸类型。
<br/>
- resourceType:壁纸资源类型。
<br/>
- uri:壁纸资源地址
。 |
**示例:**
...
...
@@ -169,7 +247,7 @@ try {
## wallpaper.off('wallpaperChange')<sup>10+</sup>
off(type: 'wallpaperChange', callback?: (wallpaperType: WallpaperType, resourceType: WallpaperResourceType) =
>
void): void
off(type: 'wallpaperChange', callback?: (wallpaperType: WallpaperType, resourceType: WallpaperResourceType
, uri?: string
) =
>
void): void
取消订阅壁纸变化通知事件。
...
...
@@ -182,7 +260,7 @@ off(type: 'wallpaperChange', callback?: (wallpaperType: WallpaperType, resourceT
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 事件回调类型。支持的事件为'wallpaperChange',完成壁纸切换后触发该事件。 |
| callback | function | 否 | 表示要取消的壁纸变化回调,不填写该参数则取消订阅该type对应的所有回调。
<br/>
- wallpaperType
<br/>
壁纸类型。
<br/>
- resourceType
<br/>
壁纸资源类型
。 |
| callback | function | 否 | 表示要取消的壁纸变化回调,不填写该参数则取消订阅该type对应的所有回调。
<br/>
- wallpaperType
:壁纸类型。
<br/>
- resourceType:壁纸资源类型。
<br/>
- uri:壁纸资源地址
。 |
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录