harmony 鸿蒙@ohos.WallpaperExtensionAbility (WallpaperExtensionAbility)

2023-10-30
浏览 (435)

@ohos.WallpaperExtensionAbility (WallpaperExtensionAbility)

The WallpaperExtensionAbility module provides lifecycle callbacks for wallpaper extension abilities and APIs for listening for wallpaper changes.

NOTE

The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs of this module can be used only in the stage model.

The APIs provided by this module are system APIs.

Modules to Import

import WallpaperExtensionAbility from '@ohos.WallpaperExtensionAbility';

WallpaperExtensionAbility.onCreate

onCreate(want: object): void

Called to initialize a wallpaper extension ability when it is launched.

System capability: SystemCapability.MiscServices.Wallpaper

Parameters

Name	Type	Mandatory	Description
want	object	Yes	Want information related to the wallpaper extension ability, including the ability name and bundle name.

Example

import WallpaperExtensionAbility from '@ohos.WallpaperExtensionAbility';
import Want from '@ohos.app.ability.Want';

class WallpaperExt extends WallpaperExtensionAbility {
    onCreate(want: Want): void {
        console.log('onCreate, want:' + want.abilityName);
    }
}

WallpaperExtensionAbility.onWallpaperChange

onWallpaperChange(wallpaperType: number): void

Called when the wallpaper changes.

System capability: SystemCapability.MiscServices.Wallpaper

Parameters

Name	Type	Mandatory	Description
wallpaperType	number	Yes	Wallpaper type. 0: home screen wallpaper. 1: lock screen wallpaper.

Example

import WallpaperExtensionAbility from '@ohos.WallpaperExtensionAbility';
import wallpaper from '@ohos.wallpaper';

class WallpaperExt extends WallpaperExtensionAbility {
    onWallpaperChange(wallpaperType: wallpaper.WallpaperType): void {
        console.log('onWallpaperChange, wallpaperType:' + wallpaperType);
    }
}

WallpaperExtensionAbility.onDestroy

onDestroy(): void

Called when this wallpaper extension ability is destroyed to clear resources.

System capability: SystemCapability.MiscServices.Wallpaper

Example

import WallpaperExtensionAbility from '@ohos.WallpaperExtensionAbility';

class WallpaperExt extends WallpaperExtensionAbility {
    onDestroy(): void {
        console.log('onDestroy');
    }
}