diff --git a/api/@ohos.logLibrary.d.ets b/api/@ohos.logLibrary.d.ets deleted file mode 100644 index a1c3f1b3a7b368ba68c038a5f6d492fcb3cc793c..0000000000000000000000000000000000000000 --- a/api/@ohos.logLibrary.d.ets +++ /dev/null @@ -1,192 +0,0 @@ -/* - * Copyright (c) 2025 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 PerformanceAnalysisKit - */ - -import type { AsyncCallback } from './@ohos.base'; - -/** - * @namespace logLibrary - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ -declare namespace logLibrary { - /** - * Log file entry - * - * @typedef LogEntry - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - export interface LogEntry { - /** - * Log file name - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - name: string; - - /** - * File modification time, expressed by the number of seconds elapsed from 1970-01-01 - * - * @type { number } - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - mtime: number; - - /** - * Log file size, byte - * - * @type { number } - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - size: number; - } - - /** - * List all log names of log type - * - * @permission ohos.permission.READ_HIVIEW_SYSTEM - * @param { string } logType - Log type - * @returns { LogEntry[] } Return LogEntry[] - * @throws { BusinessError } 201 - Permission denied - * @throws { BusinessError } 202 - Permission denied, non-system app called system api - * @throws { BusinessError } 401 - Invalid argument. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - *
3. Parameter verification failed. - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - export function list(logType: string): LogEntry[]; - - /** - * Copy log to dest path - * - * @permission ohos.permission.READ_HIVIEW_SYSTEM - * @param { string } logType - Log type - * @param { string } logName - Log name - * @param { string } dest - Log path under hiview sandbox of HAP - * @returns { Promise } Return Promise - * @throws { BusinessError } 201 - Permission denied - * @throws { BusinessError } 202 - Permission denied, non-system app called system api - * @throws { BusinessError } 401 - Invalid argument. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - *
3. Parameter verification failed. - * @throws { BusinessError } 21300001 - Source file does not exists - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - export function copy(logType: string, logName: string, dest: string): Promise; - - /** - * Copy log to dest path - * - * @permission ohos.permission.READ_HIVIEW_SYSTEM - * @param { string } logType - Log type - * @param { string } logName - Log name - * @param { string } dest - Log path under hiview sandbox of HAP - * @param { AsyncCallback } callback - After finish copy log will callback - * @throws { BusinessError } 201 - Permission denied - * @throws { BusinessError } 202 - Permission denied, non-system app called system api - * @throws { BusinessError } 401 - Invalid argument. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - *
3. Parameter verification failed. - * @throws { BusinessError } 21300001 - Source file does not exists - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - export function copy(logType: string, logName: string, dest: string, callback: AsyncCallback): void; - - /** - * Move log to dest path - * - * @permission ohos.permission.WRITE_HIVIEW_SYSTEM - * @param { string } logType - Log type - * @param { string } logName - Log name - * @param { string } dest - Log path under hiview sandbox of HAP - * @returns { Promise } Return Promise - * @throws { BusinessError } 201 - Permission denied - * @throws { BusinessError } 202 - Permission denied, non-system app called system api - * @throws { BusinessError } 401 - Invalid argument. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - *
3. Parameter verification failed. - * @throws { BusinessError } 21300001 - Source file does not exists - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - export function move(logType: string, logName: string, dest: string): Promise; - - /** - * Move log to dest path - * - * @permission ohos.permission.WRITE_HIVIEW_SYSTEM - * @param { string } logType - Log type - * @param { string } logName - Log name - * @param { string } dest - Log path under hiview sandbox of HAP - * @param { AsyncCallback } callback - After finish move log will callback - * @throws { BusinessError } 201 - Permission denied - * @throws { BusinessError } 202 - Permission denied, non-system app called system api - * @throws { BusinessError } 401 - Invalid argument. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - *
3. Parameter verification failed. - * @throws { BusinessError } 21300001 - Source file does not exists - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - export function move(logType: string, logName: string, dest: string, callback: AsyncCallback): void; - - /** - * Delete the log based on log name and log type - * - * @permission ohos.permission.WRITE_HIVIEW_SYSTEM - * @param { string } logType - Log type - * @param { string } logName - Log name - * @throws { BusinessError } 201 - Permission denied - * @throws { BusinessError } 202 - Permission denied, non-system app called system api - * @throws { BusinessError } 401 - Invalid argument. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. - *
3. Parameter verification failed. - * @throws { BusinessError } 21300001 - Source file does not exists - * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary - * @systemapi - * @since 20 - */ - export function remove(logType: string, logName: string): void; -} - -export default logLibrary; diff --git a/api/@ohos.logLibrary.d.ts b/api/@ohos.logLibrary.d.ts index e73e661afa5b3855155c5924d6a7a5e407619940..f6ce0a56bcc9bad5932eee6360696d235cf55bd4 100644 --- a/api/@ohos.logLibrary.d.ts +++ b/api/@ohos.logLibrary.d.ts @@ -24,7 +24,8 @@ import type { AsyncCallback } from './@ohos.base'; * @namespace logLibrary * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace logLibrary { /** @@ -33,7 +34,8 @@ declare namespace logLibrary { * @typedef LogEntry * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface LogEntry { /** @@ -42,7 +44,8 @@ declare namespace logLibrary { * @type { string } * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -52,7 +55,8 @@ declare namespace logLibrary { * @type { number } * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ mtime: number; @@ -62,7 +66,8 @@ declare namespace logLibrary { * @type { number } * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ size: number; } @@ -81,7 +86,8 @@ declare namespace logLibrary { *
3. Parameter verification failed. * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function list(logType: string): LogEntry[]; @@ -102,7 +108,8 @@ declare namespace logLibrary { * @throws { BusinessError } 21300001 - Source file does not exists * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function copy(logType: string, logName: string, dest: string): Promise; @@ -123,7 +130,8 @@ declare namespace logLibrary { * @throws { BusinessError } 21300001 - Source file does not exists * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function copy(logType: string, logName: string, dest: string, callback: AsyncCallback): void; @@ -144,7 +152,8 @@ declare namespace logLibrary { * @throws { BusinessError } 21300001 - Source file does not exists * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function move(logType: string, logName: string, dest: string): Promise; @@ -165,7 +174,8 @@ declare namespace logLibrary { * @throws { BusinessError } 21300001 - Source file does not exists * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function move(logType: string, logName: string, dest: string, callback: AsyncCallback): void; @@ -184,7 +194,8 @@ declare namespace logLibrary { * @throws { BusinessError } 21300001 - Source file does not exists * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function remove(logType: string, logName: string): void; }