1 Star 0 Fork 3.9K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.wallpaper.d.ts 27.73 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645
/*
* Copyright (c) 2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit BasicServicesKit
*/
import {AsyncCallback} from './@ohos.base';
import image from './@ohos.multimedia.image';
/**
* System wallpaper
*
* @namespace wallpaper
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
*/
declare namespace wallpaper {
/**
* RgbaColor definition
*
* @typedef RgbaColor
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
interface RgbaColor {
/**
* The range is 0 to 255.
*
* @type { number }
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
red: number;
/**
* The range is 0 to 255.
*
* @type { number }
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
green: number;
/**
* The range is 0 to 255.
*
* @type { number }
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
blue: number;
/**
* The range is 0 to 255.
*
* @type { number }
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
alpha: number;
}
/**
* Indicates wallpaper type.
*
* @enum { number } WallpaperType
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
*/
enum WallpaperType {
/**
* Indicates the home screen wallpaper.
*
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
*/
WALLPAPER_SYSTEM,
/**
* Indicates the lock screen wallpaper.
*
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
*/
WALLPAPER_LOCKSCREEN
}
/**
* Indicates the resource type of the wallpaper.
*
* @enum { number } WallpaperResourceType
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
enum WallpaperResourceType {
/**
* Indicates the default wallpaper resource.
*
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
DEFAULT,
/**
* Indicates the picture wallpaper resource.
*
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
PICTURE,
/**
* Indicates the video wallpaper resource.
*
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
VIDEO,
/**
* Indicates the package wallpaper resource.
*
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
PACKAGE
}
/**
* Obtains the wallpaper colors for the wallpaper of the specified type. Returns rgbaColor type of array callback function.
*
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<Array<RgbaColor>> } callback - the callback of getColors.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function getColors(wallpaperType: WallpaperType, callback: AsyncCallback<Array<RgbaColor>>): void;
/**
* Obtains the wallpaper colors for the wallpaper of the specified type. Returns rgbaColor type of array callback function.
*
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<Array<RgbaColor>> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function getColors(wallpaperType: WallpaperType): Promise<Array<RgbaColor>>;
/**
* Obtains the wallpaper colors for the wallpaper of the specified type. Returns rgbaColor type of array callback function.
*
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Array<RgbaColor> } the Array<RgbaColor> returned by the function.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function getColorsSync(wallpaperType: WallpaperType): Array<RgbaColor>;
/**
* Obtains the ID of the wallpaper of the specified type. Returns an integer greater than or equal to {@code 0} representing the wallpaper ID.
* if the specified type of wallpaper has been set; returns {@code -1} otherwise. The return value is an integer ranging from -1 to 2^31 - 1.
*
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<number> } callback - the callback of getId.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function getId(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void;
/**
* Obtains the ID of the wallpaper of the specified type. Returns an integer greater than or equal to {@code 0} representing the wallpaper ID.
* if the specified type of wallpaper has been set; returns {@code -1} otherwise. The return value is an integer ranging from -1 to 2^31 - 1.
*
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<number> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function getId(wallpaperType: WallpaperType): Promise<number>;
/**
* Obtains a file of the wallpaper of the specified type. Returns the file descriptor.
* When usage is complete, the caller needs to close the file descriptor in time.
*
* @permission ohos.permission.GET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<number> } callback - the callback of getFile.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 8
* @deprecated since 9
*/
function getFile(wallpaperType: WallpaperType, callback: AsyncCallback<number>): void;
/**
* Obtains a file of the wallpaper of the specified type. Returns the file descriptor.
* When usage is complete, the caller needs to close the file descriptor in time.
*
* @permission ohos.permission.GET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<number> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 8
* @deprecated since 9
*/
function getFile(wallpaperType: WallpaperType): Promise<number>;
/**
* Obtains the minimum height of the wallpaper. in pixels. returns 0 if no wallpaper has been set.
*
* @param { AsyncCallback<number> } callback - the callback of getMinHeight.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function getMinHeight(callback: AsyncCallback<number>): void;
/**
* Obtains the minimum height of the wallpaper. in pixels. returns 0 if no wallpaper has been set.
*
* @returns { Promise<number> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function getMinHeight(): Promise<number>;
/**
* Obtains the minimum height of the wallpaper. in pixels. returns 0 if no wallpaper has been set.
*
* @returns { number } the number returned by the function.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function getMinHeightSync(): number;
/**
* Obtains the minimum width of the wallpaper. in pixels. returns 0 if no wallpaper has been set.
*
* @param { AsyncCallback<number> } callback - the callback of getMinWidth.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function getMinWidth(callback: AsyncCallback<number>): void;
/**
* Obtains the minimum width of the wallpaper. in pixels. returns 0 if no wallpaper has been set.
*
* @returns { Promise<number> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function getMinWidth(): Promise<number>;
/**
* Obtains the minimum width of the wallpaper. in pixels. returns 0 if no wallpaper has been set.
*
* @returns { number } the number returned by the function.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function getMinWidthSync(): number;
/**
* Checks whether to allow the application to change the wallpaper for the current user.
* Returns true if the application is allowed to set a wallpaper for the current user. returns false otherwise.
*
* @param { AsyncCallback<boolean> } callback - the callback of isChangePermitted.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function isChangePermitted(callback: AsyncCallback<boolean>): void;
/**
* Checks whether to allow the application to change the wallpaper for the current user.
* Returns true if the application is allowed to set a wallpaper for the current user. returns false otherwise.
*
* @returns { Promise<boolean> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function isChangePermitted(): Promise<boolean>;
/**
* Checks whether a user is allowed to set wallpapers.
* Returns true if a user is allowed to set wallpapers. returns false otherwise.
*
* @param { AsyncCallback<boolean> } callback - the callback of isOperationAllowed.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function isOperationAllowed(callback: AsyncCallback<boolean>): void;
/**
* Checks whether a user is allowed to set wallpapers.
* Returns true if a user is allowed to set wallpapers. returns false otherwise.
*
* @returns { Promise<boolean> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function isOperationAllowed(): Promise<boolean>;
/**
* Removes a wallpaper of the specified type and restores the default one.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<void> } callback - the callback of reset.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function reset(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void;
/**
* Removes a wallpaper of the specified type and restores the default one.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function reset(wallpaperType: WallpaperType): Promise<void>;
/**
* Removes a wallpaper of the specified type and restores the default one.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<void> } callback - the callback of restore.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function restore(wallpaperType: WallpaperType, callback: AsyncCallback<void>): void;
/**
* Removes a wallpaper of the specified type and restores the default one.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function restore(wallpaperType: WallpaperType): Promise<void>;
/**
* Sets a wallpaper of the specified type based on the uri path from a JPEG or PNG file or the pixel map of a PNG file.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { string | image.PixelMap } source - indicates the uri path from a JPEG or PNG file or the pixel map of the PNG file.
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<void> } callback - the callback of setWallpaper.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function setWallpaper(
source: string | image.PixelMap,
wallpaperType: WallpaperType,
callback: AsyncCallback<void>
): void;
/**
* Sets a wallpaper of the specified type based on the uri path from a JPEG or PNG file or the pixel map of a PNG file.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { string | image.PixelMap } source - indicates the uri path from a JPEG or PNG file or the pixel map of the PNG file.
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function setWallpaper(source: string | image.PixelMap, wallpaperType: WallpaperType): Promise<void>;
/**
* Sets a wallpaper of the specified type based on the uri path from a JPEG or PNG file or the pixel map of a PNG file.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { string | image.PixelMap } source - indicates the uri path from a JPEG or PNG file or the pixel map of the PNG file.
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<void> } callback - the callback of setImage.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function setImage(source: string | image.PixelMap, wallpaperType: WallpaperType, callback: AsyncCallback<void>): void;
/**
* Sets a wallpaper of the specified type based on the uri path from a JPEG or PNG file or the pixel map of a PNG file.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { string | image.PixelMap } source - indicates the uri path from a JPEG or PNG file or the pixel map of the PNG file.
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function setImage(source: string | image.PixelMap, wallpaperType: WallpaperType): Promise<void>;
/**
* Obtains the default pixel map of a wallpaper of the specified type. Returns the default pixel map.
*
* @permission ohos.permission.GET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<image.PixelMap> } callback - the callback of getPixelMap.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
*/
function getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback<image.PixelMap>): void;
/**
* Obtains the default pixel map of a wallpaper of the specified type. Returns the default pixel map.
*
* @permission ohos.permission.GET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<image.PixelMap> } the promise returned by the function.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
*/
function getPixelMap(wallpaperType: WallpaperType): Promise<image.PixelMap>;
/**
* Obtains the default pixel map of a wallpaper of the specified type. Returns the default pixel map.
* Only the static wallpaper set by using setImage can be obtained.
* @permission ohos.permission.GET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<image.PixelMap> } callback - the callback of getImage.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function getImage(wallpaperType: WallpaperType, callback: AsyncCallback<image.PixelMap>): void;
/**
* Obtains the default pixel map of a wallpaper of the specified type. Returns the default pixel map.
* Only the static wallpaper set by using setImage can be obtained.
* @permission ohos.permission.GET_WALLPAPER
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<image.PixelMap> } the promise returned by the function.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 9
*/
function getImage(wallpaperType: WallpaperType): Promise<image.PixelMap>;
/**
* Sets live wallpaper of the specified type based on the uri path of the MP4 file.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { string } source - indicates the uri path of the MP4 file.
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<void> } callback - the callback of setVideo.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
function setVideo(source: string, wallpaperType: WallpaperType, callback: AsyncCallback<void>): void;
/**
* Sets live wallpaper of the specified type based on the uri path of the MP4 file.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { string } source - indicates the uri path of the MP4 file.
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
function setVideo(source: string, wallpaperType: WallpaperType): Promise<void>;
/**
* Sets wallpaper of the specified type based on the uri path of the custom wallpaper.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { string } source - indicates the uri path of the custom wallpaper.
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @param { AsyncCallback<void> } callback - the callback of setCustomWallpaper.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
function setCustomWallpaper(source: string, wallpaperType: WallpaperType, callback: AsyncCallback<void>): void;
/**
* Sets wallpaper of the specified type based on the uri path of the custom wallpaper.
*
* @permission ohos.permission.SET_WALLPAPER
* @param { string } source - indicates the uri path of the custom wallpaper.
* @param { WallpaperType } wallpaperType - indicates the wallpaper type.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 201 - permission denied.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
function setCustomWallpaper(source: string, wallpaperType: WallpaperType): Promise<void>;
/**
* Registers a listener for wallpaper color changes to receive notifications about the changes.
*
* @param { 'colorChange' } type - the incoming colorChange table open receiver pick a color change wallpaper wallpaper color changes.
* @param { function } callback - provides dominant colors of the wallpaper.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function on(type: 'colorChange', callback: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void;
/**
* Registers a listener for wallpaper changes to receive notifications about the changes.
*
* @param { 'wallpaperChange' } type - the incoming wallpaperChange table open receiver when the user modifies the wallpaper settings.
* @param { function } callback - wallpaperType indicates the wallpaper type.
* resourceType indicates the resource type of the wallpaper.
* uri indicates the wallpaper resource address.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
function on(
type: 'wallpaperChange',
callback: (wallpaperType: WallpaperType, resourceType: WallpaperResourceType, uri?: string) => void
): void;
/**
* Unregisters a listener for wallpaper color changes.
*
* @param { 'colorChange' } type - incoming colorChange table delete receiver to pick up a color change wallpaper wallpaper color changes
* @param { function } callback - provides dominant colors of the wallpaper.
* @syscap SystemCapability.MiscServices.Wallpaper
* @since 7
* @deprecated since 9
*/
function off(type: 'colorChange', callback?: (colors: Array<RgbaColor>, wallpaperType: WallpaperType) => void): void;
/**
* Unregisters a listener for wallpaper changes.
*
* @param { 'wallpaperChange' } type - the incoming wallpaperChange table delete receiver when the user modifies the wallpaper settings.
* @param { function } callback - wallpaperType indicates the wallpaper type.
* resourceType indicates the resource type of the wallpaper.
* uri indicates the wallpaper resource address.
* @throws { BusinessError } 401 - parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
* @throws { BusinessError } 202 - permission verification failed, application which is not a system application uses system API.
* @syscap SystemCapability.MiscServices.Wallpaper
* @systemapi Hide this for inner system use.
* @since 10
*/
function off(
type: 'wallpaperChange',
callback?: (wallpaperType: WallpaperType, resourceType: WallpaperResourceType, uri?: string) => void
): void;
}
export default wallpaper;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助