当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
46 Star 180 Fork 4.8K

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.hiviewdfx.hiAppEvent.d.ts 96.45 KB
一键复制 编辑 原始数据 按行查看 历史
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477
/*
* Copyright (c) 2022-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
* @arkts 1.1&1.2
*/
import type { AsyncCallback } from './@ohos.base';
/**
* Provides the event logging function for applications to log the fault, statistical, security,
* and user behavior events reported during running. Based on event information,
* you will be able to analyze the running status of applications.
*
* @namespace hiAppEvent
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Provides the event logging function for applications to log the fault, statistical, security,
* and user behavior events reported during running. Based on event information,
* you will be able to analyze the running status of applications.
*
* @namespace hiAppEvent
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Provides the event logging function for applications to log the fault, statistical, security,
* and user behavior events reported during running. Based on event information,
* you will be able to analyze the running status of applications.
*
* @namespace hiAppEvent
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace hiAppEvent {
/**
* Enumerates event types.
*
* @enum { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Enumerates event types.
*
* @enum { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Enumerates event types.
*
* @enum { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
enum EventType {
/**
* Fault event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Fault event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Fault event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
FAULT = 1,
/**
* Statistic event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Statistic event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Statistic event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
STATISTIC = 2,
/**
* Security event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Security event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Security event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
SECURITY = 3,
/**
* Behavior event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Behavior event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Behavior event.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
BEHAVIOR = 4
}
/**
* Provides domain name constants.
*
* @namespace domain
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Provides domain name constants.
*
* @namespace domain
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
namespace domain {
/**
* System domain.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* System domain.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
const OS: string;
}
/**
* Provides event name constants, including system event name constants and application event name constants.
* <br>The application event name constants are optional custom event names reserved when you call Write for
* application event logging.
*
* @namespace event
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Provides event name constants, including system event name constants and application event name constants.
* <br>The application event name constants are optional custom event names reserved when you call Write for
* application event logging.
*
* @namespace event
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Provides event name constants, including system event name constants and application event name constants.
* <br>The application event name constants are optional custom event names reserved when you call Write for
* application event logging.
*
* @namespace event
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
namespace event {
/**
* User login event. This is a reserved application event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* User login event. This is a reserved application event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
const USER_LOGIN: string;
/**
* User logout event. This is a reserved application event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* User logout event. This is a reserved application event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
const USER_LOGOUT: string;
/**
* Distributed service startup event. This is a reserved application event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Distributed service startup event. This is a reserved application event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
const DISTRIBUTED_SERVICE_START: string;
/**
* Application crash event. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Application crash event. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
const APP_CRASH: string;
/**
* Application freeze event. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
const APP_FREEZE: string;
/**
* Event indicating the application launch duration. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
const APP_LAUNCH: string;
/**
* Event indicating frame loss during swiping. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
const SCROLL_JANK: string;
/**
* Event indicating a high CPU usage. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
const CPU_USAGE_HIGH: string;
/**
* Event indicating battery usage statistics. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
const BATTERY_USAGE: string;
/**
* Event indicating an application resource leakage. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
const RESOURCE_OVERLIMIT: string;
/**
* Address sanitizer event. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
const ADDRESS_SANITIZER: string;
/**
* Main thread jank event. This is a system event name constant.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
const MAIN_THREAD_JANK: string;
/**
* App killed event. This is a system event name constant.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 20
*/
const APP_KILLED: string;
/**
* App task execution timeout event. This is a system event name constant.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'21','1.2':'22'}
* @arkts 1.1&1.2
*/
const APP_HICOLLIE: string;
/**
* Audio jank frame. This is a system event name constant.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'21','1.2':'22'}
* @arkts 1.1&1.2
*/
const AUDIO_JANK_FRAME: string;
}
/**
* Provides parameter name constants.
*
* @namespace param
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Provides parameter name constants.
*
* @namespace param
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Provides parameter name constants.
*
* @namespace param
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
namespace param {
/**
* Custom user ID.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Custom user ID.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Custom user ID.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
const USER_ID: string;
/**
* Distributed service name.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Distributed service name.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Distributed service name.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
const DISTRIBUTED_SERVICE_NAME: string;
/**
* Distributed service instance ID.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Distributed service instance ID.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Distributed service instance ID.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
const DISTRIBUTED_SERVICE_INSTANCE_ID: string;
}
/**
* Configures the application event logging function, such as setting the logging switch and directory storage quota.
*
* @param { ConfigOption } config Configuration items for application event logging.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 11103001 - Invalid max storage quota value. Possible caused by incorrectly formatted.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Configures the application event logging function, such as setting the logging switch and directory storage quota.
*
* @param { ConfigOption } config Configuration items for application event logging.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11103001 - Invalid max storage quota value. Possible caused by incorrectly formatted.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Configures the application event logging function, such as setting the logging switch and directory storage quota.
*
* @param { ConfigOption } config Configuration items for application event logging.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11103001 - Invalid max storage quota value. Possible caused by incorrectly formatted.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function configure(config: ConfigOption): void;
/**
* Provides configuration options for application event logging.
*
* @interface ConfigOption
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Provides configuration options for application event logging.
*
* @interface ConfigOption
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Provides configuration options for application event logging.
*
* @interface ConfigOption
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
interface ConfigOption {
/**
* Whether to enable the event logging function. The default value is false.
* <br>If this parameter is set to true, the logging function is disabled. Otherwise, the logging function is
* enabled.
*
* @type { ?boolean }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Whether to enable the event logging function. The default value is false.
* <br>If this parameter is set to true, the logging function is disabled. Otherwise, the logging function is
* enabled.
*
* @type { ?boolean }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Whether to enable the event logging function. The default value is false.
* <br>If this parameter is set to true, the logging function is disabled. Otherwise, the logging function is
* enabled.
*
* @type { ?boolean }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
disable?: boolean;
/**
* Quota for the directory that stores event logging files. The default value is 10M.
* <br>It is recommended that the quota be less than or equal to 10 MB. Otherwise, the API efficiency may be
* affected. If the directory size exceeds the specified quota when application event logging is performed, event
* logging files in the directory will be cleared one by one based on the generation time to ensure that directory
* size does not exceed the quota.
* <br>The quota value must meet the following requirements:
* <br>- The quota value consists of only digits and a unit (which can be one of [b|k|kb|m|mb|g|gb|t|tb], which are
* case insensitive.)
* <br>- The quota value must start with a digit. You can determine whether to pass the unit. If the unit is left
* empty, b (that is, byte) is used by default.
*
* @type { ?string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Quota for the directory that stores event logging files. The default value is 10M.
* <br>It is recommended that the quota be less than or equal to 10 MB. Otherwise, the API efficiency may be
* affected. If the directory size exceeds the specified quota when application event logging is performed, event
* logging files in the directory will be cleared one by one based on the generation time to ensure that directory
* size does not exceed the quota.
* <br>The quota value must meet the following requirements:
* <br>- The quota value consists of only digits and a unit (which can be one of [b|k|kb|m|mb|g|gb|t|tb], which are
* case insensitive.)
* <br>- The quota value must start with a digit. You can determine whether to pass the unit. If the unit is left
* empty, b (that is, byte) is used by default.
*
* @type { ?string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
maxStorage?: string;
}
/**
* Defines parameters of the event information.
*
* @interface AppEventInfo
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Defines parameters of the event information.
*
* @interface AppEventInfo
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Defines parameters of the event information.
*
* @interface AppEventInfo
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
interface AppEventInfo {
/**
* Event domain. The value is a string of up to 32 characters, including digits (0 to 9), letters (a to z), and
* underscores (_). It must start with a letter and cannot end with an underscore (_).
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event domain. The value is a string of up to 32 characters, including digits (0 to 9), letters (a to z), and
* underscores (_). It must start with a letter and cannot end with an underscore (_).
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event domain. The value is a string of up to 32 characters, including digits (0 to 9), letters (a to z), and
* underscores (_). It must start with a letter and cannot end with an underscore (_).
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
domain: string;
/**
* Event name. The value is string that contains a maximum of 48 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a
* digit or letter.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event name. The value is string that contains a maximum of 48 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a
* digit or letter.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event name. The value is string that contains a maximum of 48 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a
* digit or letter.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
name: string;
/**
* Event type.
*
* @type { EventType }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event type.
*
* @type { EventType }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event type.
*
* @type { EventType }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
eventType: EventType;
/**
* Event parameter object, which consists of a parameter name and a parameter value. In system events, the fields
* contained in params are defined by system. For details about the fields, you can see the overviews of system
* events, for example, Crash Event Overview. For application events, you need to define the parameters of the
* Write API. The specifications are as follows:
* <br>- A parameter name is a string that contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a
* digit or letter. For example, testName and $123_name.
* <br>- The parameter value can be a string, number, boolean, or array. The string type parameter can contain a
* maximum of 8 x 1024 characters. If the length exceeds the limit, the parameter and its name will be discarded.
* The value of the number type parameter must be within the range of Number.MIN_SAFE_INTEGER to
* Number.MAX_SAFE_INTEGER. If the value exceeds the range, an uncertain value may be generated. The element type
* in the array type parameter can only be string, number, or boolean. The number of elements must be less than
* 100. If this limit is exceeded, excess elements will be discarded.
* <br>- The maximum number of parameters is 32. If this limit is exceeded, excess parameters will be discarded.
*
* @type { object }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event parameter object, which consists of a parameter name and a parameter value. In system events, the fields
* contained in params are defined by system. For details about the fields, you can see the overviews of system
* events, for example, Crash Event Overview. For application events, you need to define the parameters of the
* Write API. The specifications are as follows:
* <br>- A parameter name is a string that contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a
* digit or letter. For example, testName and $123_name.
* <br>- The parameter value can be a string, number, boolean, or array. The string type parameter can contain a
* maximum of 8 x 1024 characters. If the length exceeds the limit, the parameter and its name will be discarded.
* The value of the number type parameter must be within the range of Number.MIN_SAFE_INTEGER to
* Number.MAX_SAFE_INTEGER. If the value exceeds the range, an uncertain value may be generated. The element type
* in the array type parameter can only be string, number, or boolean. The number of elements must be less than
* 100. If this limit is exceeded, excess elements will be discarded.
* <br>- The maximum number of parameters is 32. If this limit is exceeded, excess parameters will be discarded.
*
* @type { object }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event parameter object, which consists of a parameter name and a parameter value. In system events, the fields
* contained in params are defined by system. For details about the fields, you can see the overviews of system
* events, for example, Crash Event Overview. For application events, you need to define the parameters of the
* Write API. The specifications are as follows:
* <br>- A parameter name is a string that contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a
* digit or letter. For example, testName and $123_name.
* <br>- The parameter value can be a string, number, boolean, or array. The string type parameter can contain a
* maximum of 8 x 1024 characters. If the length exceeds the limit, the parameter and its name will be discarded.
* The value of the number type parameter must be within the range of Number.MIN_SAFE_INTEGER to
* Number.MAX_SAFE_INTEGER. If the value exceeds the range, an uncertain value may be generated. The element type
* in the array type parameter can only be string, number, or boolean. The number of elements must be less than
* 100. If this limit is exceeded, excess elements will be discarded.
* <br>- The maximum number of parameters is 32. If this limit is exceeded, excess parameters will be discarded.
*
* @type { object }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
params: object;
}
/**
* Writes events of the AppEventInfo type. This API uses a promise to return the result. The event object written by
* calling this API is a custom object. To avoid conflicts with system events, you are not advised to write it to
* system events (system event name constants defined in Event). The events written by this API can be subscribed to
* through (addWatcher).
*
* @param { AppEventInfo } Application event object. You are advised to avoid the conflict between the custom event
* name and the system event name constant defined in Event.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 11100001 - Function disabled. Possible caused by the param disable in ConfigOption is true.
* @throws { BusinessError } 11101001 - Invalid event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101002 - Invalid event name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101003 - Invalid number of event parameters. Possible caused by the number of parameters
* <br>is over 32.
* @throws { BusinessError } 11101004 - Invalid string length of the event parameter.
* @throws { BusinessError } 11101005 - Invalid event parameter name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101006 - Invalid array length of the event parameter.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Writes events of the AppEventInfo type. This API uses a promise to return the result. The event object written by
* calling this API is a custom object. To avoid conflicts with system events, you are not advised to write it to
* system events (system event name constants defined in Event). The events written by this API can be subscribed to
* through (addWatcher).
*
* @param { AppEventInfo } info Application event object. You are advised to avoid the conflict between the custom
* event name and the system event name constant defined in Event.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11100001 - Function disabled. Possible caused by the param disable in ConfigOption is true.
* @throws { BusinessError } 11101001 - Invalid event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101002 - Invalid event name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101003 - Invalid number of event parameters. Possible caused by the number of parameters
* <br>is over 32.
* @throws { BusinessError } 11101004 - Invalid string length of the event parameter.
* @throws { BusinessError } 11101005 - Invalid event parameter name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101006 - Invalid array length of the event parameter.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Writes events of the AppEventInfo type. This API uses a promise to return the result. The event object written by
* calling this API is a custom object. To avoid conflicts with system events, you are not advised to write it to
* system events (system event name constants defined in Event). The events written by this API can be subscribed to
* through (addWatcher).
*
* @param { AppEventInfo } info Application event object. You are advised to avoid the conflict between the custom
* event name and the system event name constant defined in Event.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11100001 - Function disabled. Possible caused by the param disable in ConfigOption is true.
* @throws { BusinessError } 11101001 - Invalid event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101002 - Invalid event name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101003 - Invalid number of event parameters. Possible caused by the number of parameters
* <br>is over 32.
* @throws { BusinessError } 11101004 - Invalid string length of the event parameter.
* @throws { BusinessError } 11101005 - Invalid event parameter name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101006 - Invalid array length of the event parameter.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function write(info: AppEventInfo): Promise<void>;
/**
* Writes events of the AppEventInfo type. This API uses an asynchronous callback to return the result. The event
* object written by calling this API is a custom object. To avoid conflicts with system events, you are not advised
* to write it to system events (system event name constants defined in Event). The events written by this API can be
* subscribed to through (addWatcher).
*
* @param { AppEventInfo } info Application event object. You are advised to avoid the conflict between the custom
* event name and the system event name constant defined in Event.
* @param { AsyncCallback<void> } callback Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 11100001 - Function disabled. Possible caused by the param disable in ConfigOption is true.
* @throws { BusinessError } 11101001 - Invalid event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101002 - Invalid event name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101003 - Invalid number of event parameters. Possible caused by the number of parameters
* <br>is over 32.
* @throws { BusinessError } 11101004 - Invalid string length of the event parameter.
* @throws { BusinessError } 11101005 - Invalid event parameter name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101006 - Invalid array length of the event parameter.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Writes events of the AppEventInfo type. This API uses an asynchronous callback to return the result. The event
* object written by calling this API is a custom object. To avoid conflicts with system events, you are not advised
* to write it to system events (system event name constants defined in Event). The events written by this API can be
* subscribed to through (addWatcher).
*
* @param { AppEventInfo } info Application event object. You are advised to avoid the conflict between the custom
* event name and the system event name constant defined in Event.
* @param { AsyncCallback<void> } callback Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11100001 - Function disabled. Possible caused by the param disable in ConfigOption is true.
* @throws { BusinessError } 11101001 - Invalid event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101002 - Invalid event name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101003 - Invalid number of event parameters. Possible caused by the number of parameters
* <br>is over 32.
* @throws { BusinessError } 11101004 - Invalid string length of the event parameter.
* @throws { BusinessError } 11101005 - Invalid event parameter name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101006 - Invalid array length of the event parameter.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Writes events of the AppEventInfo type. This API uses an asynchronous callback to return the result. The event
* object written by calling this API is a custom object. To avoid conflicts with system events, you are not advised
* to write it to system events (system event name constants defined in Event). The events written by this API can be
* subscribed to through (addWatcher).
*
* @param { AppEventInfo } info Application event object. You are advised to avoid the conflict between the custom
* event name and the system event name constant defined in Event.
* @param { AsyncCallback<void> } callback Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11100001 - Function disabled. Possible caused by the param disable in ConfigOption is true.
* @throws { BusinessError } 11101001 - Invalid event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101002 - Invalid event name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101003 - Invalid number of event parameters. Possible caused by the number of parameters
* <br>is over 32.
* @throws { BusinessError } 11101004 - Invalid string length of the event parameter.
* @throws { BusinessError } 11101005 - Invalid event parameter name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101006 - Invalid array length of the event parameter.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function write(info: AppEventInfo, callback: AsyncCallback<void>): void;
/**
* Type of a custom event parameter value.
*
* @typedef {number | string | boolean | Array<string>}
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 12
*/
/**
* Type of a custom event parameter value.
*
* @typedef {number | string | boolean | Array<string>}
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
type ParamType = number | string | boolean | Array<string>;
/**
* Sets custom event parameters. This API uses a promise to return the result. During the same lifecycle, system
* events and application events can be associated through event domain and event name. System events only support
* crash and freeze events.
*
* @param { Record<string, ParamType> } params Custom parameter object. The parameter name and value are defined as
* follows:
* <br>- A parameter name is a string that contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a digit
* or letter.
* <br>- The parameter value is of the ParamType and contains a maximum of 1024 characters.
* <br>- The number of parameters must be less than 64.
* @param { string } domain Event domain. The event domain can be associated with application events and system
* events (hiAppEvent.domain.OS).
* @param { string } name Event name. The default value is an empty string, which indicates all event names in the
* associated event domain. The event name can be associated with application events and system events. System events
* can be associated only with crash events (hiAppEvent.event.APP_CRASH) and freeze events
* (hiAppEvent.event.APP_FREEZE).
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11100001 - Function disabled. Possible caused by the param disable in ConfigOption is true.
* @throws { BusinessError } 11101001 - Invalid event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101002 - Invalid event name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101004 - Invalid string length of the event parameter.
* @throws { BusinessError } 11101005 - Invalid event parameter name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101007 - The number of parameter keys exceeds the limit.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 12
*/
/**
* Sets custom event parameters. This API uses a promise to return the result. During the same lifecycle, system
* events and application events can be associated through event domain and event name. System events only support
* crash and freeze events.
*
* @param { Record<string, ParamType> } params Custom parameter object. The parameter name and value are defined as
* follows:
* <br>- A parameter name is a string that contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a digit
* or letter.
* <br>- The parameter value is of the ParamType and contains a maximum of 1024 characters.
* <br>- The number of parameters must be less than 64.
* @param { string } domain Event domain. The event domain can be associated with application events and system
* events (hiAppEvent.domain.OS).
* @param { string } name Event name. The default value is an empty string, which indicates all event names in the
* associated event domain. The event name can be associated with application events and system events. System events
* can be associated only with crash events (hiAppEvent.event.APP_CRASH) and freeze events
* (hiAppEvent.event.APP_FREEZE).
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11100001 - Function disabled. Possible caused by the param disable in ConfigOption is true.
* @throws { BusinessError } 11101001 - Invalid event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101002 - Invalid event name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101004 - Invalid string length of the event parameter.
* @throws { BusinessError } 11101005 - Invalid event parameter name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11101007 - The number of parameter keys exceeds the limit.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function setEventParam(params: Record<string, ParamType>, domain: string, name?: string): Promise<void>;
/**
* Sets the custom threshold triggering condition for an event. This API uses a promise to return the result. In the
* same lifecycle, you can customize the parameters related to the event threshold triggering condition based on the
* event name. Currently, only the MAIN_THREAD_JANK event is supported. For details about the parameter configuration,
* see Main Thread Jank Event Overview.
*
* @param { string } name Event name.
* @param { Record<string, ParamType> } config Custom parameter object. The parameter name and value are defined as
* follows:
* <br>- The parameter name contains a maximum of 1024 characters, which is of the string type and cannot be empty.
* <br>- The parameter value is of the ParamType and contains a maximum of 1024 characters.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3.Parameter verification failed.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'15','1.2':'20'}
* @arkts 1.1&1.2
*/
function setEventConfig(name: string, config: Record<string, ParamType>): Promise<void>;
/**
* Defines parameters of an AppEventPackage object. This API is used to obtain detail information about an event
* package, which is obtained using the takeNext API.
*
* @interface AppEventPackage
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Defines parameters of an AppEventPackage object. This API is used to obtain detail information about an event
* package, which is obtained using the takeNext API.
*
* @interface AppEventPackage
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Defines parameters of an AppEventPackage object. This API is used to obtain detail information about an event
* package, which is obtained using the takeNext API.
*
* @interface AppEventPackage
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
interface AppEventPackage {
/**
* Event package ID, which is named from 0 in ascending order.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event package ID, which is named from 0 in ascending order.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event package ID, which is named from 0 in ascending order.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
packageId: number;
/**
* Number of events in the event package.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Number of events in the event package.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Number of events in the event package.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
row: number;
/**
* Event size of the event package, in bytes.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event size of the event package, in bytes.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event size of the event package, in bytes.
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
size: number;
/**
* Event data in the event package.
*
* @type { string[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event data in the event package.
*
* @type { string[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event data in the event package.
*
* @type { string[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
data: string[];
/**
* Event object group.
*
* @type { Array<AppEventInfo> }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 12
*/
/**
* Event object group.
*
* @type { Array<AppEventInfo> }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
appEventInfos: Array<AppEventInfo>;
}
/**
* Defines a subscription data holder for processing event information.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Defines a subscription data holder for processing event information.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Defines a subscription data holder for processing event information.
*
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
class AppEventPackageHolder {
/**
* Constructs an AppEventPackageHolder instance. You can call addWatcher to add an event watcher, and then
* associate the AppEventPackageHolder instance with the watcher added in the application based on the watcher name.
*
* @param { string } watcherName Name of the event watcher added through addWatcher. If no watcher is added, no
* data is displayed by default.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Constructs an AppEventPackageHolder instance. You can call addWatcher to add an event watcher, and then
* associate the AppEventPackageHolder instance with the watcher added in the application based on the watcher name.
*
* @param { string } watcherName Name of the event watcher added through addWatcher. If no watcher is added, no
* data is displayed by default.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Constructs an AppEventPackageHolder instance. You can call addWatcher to add an event watcher, and then
* associate the AppEventPackageHolder instance with the watcher added in the application based on the watcher name.
*
* @param { string } watcherName Name of the event watcher added through addWatcher. If no watcher is added, no
* data is displayed by default.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
constructor(watcherName: string);
/**
* Sets the threshold for the data size of the event package obtained each time.
*
* @param { number } size Data size threshold, in bytes. The value range is [0, $2^{31}$-1]. If the value is out of
* the range, an exception is thrown.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 11104001 - Invalid size value. Possible caused by the size value is less than or equal
* <br>to zero.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Sets the threshold for the data size of the event package obtained each time.
*
* @param { number } size Data size threshold, in bytes. The value range is [0, $2^{31}$-1]. If the value is out of
* the range, an exception is thrown.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11104001 - Invalid size value. Possible caused by the size value is less than or equal
* <br>to zero.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Sets the threshold for the data size of the event package obtained each time.
*
* @param { number } size Data size threshold, in bytes. The value range is [0, $2^{31}$-1]. If the value is out of
* the range, an exception is thrown.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11104001 - Invalid size value. Possible caused by the size value is less than or equal
* <br>to zero.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
setSize(size: number): void;
/**
* Sets the number of data records of the event package obtained each time. When setRow() and setSize() are called
* at the same time, only setRow() takes effect.
*
* @param { number } size Number of events. The value range is (0, $2^{31}$-1]. If the value is out of the range, an
* exception is thrown.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11104001 - Invalid size value. Possible caused by the size value is less than or equal
* <br>to zero.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 12
*/
/**
* Sets the number of data records of the event package obtained each time. When setRow() and setSize() are called
* at the same time, only setRow() takes effect.
*
* @param { number } size Number of events. The value range is (0, $2^{31}$-1]. If the value is out of the range, an
* exception is thrown.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11104001 - Invalid size value. Possible caused by the size value is less than or equal
* <br>to zero.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
setRow(size: number): void;
/**
* Obtains the subscription event.
* <br>The system obtains the subscription event data based on the data size threshold specified by setSize or the
* number of data records specified by setRow. By default, one subscription event data record is obtained. When all
* subscription event data is obtained, null is returned.
* <br>When setRow and setSize are called at the same time, only setRow takes effect.
*
* @returns { AppEventPackage } Event package object. If all subscription event data has been retrieved, null is
* returned.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Obtains the subscription event.
* <br>The system obtains the subscription event data based on the data size threshold specified by setSize or the
* number of data records specified by setRow. By default, one subscription event data record is obtained. When all
* subscription event data is obtained, null is returned.
* <br>When setRow and setSize are called at the same time, only setRow takes effect.
*
* @returns { AppEventPackage } Event package object. If all subscription event data has been retrieved, null is
* returned.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Obtains the subscription event.
* <br>The system obtains the subscription event data based on the data size threshold specified by setSize or the
* number of data records specified by setRow. By default, one subscription event data record is obtained. When all
* subscription event data is obtained, null is returned.
* <br>When setRow and setSize are called at the same time, only setRow takes effect.
*
* @returns { AppEventPackage } Event package object. If all subscription event data has been retrieved, null is
* returned.
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
takeNext(): AppEventPackage;
}
/**
* Defines the triggering condition parameters of the onTrigger callback of a Watcher.
*
* @interface TriggerCondition
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Defines the triggering condition parameters of the onTrigger callback of a Watcher.
*
* @interface TriggerCondition
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Defines the triggering condition parameters of the onTrigger callback of a Watcher.
*
* @interface TriggerCondition
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
interface TriggerCondition {
/**
* Total number of events that trigger callback. The value is a positive integer. The default value is 0,
* indicating that no callback is triggered. If this parameter is set to a negative value, the default
* value is used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Total number of events that trigger callback. The value is a positive integer. The default value is 0,
* indicating that no callback is triggered. If this parameter is set to a negative value, the default
* value is used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Total number of events that trigger callback. The value is a positive integer. The default value is 0,
* indicating that no callback is triggered. If this parameter is set to a negative value, the default
* value is used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
row?: number;
/**
* Total size of events that trigger callback. The value is a positive integer, in bytes. The default value is 0,
* indicating that no callback is triggered. If this parameter is set to a negative value, the default value is
* used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Total size of events that trigger callback. The value is a positive integer, in bytes. The default value is 0,
* indicating that no callback is triggered. If this parameter is set to a negative value, the default value is
* used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Total size of events that trigger callback. The value is a positive integer, in bytes. The default value is 0,
* indicating that no callback is triggered. If this parameter is set to a negative value, the default value is
* used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
size?: number;
/**
* Timeout interval for triggering callback. The value is a positive integer, in unit of 30s. The default value is
* 0, indicating that no callback is triggered. If this parameter is set to a negative value, the default value is
* used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Timeout interval for triggering callback. The value is a positive integer, in unit of 30s. The default value is
* 0, indicating that no callback is triggered. If this parameter is set to a negative value, the default value is
* used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Timeout interval for triggering callback. The value is a positive integer, in unit of 30s. The default value is
* 0, indicating that no callback is triggered. If this parameter is set to a negative value, the default value is
* used.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
timeOut?: number;
}
/**
* Defines parameters of subscription filtering conditions of a Watcher. This API is used to set event filtering
* conditions in the event watcher to ensure that only the events that meet the filtering conditions are subscribed
* to.
*
* @interface AppEventFilter
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Defines parameters of subscription filtering conditions of a Watcher. This API is used to set event filtering
* conditions in the event watcher to ensure that only the events that meet the filtering conditions are subscribed
* to.
*
* @interface AppEventFilter
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Defines parameters of subscription filtering conditions of a Watcher. This API is used to set event filtering
* conditions in the event watcher to ensure that only the events that meet the filtering conditions are subscribed
* to.
*
* @interface AppEventFilter
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
interface AppEventFilter {
/**
* Event domain, which can be the system event domain (hiAppEvent.domain.OS) or the event domain of the custom
* event information (AppEventInfo) passed through the Write API.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event domain, which can be the system event domain (hiAppEvent.domain.OS) or the event domain of the custom
* event information (AppEventInfo) passed through the Write API.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event domain, which can be the system event domain (hiAppEvent.domain.OS) or the event domain of the custom
* event information (AppEventInfo) passed through the Write API.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
domain: string;
/**
* Event types. If this parameter is not set, events are not filtered by default.
*
* @type { ?EventType[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Event types. If this parameter is not set, events are not filtered by default.
*
* @type { ?EventType[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event types. If this parameter is not set, events are not filtered by default.
*
* @type { ?EventType[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
eventTypes?: EventType[];
/**
* Names of the events to be subscribed. If this parameter is not set, events are not filtered by default.
*
* @type { ?string[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Names of the events to be subscribed. If this parameter is not set, events are not filtered by default.
*
* @type { ?string[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
names?: string[];
}
/**
* Defines parameters of the event group returned by a subscription. This API can be used to obtain detail
* information about an event group, which is often used in the onReceive callback of Watcher.
*
* @interface AppEventGroup
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Defines parameters of the event group returned by a subscription. This API can be used to obtain detail
* information about an event group, which is often used in the onReceive callback of Watcher.
*
* @interface AppEventGroup
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
interface AppEventGroup {
/**
* Event name.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event name.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
name: string;
/**
* Event object group.
*
* @type { Array<AppEventInfo> }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Event object group.
*
* @type { Array<AppEventInfo> }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
appEventInfos: Array<AppEventInfo>;
}
/**
* Defines parameters for a Watcher object. This API is used to configure and manage event watchers to subscribe to
* and process specified events.
*
* @interface Watcher
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Defines parameters for a Watcher object. This API is used to configure and manage event watchers to subscribe to
* and process specified events.
*
* @interface Watcher
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Defines parameters for a Watcher object. This API is used to configure and manage event watchers to subscribe to
* and process specified events.
*
* @interface Watcher
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
interface Watcher {
/**
* Unique name of a watcher. The value contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_). It must start with a letter and end with a digit or letter. For example, testName1
* and crash_Watcher.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Unique name of a watcher. The value contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_). It must start with a letter and end with a digit or letter. For example, testName1
* and crash_Watcher.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Unique name of a watcher. The value contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_). It must start with a letter and end with a digit or letter. For example, testName1
* and crash_Watcher.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
name: string;
/**
* Subscription callback triggering condition. This parameter takes effect only when it is passed together with
* onTrigger. If this parameter is not set, the onTrigger callback is not triggered by default.
*
* @type { ?TriggerCondition }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Subscription callback triggering condition. This parameter takes effect only when it is passed together with
* onTrigger. If this parameter is not set, the onTrigger callback is not triggered by default.
*
* @type { ?TriggerCondition }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Subscription callback triggering condition. This parameter takes effect only when it is passed together with
* onTrigger. If this parameter is not set, the onTrigger callback is not triggered by default.
*
* @type { ?TriggerCondition }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
triggerCondition?: TriggerCondition;
/**
* Subscription filtering condition. This parameter is passed only when subscription events need to be filtered.
* If this parameter is not set, events are not filtered by default.
*
* @type { ?AppEventFilter[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Subscription filtering condition. This parameter is passed only when subscription events need to be filtered.
* If this parameter is not set, events are not filtered by default.
*
* @type { ?AppEventFilter[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Subscription filtering condition. This parameter is passed only when subscription events need to be filtered.
* If this parameter is not set, events are not filtered by default.
*
* @type { ?AppEventFilter[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
appEventFilters?: AppEventFilter[];
/**
* Subscription callback. This parameter takes effect only when it is passed together with triggerCondition.
* The input arguments are described as follows:
* <br>curRow: total number of subscription events when the callback is triggered.
* <br>curSize: total size of subscribed events when the callback is triggered, in bytes.
* <br>holder: subscription data holder, which can be used to process subscribed events.
*
* @type { ?function }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Subscription callback. This parameter takes effect only when it is passed together with triggerCondition.
* The input arguments are described as follows:
* <br>curRow: total number of subscription events when the callback is triggered.
* <br>curSize: total size of subscribed events when the callback is triggered, in bytes.
* <br>holder: subscription data holder, which can be used to process subscribed events.
*
* @type { ?function }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Subscription callback. This parameter takes effect only when it is passed together with triggerCondition.
* The input arguments are described as follows:
* <br>curRow: total number of subscription events when the callback is triggered.
* <br>curSize: total size of subscribed events when the callback is triggered, in bytes.
* <br>holder: subscription data holder, which can be used to process subscribed events.
*
* @type { ?function }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
onTrigger?: (curRow: number, curSize: number, holder: AppEventPackageHolder) => void;
/**
* Real-time subscription callback. Only this callback function is triggered if it is passed together with
* onTrigger. The input arguments are described as follows:
* <br>domain: domain name.
* <br>appEventGroups: event group.
*
* @type { ?function }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Real-time subscription callback. Only this callback function is triggered if it is passed together with
* onTrigger. The input arguments are described as follows:
* <br>domain: domain name.
* <br>appEventGroups: event group.
*
* @type { ?function }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
onReceive?: (domain: string, appEventGroups: Array<AppEventGroup>) => void;
}
/**
* Adds an event watcher. You can use the callback of the event watcher to subscribe to events.
*
* @param { Watcher } watcher Event watcher.
* @returns { AppEventPackageHolder } Subscription data holder. If the subscription fails, null is returned.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 11102001 - Invalid watcher name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11102002 - Invalid filtering event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11102003 - Invalid row value. Possible caused by the row value is less than zero.
* @throws { BusinessError } 11102004 - Invalid size value. Possible caused by the size value is less than zero.
* @throws { BusinessError } 11102005 - Invalid timeout value. Possible caused by the timeout value is less than zero.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Adds an event watcher. You can use the callback of the event watcher to subscribe to events.
*
* @param { Watcher } watcher Event watcher.
* @returns { AppEventPackageHolder } Subscription data holder. If the subscription fails, null is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11102001 - Invalid watcher name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11102002 - Invalid filtering event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11102003 - Invalid row value. Possible caused by the row value is less than zero.
* @throws { BusinessError } 11102004 - Invalid size value. Possible caused by the size value is less than zero.
* @throws { BusinessError } 11102005 - Invalid timeout value. Possible caused by the timeout value is less than zero.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Adds an event watcher. You can use the callback of the event watcher to subscribe to events.
*
* @param { Watcher } watcher Event watcher.
* @returns { AppEventPackageHolder } Subscription data holder. If the subscription fails, null is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11102001 - Invalid watcher name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11102002 - Invalid filtering event domain. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @throws { BusinessError } 11102003 - Invalid row value. Possible caused by the row value is less than zero.
* @throws { BusinessError } 11102004 - Invalid size value. Possible caused by the size value is less than zero.
* @throws { BusinessError } 11102005 - Invalid timeout value. Possible caused by the timeout value is less than zero.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function addWatcher(watcher: Watcher): AppEventPackageHolder;
/**
* Removes an event watcher.
*
* @param { Watcher } watcher Event watcher.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 11102001 - Invalid watcher name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Removes an event watcher.
*
* @param { Watcher } watcher Event watcher.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11102001 - Invalid watcher name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Removes an event watcher.
*
* @param { Watcher } watcher Event watcher.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @throws { BusinessError } 11102001 - Invalid watcher name. Possible causes: 1. Contain invalid characters;
* <br>2. Length is invalid.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function removeWatcher(watcher: Watcher): void;
/**
* Clears local logging data of the application.
*
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @since 9
*/
/**
* Clears local logging data of the application.
*
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Clears local logging data of the application.
*
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function clearData(): void;
/**
* Sets a user ID, which is used for association when a Processor is configured.
*
* @param { string } name Key of a user ID. The value is string that contains a maximum of 256 characters, including
* digits (0 to 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
* @param { string } value Value of a user ID. It can contain a maximum of 256 characters. If the value is null or
* left empty, the user ID is cleared.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Sets a user ID, which is used for association when a Processor is configured.
*
* @param { string } name Key of a user ID. The value is string that contains a maximum of 256 characters, including
* digits (0 to 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
* @param { string } value Value of a user ID. It can contain a maximum of 256 characters. If the value is null or
* left empty, the user ID is cleared.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function setUserId(name: string, value: string): void;
/**
* Obtains the value set through setUserId.
*
* @param { string } name Key of a user ID. The value is string that contains a maximum of 256 characters, including
* digits (0 to 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
* @returns { string } Value of a user ID. If no user ID is found, an empty string is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Obtains the value set through setUserId.
*
* @param { string } name Key of a user ID. The value is string that contains a maximum of 256 characters, including
* digits (0 to 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
* @returns { string } Value of a user ID. If no user ID is found, an empty string is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function getUserId(name: string): string;
/**
* Sets a user property, which is used for association when a Processor is configured.
*
* @param { string } name Key of a user property. The value is string that contains a maximum of 256 characters,
* including digits (0 to 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
* @param { string } value Value of a user property. It can contain a maximum of 1024 characters. If the value is
* null or left empty, the user property is cleared.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Sets a user property, which is used for association when a Processor is configured.
*
* @param { string } name Key of a user property. The value is string that contains a maximum of 256 characters,
* including digits (0 to 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
* @param { string } value Value of a user property. It can contain a maximum of 1024 characters. If the value is
* null or left empty, the user property is cleared.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function setUserProperty(name: string, value: string): void;
/**
* Obtains the value set through setUserProperty.
*
* @param { string } name Key of a user property. The value is string that contains a maximum of 256 characters,
* including digits (0 to 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
* @returns { string } Value of a user property. If no user ID is found, an empty string is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 11
*/
/**
* Obtains the value set through setUserProperty.
*
* @param { string } name Key of a user property. The value is string that contains a maximum of 256 characters,
* including digits (0 to 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
* @returns { string } Value of a user property. If no user ID is found, an empty string is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'19','1.2':'20'}
* @arkts 1.1&1.2
*/
function getUserProperty(name: string): string;
/**
* Event description configuration that can be reported by the data processor
*
* @interface AppEventReportConfig
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
interface AppEventReportConfig {
/**
* Event domain. The value is a string that contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), and underscore (_). It must start with a letter and cannot end with an underscore (_). The default
* value is an empty string.
*
* @type { ?string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
domain?: string;
/**
* Event name. The value is string that contains a maximum of 48 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a
* digit or letter. The default value is an empty string.
*
* @type { ?string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
name?: string;
/**
* Whether to report events in real time. The value true indicates that events are reported in real time, and the
* value false indicates the opposite. The default value is false.
*
* @type { ?boolean }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
isRealTime?: boolean;
}
/**
* Defines a data processor for reporting and managing events. You can customize processor configurations as required.
*
* @interface Processor
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
interface Processor {
/**
* Name of a data processor. The value is string that contains a maximum of 256 characters, including digits (0 to
* 9), letters (a to z), underscore (_), and dollar sign ($). It must not start with a digit.
*
* @type { string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
name: string;
/**
* Whether to enable the debug mode. The default value is false. The value true means to enable the debugging mode,
* and the value false means the opposite.
*
* @type { ?boolean }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
debugMode?: boolean;
/**
* Server location information. It is left empty by default. The length of the input string cannot exceed 8 KB. If
* the length exceeds 8 KB, the default value is used.
*
* @type { ?string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
routeInfo?: string;
/**
* Application ID. It is left empty by default. The length of the input string cannot exceed 8 KB. If the length
* exceeds 8 KB, the default value is used.
*
* @type { ?string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
appId?: string;
/**
* Whether to report an event when the data processor starts. The default value is false. The value true means to
* report events, and the value false means the opposite.
*
* @type { ?boolean }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
onStartReport?: boolean;
/**
* Whether to report an event when an application switches to the background. The default value is false. The value
* true means to report events, and the value false means the opposite.
*
* @type { ?boolean }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
onBackgroundReport?: boolean;
/**
* Interval for event reporting, in seconds. The input value must be greater than or equal to 0. If the input value
* is less than 0, the default value 0 is used and periodic reporting is not performed.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
periodReport?: number;
/**
* Event reporting threshold. When the number of events reaches the threshold, an event is reported. The value must
* be greater than 0 and less than 1000. If the value is not within the range, the default value 0 is used and no
* events are reported.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
batchReport?: number;
/**
* Name array of user IDs that can be reported by the data processor. name corresponds to the name parameter of the
* setUserId API. The default value is an empty array.
*
* @type { ?string[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
userIds?: string[];
/**
* Name array of user properties that can be reported by the data processor. name corresponds to the name parameter
* of the setUserProperty API. The default value is an empty array.
*
* @type { ?string[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
userProperties?: string[];
/**
* Event description configuration array that can be reported by the data processor. The default value is an empty
* array.
*
* @type { ?AppEventReportConfig[] }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
eventConfigs?: AppEventReportConfig[];
/**
* Configuration ID for data processor. The input value must be greater than or equal to 0. If the input value is
* less than 0, the default value 0 is used. If the input value is greater than 0, the value uniquely identifies a
* data processor with its name.
*
* @type { ?number }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
configId?: number;
/**
* Custom extended parameters. If the input parameter name and value do not meet the specifications, extended
* parameters are not configured by default. The specifications are as follows:
* <br>- A parameter name is a string that contains a maximum of 32 characters, including digits (0 to 9), letters
* (a to z), underscore (_), and dollar sign ($). It must start with a letter or dollar sign ($) and end with a
* digit or letter.
* <br>- A parameter value is a string contains a maximum of 1024 characters.
* <br>- The number of parameters must be less than 32.
*
* @type { ?Record<string, string> }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
customConfigs?: Record<string, string>;
/**
* Initialize the processor by reading the configuration file based on the name.
*
* @type { ?string }
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 20
*/
configName?: string;
}
/**
* Adds a data processor to migrate event data to the cloud. You can preset the implementation of the processor on
* the device and set its properties based on its constraints.
* <br>The configuration information of Processor must be provided by the data processor. Yet, as no data processor
* is preset in the device for interaction for the moment, migrating events to the cloud is unavailable.
*
* @param { Processor } processor Data processor.
* @returns { number } ID of the data processor of the reported event, which uniquely identifies the data processor
* and can be used to remove the data processor. If the operation fails, -1 is returned. If the operation is
* successful, a value greater than 0 is returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
function addProcessor(processor: Processor): number;
/**
* Add the processor from config asynchronously, who can report the event.
*
* @param { string } processorName The name of the processor.
* @param { string } [configName] Initialize the processor by reading the configuration file based on the name.
* @returns { Promise<number> } The processor unique ID.
* @throws { BusinessError } 11105001 - Invalid parameter value. Possible causes: 1. Incorrect parameter length;
* <br>2. Incorrect parameter format.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since 20
*/
function addProcessorFromConfig(processorName: string, configName?: string): Promise<number>;
/**
* Removes the data processor of a reported event.
*
* @param { number } id ID of a data processor. The value must be greater than 0. The value is obtained by calling
* addProcessor.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types.
* @static
* @syscap SystemCapability.HiviewDFX.HiAppEvent
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
function removeProcessor(id: number): void;
}
export default hiAppEvent;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助