adpat @crossplatform tag to hilog API

Signed-off-by: buzhenwang <buzhenwang@huawei.com>
This commit is contained in:
buzhenwang 2023-05-27 14:21:06 +08:00
parent 7c9f8e58ad
commit 61a425d693

172
api/@ohos.hilog.d.ts vendored
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2021 Huawei Device Co., Ltd.
* Copyright (c) 2021-2023 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
@ -16,95 +16,187 @@
/**
* Provides interfaces to generate system logs.
*
* @since 7
* @namespace hilog
* @syscap SystemCapability.HiviewDFX.HiLog
* @since 7
*/
/**
* Provides interfaces to generate system logs.
*
* @namespace hilog
* @syscap SystemCapability.HiviewDFX.HiLog
* @crossplatform
* @since 10
*/
declare namespace hilog {
/**
* Outputs debug-level logs.
*
* @param domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param tag Identifies the log tag.
* @param format Indicates the log format string.
* @param args Indicates the log parameters.
* @crossplatform
* @since 7
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @since 7
*/
/**
* Outputs debug-level logs.
*
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @crossplatform
* @since 10
*/
function debug(domain: number, tag: string, format: string, ...args: any[]): void;
/**
* Outputs info-level logs.
*
* @param domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param tag Identifies the log tag.
* @param format Indicates the log format string.
* @param args Indicates the log parameters.
* @crossplatform
* @since 7
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @since 7
*/
/**
* Outputs info-level logs.
*
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @crossplatform
* @since 10
*/
function info(domain: number, tag: string, format: string, ...args: any[]): void;
/**
* Outputs warning-level logs.
*
* @param domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param tag Identifies the log tag.
* @param format Indicates the log format string.
* @param args Indicates the log parameters.
* @crossplatform
* @since 7
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @since 7
*/
/**
* Outputs warning-level logs.
*
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @crossplatform
* @since 10
*/
function warn(domain: number, tag: string, format: string, ...args: any[]): void;
/**
* Outputs error-level logs.
*
* @param domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param tag Identifies the log tag.
* @param format Indicates the log format string.
* @param args Indicates the log parameters.
* @crossplatform
* @since 7
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @since 7
*/
/**
* Outputs error-level logs.
*
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @crossplatform
* @since 10
*/
function error(domain: number, tag: string, format: string, ...args: any[]): void;
/**
* Outputs fatal-level logs.
*
* @param domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param tag Identifies the log tag.
* @param format Indicates the log format string.
* @param args Indicates the log parameters.
* @crossplatform
* @since 7
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @since 7
*/
/**
* Outputs fatal-level logs.
*
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { string } format Indicates the log format string.
* @param { any[] }args Indicates the log parameters.
* @syscap SystemCapability.HiviewDFX.HiLog
* @crossplatform
* @since 10
*/
function fatal(domain: number, tag: string, format: string, ...args: any[]): void;
/**
* Checks whether logs of the specified tag, and level can be printed.
*
* @param domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param tag Identifies the log tag.
* @param level log level
* @crossplatform
* @since 7
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { LogLevel } level log level
* @returns { boolean }
* @syscap SystemCapability.HiviewDFX.HiLog
* @since 7
*/
/**
* Checks whether logs of the specified tag, and level can be printed.
*
* @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF
* @param { string } tag Identifies the log tag.
* @param { LogLevel } level log level
* @returns { boolean }
* @syscap SystemCapability.HiviewDFX.HiLog
* @crossplatform
* @since 10
*/
function isLoggable(domain: number, tag: string, level: LogLevel): boolean;
/**
* Log level define
*
* @crossplatform
* @since 7
* @enum { number }
* @syscap SystemCapability.HiviewDFX.HiLog
* @since 7
*/
/**
* Log level define
*
* @enum { number }
* @syscap SystemCapability.HiviewDFX.HiLog
* @crossplatform
* @since 10
*/
enum LogLevel {
DEBUG = 3,
INFO = 4,
WARN = 5,
ERROR = 6,
FATAL = 7,
FATAL = 7
}
}