mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-08 07:36:38 +00:00
9ce199ec7b
Description:接口标签更新 Sig:SIG_ApplicationFramework Feature or Bugfix: Feature Binary Source: No Signed-off-by: dy_study <dingyao5@huawei.com>
96 lines
2.9 KiB
TypeScript
96 lines
2.9 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 { AsyncCallback, BusinessError } from './basic';
|
|
|
|
/**
|
|
* The interface of system parameters class.
|
|
*
|
|
* @since 6
|
|
* @syscap SystemCapability.Startup.SysInfo
|
|
* @systemapi Hide this for inner system use.
|
|
*/
|
|
declare namespace systemParameter {
|
|
/**
|
|
* Gets the value of the attribute with the specified key.
|
|
*
|
|
* @param key Key of the system attribute.
|
|
* @param def Default value.
|
|
* @return if the parameter is empty or doesn't exist, empty string will be returned.
|
|
* @since 6
|
|
*/
|
|
function getSync(key: string, def?: string): string;
|
|
|
|
/**
|
|
* Gets the value of the attribute with the specified key.
|
|
*
|
|
* @param key Key of the system attribute.
|
|
* @param callback Callback function.
|
|
* @since 6
|
|
*/
|
|
function get(key: string, callback: AsyncCallback<string>): void;
|
|
|
|
/**
|
|
* Gets the value of the attribute with the specified key.
|
|
*
|
|
* @param key Key of the system attribute.
|
|
* @param def Default value.
|
|
* @param callback Callback function.
|
|
* @since 6
|
|
*/
|
|
function get(key: string, def: string, callback: AsyncCallback<string>): void;
|
|
|
|
/**
|
|
* Gets the value of the attribute with the specified key.
|
|
*
|
|
* @param key Key of the system attribute.
|
|
* @param def Default value.
|
|
* @return Promise, which is used to obtain the result asynchronously.
|
|
* @since 6
|
|
*/
|
|
function get(key: string, def?: string): Promise<string>;
|
|
|
|
/**
|
|
* Sets a value for the attribute with the specified key.
|
|
*
|
|
* @param key Key of the system attribute.
|
|
* @param value System attribute value to set.
|
|
* @since 6
|
|
*/
|
|
function setSync(key: string, value: string): void;
|
|
|
|
/**
|
|
* Sets a value for the attribute with the specified key.
|
|
*
|
|
* @param key Key of the system attribute.
|
|
* @param value System attribute value to set.
|
|
* @param callback Callback function.
|
|
* @since 6
|
|
*/
|
|
function set(key: string, value: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets a value for the attribute with the specified key.
|
|
*
|
|
* @param key Key of the system attribute.
|
|
* @param value Default value.
|
|
* @return Promise, which is used to obtain the result asynchronously.
|
|
* @since 6
|
|
*/
|
|
function set(key: string, value: string): Promise<void>;
|
|
}
|
|
|
|
export default systemParameter;
|