• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.WallpaperExtensionAbility (WallpaperExtensionAbility)(系统接口)
2
3WallpaperExtensionAbility为壁纸拓展模块,提供应用生命周期回调和监听壁纸变化的能力。
4
5> **说明:**
6>
7> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8>
9> 本模块接口仅可在Stage模型下使用。
10>
11> 本模块接口均为系统接口。
12
13## 导入模块
14
15```ts
16import { WallpaperExtensionAbility } from '@kit.BasicServicesKit';
17```
18
19## WallpaperExtensionAbility.onCreate
20
21onCreate(want: object): void
22
23初始化壁纸拓展应用。在拉起Extension壁纸拓展应用时触发回调,执行初始化应用操作。不支持多线程并发调用。
24
25**系统能力:** SystemCapability.MiscServices.Wallpaper
26
27**系统接口**:此接口为系统接口。
28
29**参数:**
30
31| 参数名 | 类型          | 必填 | 说明                             |
32| ------ | ----------- | ---- | ------------------------------- |
33| want   | [object](../apis-ability-kit/js-apis-app-ability-want.md) | 是   | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
34
35**示例:**
36
37```ts
38import { WallpaperExtensionAbility } from '@kit.BasicServicesKit';
39import { Want } from '@kit.AbilityKit';
40
41class WallpaperExt extends WallpaperExtensionAbility {
42    onCreate(want: Want): void {
43        console.log('onCreate, want:' + want.abilityName);
44    }
45}
46```
47
48## WallpaperExtensionAbility.onWallpaperChange
49
50onWallpaperChange(wallpaperType: number): void
51
52监听壁纸变化。在壁纸变化时触发回调。不支持多线程并发调用。
53
54**系统能力:** SystemCapability.MiscServices.Wallpaper
55
56**系统接口**:此接口为系统接口。
57
58**参数:**
59
60| 参数名 | 类型        | 必填 | 说明                   |
61| ------ | --------- | --- |----------------------|
62| wallpaperType  | number | 是  | 壁纸类型。主屏幕壁纸为0,锁屏壁纸为1。 |
63
64**示例:**
65
66```ts
67import { WallpaperExtensionAbility } from '@kit.BasicServicesKit';
68import { wallpaper } from '@kit.BasicServicesKit';
69
70class WallpaperExt extends WallpaperExtensionAbility {
71    onWallpaperChange(wallpaperType: wallpaper.WallpaperType): void {
72        console.log('onWallpaperChange, wallpaperType:' + wallpaperType);
73    }
74}
75```
76
77## WallpaperExtensionAbility.onDestroy
78
79onDestroy(): void
80
81清理壁纸拓展应用资源。在销毁壁纸拓展应用时触发回调,执行资源清理。不支持多线程并发调用。
82
83**系统能力:** SystemCapability.MiscServices.Wallpaper
84
85**系统接口**:此接口为系统接口。
86
87**示例:**
88
89```ts
90import { WallpaperExtensionAbility } from '@kit.BasicServicesKit';
91
92class WallpaperExt extends WallpaperExtensionAbility {
93    onDestroy(): void {
94        console.log('onDestroy');
95    }
96}
97```
98