mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-08 07:36:38 +00:00
431 lines
12 KiB
TypeScript
431 lines
12 KiB
TypeScript
/*
|
|
* Copyright (c) 2021 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.
|
|
*/
|
|
|
|
import Context from './application/Context';
|
|
import { RawFileDescriptor } from './global/rawFileDescriptor';
|
|
|
|
/**
|
|
* Provides resource related APIs.
|
|
*
|
|
* @since 6
|
|
* @syscap SystemCapability.Global.ResourceManager
|
|
*/
|
|
declare namespace resourceManager {
|
|
/**
|
|
* Enumerates screen directions.
|
|
*
|
|
* @since 6
|
|
*/
|
|
export enum Direction {
|
|
/**
|
|
* Indicates the vertical direction.
|
|
*
|
|
* @since 6
|
|
*/
|
|
DIRECTION_VERTICAL = 0,
|
|
|
|
/**
|
|
* Indicates the horizontal direction.
|
|
*
|
|
* @since 6
|
|
*/
|
|
DIRECTION_HORIZONTAL = 1
|
|
}
|
|
|
|
/**
|
|
* Enumerates device types.
|
|
*
|
|
* @since 6
|
|
*/
|
|
export enum DeviceType {
|
|
/**
|
|
* Indicates a phone.
|
|
*
|
|
* @since 6
|
|
*/
|
|
DEVICE_TYPE_PHONE = 0x00,
|
|
|
|
/**
|
|
* Indicates a tablet.
|
|
*
|
|
* @since 6
|
|
*/
|
|
DEVICE_TYPE_TABLET = 0x01,
|
|
|
|
/**
|
|
* Indicates a car.
|
|
*
|
|
* @since 6
|
|
*/
|
|
DEVICE_TYPE_CAR = 0x02,
|
|
|
|
/**
|
|
* Indicates a PC.
|
|
*
|
|
* @since 6
|
|
*/
|
|
DEVICE_TYPE_PC = 0x03,
|
|
|
|
/**
|
|
* Indicates a smart TV.
|
|
*
|
|
* @since 6
|
|
*/
|
|
DEVICE_TYPE_TV = 0x04,
|
|
|
|
/**
|
|
* Indicates a wearable device.
|
|
*
|
|
* @since 6
|
|
*/
|
|
DEVICE_TYPE_WEARABLE = 0x06
|
|
}
|
|
|
|
/**
|
|
* Enumerates screen density types.
|
|
*
|
|
* @since 6
|
|
*/
|
|
export enum ScreenDensity {
|
|
/**
|
|
* Indicates small screen density.
|
|
*
|
|
* @since 6
|
|
*/
|
|
SCREEN_SDPI = 120,
|
|
|
|
/**
|
|
* Indicates medium screen density.
|
|
*
|
|
* @since 6
|
|
*/
|
|
SCREEN_MDPI = 160,
|
|
|
|
/**
|
|
* Indicates large screen density.
|
|
*
|
|
* @since 6
|
|
*/
|
|
SCREEN_LDPI = 240,
|
|
|
|
/**
|
|
* Indicates extra-large screen density.
|
|
*
|
|
* @since 6
|
|
*/
|
|
SCREEN_XLDPI = 320,
|
|
|
|
/**
|
|
* Indicates extra-extra-large screen density.
|
|
*
|
|
* @since 6
|
|
*/
|
|
SCREEN_XXLDPI = 480,
|
|
|
|
/**
|
|
* Indicates extra-extra-extra-large screen density.
|
|
*
|
|
* @since 6
|
|
*/
|
|
SCREEN_XXXLDPI = 640
|
|
}
|
|
|
|
/**
|
|
* Provides the device configuration.
|
|
*
|
|
* @since 6
|
|
*/
|
|
export class Configuration {
|
|
/**
|
|
* Indicates the screen direction of the current device.
|
|
*
|
|
* @since 6
|
|
*/
|
|
direction: Direction
|
|
|
|
/**
|
|
* Indicates the current system language, for example, zh-Hans-CN.
|
|
*
|
|
* @since 6
|
|
*/
|
|
locale: string
|
|
}
|
|
|
|
/**
|
|
* Provides the device capability.
|
|
*
|
|
* @since 6
|
|
*/
|
|
export class DeviceCapability {
|
|
/**
|
|
* Indicates the screen density of the current device.
|
|
*
|
|
* @since 6
|
|
*/
|
|
screenDensity: ScreenDensity
|
|
|
|
/**
|
|
* Indicates the type of the current device.
|
|
*
|
|
* @since 6
|
|
*/
|
|
deviceType: DeviceType
|
|
}
|
|
|
|
/**
|
|
* The ResourceManager callback.
|
|
* @since 6
|
|
*/
|
|
export interface AsyncCallback<T> {
|
|
(err: Error, data: T): void;
|
|
}
|
|
|
|
/**
|
|
* Obtains the ResourceManager object of the current application.
|
|
*
|
|
* @param callback Indicates the callback containing the ResourceManager object.
|
|
* @since 6
|
|
* @FAModelOnly
|
|
*/
|
|
export function getResourceManager(callback: AsyncCallback<ResourceManager>);
|
|
|
|
/**
|
|
* Obtains the ResourceManager object of the specified application.
|
|
*
|
|
* @param bundleName Indicates the bundle name of the specified application.
|
|
* @param callback Indicates the callback containing the ResourceManager object.
|
|
* @since 6
|
|
* @FAModelOnly
|
|
*/
|
|
export function getResourceManager(bundleName: string, callback: AsyncCallback<ResourceManager>);
|
|
|
|
/**
|
|
* Obtains the ResourceManager object of the current application.
|
|
*
|
|
* @return Returns that the ResourceManager object is returned in Promise mode.
|
|
* @since 6
|
|
* @FAModelOnly
|
|
*/
|
|
export function getResourceManager(): Promise<ResourceManager>;
|
|
|
|
/**
|
|
* Obtains the ResourceManager object of the specified application.
|
|
*
|
|
* @param bundleName Indicates the bundle name of the specified application.
|
|
* @return Returns that the ResourceManager object is returned in Promise mode.
|
|
* @since 6
|
|
* @FAModelOnly
|
|
*/
|
|
export function getResourceManager(bundleName: string): Promise<ResourceManager>;
|
|
|
|
/**
|
|
* Provides the capability of accessing application resources.
|
|
*
|
|
* @since 6
|
|
*/
|
|
export interface ResourceManager {
|
|
/**
|
|
* Obtains the character string corresponding to a specified resource ID in callback mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @param callback Indicates the asynchronous callback used to return the obtained character string.
|
|
* @since 6
|
|
*/
|
|
getString(resId: number, callback: AsyncCallback<string>);
|
|
|
|
/**
|
|
* Obtains string resources associated with a specified resource ID in Promise mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @return Returns the character string corresponding to the resource ID.
|
|
* @since 6
|
|
*/
|
|
getString(resId: number): Promise<string>;
|
|
|
|
/**
|
|
* Obtains the array of character strings corresponding to a specified resource ID in callback mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @param callback Indicates the asynchronous callback used to return the obtained array of character strings.
|
|
* @since 6
|
|
*/
|
|
getStringArray(resId: number, callback: AsyncCallback<Array<string>>);
|
|
|
|
/**
|
|
* Obtains the array of character strings corresponding to a specified resource ID in Promise mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @return Returns the array of character strings corresponding to the specified resource ID.
|
|
* @since 6
|
|
*/
|
|
getStringArray(resId: number): Promise<Array<string>>;
|
|
|
|
/**
|
|
* Obtains the content of the media file corresponding to a specified resource ID in callback mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @param callback Indicates the asynchronous callback used to return the obtained media file content.
|
|
* @since 6
|
|
*/
|
|
getMedia(resId: number, callback: AsyncCallback<Uint8Array>);
|
|
|
|
/**
|
|
* Obtains the content of the media file corresponding to a specified resource ID in Promise mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @return Returns the content of the media file corresponding to the specified resource ID.
|
|
* @since 6
|
|
*/
|
|
getMedia(resId: number): Promise<Uint8Array>;
|
|
|
|
/**
|
|
* Obtains the Base64 code of the image resource corresponding to the specified resource ID in callback mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @param callback Indicates the asynchronous callback used to return the obtained Base64 code of the image
|
|
* resource.
|
|
* @since 6
|
|
*/
|
|
getMediaBase64(resId: number, callback: AsyncCallback<string>);
|
|
|
|
/**
|
|
* Obtains the Base64 code of the image resource corresponding to the specified resource ID in Promise mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @return Returns the Base64 code of the image resource corresponding to the specified resource ID.
|
|
* @since 6
|
|
*/
|
|
getMediaBase64(resId: number): Promise<string>;
|
|
|
|
/**
|
|
* Obtains the device capability in callback mode.
|
|
*
|
|
* @param callback Indicates the asynchronous callback used to return the obtained device capability.
|
|
* @since 6
|
|
*/
|
|
getDeviceCapability(callback: AsyncCallback<DeviceCapability>);
|
|
|
|
/**
|
|
* Obtains the device capability in Promise mode.
|
|
*
|
|
* @return Returns the device capability.
|
|
* @since 6
|
|
*/
|
|
getDeviceCapability(): Promise<DeviceCapability>;
|
|
|
|
/**
|
|
* Obtains the device configuration in callback mode.
|
|
*
|
|
* @param callback Indicates the asynchronous callback used to return the obtained device
|
|
* configuration.
|
|
* @since 6
|
|
*/
|
|
getConfiguration(callback: AsyncCallback<Configuration>);
|
|
|
|
/**
|
|
* Obtains the device configuration in Promise mode.
|
|
*
|
|
* @return Returns the device configuration.
|
|
* @since 6
|
|
*/
|
|
getConfiguration(): Promise<Configuration>;
|
|
|
|
/**
|
|
* Obtains the singular-plural character string represented by the ID string corresponding to the
|
|
* specified number in callback mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @param num Indicates the number.
|
|
* @param callback Indicates the asynchronous callback used to return the singular-plural character
|
|
* string represented by the ID string corresponding to the specified number.
|
|
* @since 6
|
|
*/
|
|
getPluralString(resId: number, num: number, callback: AsyncCallback<string>);
|
|
|
|
/**
|
|
* Obtains the singular-plural character string represented by the ID string corresponding to
|
|
* the specified number in Promise mode.
|
|
*
|
|
* @param resId Indicates the resource ID.
|
|
* @param num Indicates the number.
|
|
* @return Returns the singular-plural character string represented by the ID string
|
|
* corresponding to the specified number.
|
|
* @since 6
|
|
*/
|
|
getPluralString(resId: number, num: number): Promise<string>;
|
|
|
|
/**
|
|
* Obtains the raw file resource corresponding to the specified resource path in callback mode.
|
|
*
|
|
* @param path Indicates the resource relative path.
|
|
* @param callback Indicates the asynchronous callback used to return the raw file resource.
|
|
* @since 8
|
|
*/
|
|
getRawFile(path: string, callback: AsyncCallback<Uint8Array>);
|
|
|
|
/**
|
|
* Obtains the raw file resource corresponding to the specified resource path in Promise mode.
|
|
*
|
|
* @param path Indicates the resource relative path.
|
|
* @return Returns the raw file resource corresponding to the specified resource path.
|
|
* @since 8
|
|
*/
|
|
getRawFile(path: string): Promise<Uint8Array>;
|
|
|
|
/**
|
|
* Obtains the raw file resource descriptor corresponding to the specified resource path in callback mode.
|
|
*
|
|
* @param path Indicates the resource relative path.
|
|
* @param callback Indicates the asynchronous callback used to return the raw file resource descriptor.
|
|
* @since 8
|
|
*/
|
|
getRawFileDescriptor(path: string, callback: AsyncCallback<RawFileDescriptor>);
|
|
|
|
/**
|
|
* Obtains the raw file resource descriptor corresponding to the specified resource path in Promise mode.
|
|
*
|
|
* @param path Indicates the resource relative path.
|
|
* @return Returns the raw file resource descriptor corresponding to the specified resource path.
|
|
* @since 8
|
|
*/
|
|
getRawFileDescriptor(path: string): Promise<RawFileDescriptor>;
|
|
|
|
/**
|
|
* Obtains close raw file resource descriptor corresponding to the specified resource path in callback mode.
|
|
*
|
|
* @param path Indicates the resource relative path.
|
|
* @param callback Indicates the asynchronous callback used to return result close raw file resource descriptor.
|
|
* @since 8
|
|
*/
|
|
closeRawFileDescriptor(path: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Obtains close raw file resource descriptor corresponding to the specified resource path in Promise mode.
|
|
*
|
|
* @param path Indicates the resource relative path.
|
|
* @return Returns result close raw file resource descriptor corresponding to the specified resource path.
|
|
* @since 8
|
|
*/
|
|
closeRawFileDescriptor(path: string): Promise<void>;
|
|
|
|
/**
|
|
* Obtains release resourceManager.
|
|
*
|
|
* @since 7
|
|
*/
|
|
release();
|
|
}
|
|
}
|
|
export default resourceManager; |