46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.notificationManager.d.ts 261.10 KB
一键复制 编辑 原始数据 按行查看 历史
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419
/*
* Copyright (c) 2022-2024 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 NotificationKit
*/
import { BundleOption as _BundleOption } from './notification/NotificationCommonDef';
import { NotificationActionButton as _NotificationActionButton } from './notification/notificationActionButton';
import { NotificationBasicContent as _NotificationBasicContent } from './notification/notificationContent';
import { NotificationContent as _NotificationContent } from './notification/notificationContent';
import { NotificationLongTextContent as _NotificationLongTextContent } from './notification/notificationContent';
import { NotificationMultiLineContent as _NotificationMultiLineContent } from './notification/notificationContent';
import { NotificationPictureContent as _NotificationPictureContent } from './notification/notificationContent';
import { NotificationSystemLiveViewContent as _NotificationSystemLiveViewContent } from './notification/notificationContent';
import { NotificationCapsule as _NotificationCapsule } from './notification/notificationContent';
import { NotificationButton as _NotificationButton } from './notification/notificationContent';
import { NotificationTime as _NotificationTime } from './notification/notificationContent';
import { NotificationProgress as _NotificationProgress } from './notification/notificationContent';
import { NotificationFlags as _NotificationFlags } from './notification/notificationFlags';
import { NotificationFlagStatus as _NotificationFlagStatus } from './notification/notificationFlags';
import { NotificationRequest as _NotificationRequest } from './notification/notificationRequest';
import { UnifiedGroupInfo as _UnifiedGroupInfo } from './notification/notificationRequest';
import { DistributedOptions as _DistributedOptions } from './notification/notificationRequest';
import { NotificationSlot as _NotificationSlot } from './notification/notificationSlot';
import { NotificationSorting as _NotificationSorting } from './notification/notificationSorting';
import { NotificationTemplate as _NotificationTemplate } from './notification/notificationTemplate';
import { NotificationUserInput as _NotificationUserInput } from './notification/notificationUserInput';
/*** if arkts 1.1 */
import { AsyncCallback } from './@ohos.base';
import type { NotificationLiveViewContent as _NotificationLiveViewContent } from './notification/notificationContent';
import type { LiveViewStatus as _LiveViewStatus } from './notification/notificationContent';
import type { LiveViewTypes as _LiveViewTypes } from './notification/notificationContent';
import type { NotificationFilter as _NotificationFilter } from './notification/notificationRequest';
import type { NotificationCheckRequest as _NotificationCheckRequest } from './notification/notificationRequest';
import type UIAbilityContext from './application/UIAbilityContext';
/*** endif */
/*** if arkts 1.2 */
import { AsyncCallback } from '@ohos.base';
import type { NotificationLiveViewContent as _NotificationLiveViewContent } from './notification/notificationContent';
import type { LiveViewStatus as _LiveViewStatus } from './notification/notificationContent';
import type { LiveViewTypes as _LiveViewTypes } from './notification/notificationContent';
import type { NotificationFilter as _NotificationFilter } from './notification/notificationRequest';
import type { NotificationCheckRequest as _NotificationCheckRequest } from './notification/notificationRequest';
import type UIAbilityContext from './application/UIAbilityContext';
/*** endif */
/**
* The NotificationManager module provides notification management capabilities, covering notifications,
* notification slots, notification enabled status, and notification badge status.
*
* @namespace notificationManager
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* The NotificationManager module provides notification management capabilities, covering notifications,
* notification slots, notification enabled status, and notification badge status.
*
* @namespace notificationManager
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace notificationManager {
/**
* Publish a notification. This API uses an asynchronous callback to return the result.
* If the ID and label of the new notification are the same as that of the previous notification, the new one replaces the previous one.
*
* @param { NotificationRequest } request - Content and related configuration of the notification to publish.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Publish a notification. This API uses an asynchronous callback to return the result.
* If the ID and label of the new notification are the same as that of the previous notification, the new one replaces the previous one.
*
* @param { NotificationRequest } request - Content and related configuration of the notification to publish.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600014 - No permission.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Publish a notification. This API uses an asynchronous callback to return the result.
* If the ID and label of the new notification are the same as that of the previous notification, the new one replaces the previous one.
*
* @param { NotificationRequest } request - Content and related configuration of the notification to publish.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600014 - No permission.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 1600020 - The application is not allowed to send notifications due to permission settings.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function publish(request: NotificationRequest, callback: AsyncCallback<void>): void;
/**
* Publish a notification. This API uses a promise to return the result.
* If the ID and label of the new notification are the same as that of the previous notification, the new one replaces the previous one.
*
* @param { NotificationRequest } request - Content and related configuration of the notification to publish.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Publish a notification. This API uses a promise to return the result.
* If the ID and label of the new notification are the same as that of the previous notification, the new one replaces the previous one.
*
* @param { NotificationRequest } request - Content and related configuration of the notification to publish.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600014 - No permission.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Publish a notification. This API uses a promise to return the result.
* If the ID and label of the new notification are the same as that of the previous notification, the new one replaces the previous one.
*
* @param { NotificationRequest } request - Content and related configuration of the notification to publish.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600014 - No permission.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 1600020 - The application is not allowed to send notifications due to permission settings.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function publish(request: NotificationRequest): Promise<void>;
/**
* Publishes a notification to the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationRequest } request - a notification.
* @param { number } userId - of subscriber receiving the notification.
* @param { AsyncCallback<void> } callback - The callback of publish.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Publishes a notification to the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationRequest } request - a notification.
* @param { number } userId - of subscriber receiving the notification.
* @param { AsyncCallback<void> } callback - The callback of publish.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600014 - No permission.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Publishes a notification to the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER or ohos.permission.SEND_NOTIFICATION_CROSS_USER
* @param { NotificationRequest } request - a notification.
* @param { number } userId - of subscriber receiving the notification.
* @param { AsyncCallback<void> } callback - The callback of publish.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600014 - No permission.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 1600020 - The application is not allowed to send notifications due to permission settings.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function publish(request: NotificationRequest, userId: number, callback: AsyncCallback<void>): void;
/**
* Publishes a notification to the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationRequest } request - a notification.
* @param { number } userId - of subscriber receiving the notification.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Publishes a notification to the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationRequest } request - a notification.
* @param { number } userId - of subscriber receiving the notification.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600014 - No permission.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Publishes a notification to the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER or ohos.permission.SEND_NOTIFICATION_CROSS_USER
* @param { NotificationRequest } request - a notification.
* @param { number } userId - of subscriber receiving the notification.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600014 - No permission.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 1600020 - The application is not allowed to send notifications due to permission settings.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function publish(request: NotificationRequest, userId: number): Promise<void>;
/**
* Publishes a representative notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { NotificationRequest } request - a notification.
* @param { string } representativeBundle - bundle name of the representative
* @param { number } userId - userid of the representative
* @param { AsyncCallback<void> } callback - The callback of publishAsBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 1600020 - The application is not allowed to send notifications due to permission settings.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function publishAsBundle(
request: NotificationRequest,
representativeBundle: string,
userId: number,
callback: AsyncCallback<void>
): void;
/**
* Publishes a representative notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { NotificationRequest } request - a notification.
* @param { string } representativeBundle - bundle name of the representative
* @param { number } userId - userid of the representative
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 1600020 - The application is not allowed to send notifications due to permission settings.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number): Promise<void>;
/**
* Publishes a representative notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { BundleOption } representativeBundle - bundle option of the representative.
* @param { NotificationRequest } request - a notification.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600005 - Notification slot disabled.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600009 - The notification sending frequency reaches the upper limit.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600015 - The current notification status does not support duplicate configurations.
* @throws { BusinessError } 1600016 - The notification version for this update is too low.
* @throws { BusinessError } 1600020 - The application is not allowed to send notifications due to permission settings.
* @throws { BusinessError } 2300007 - Network unreachable.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
function publishAsBundle(representativeBundle: BundleOption, request: NotificationRequest): Promise<void>;
/**
* Cancels a notification with the specified ID. This API uses an asynchronous callback to return the result.
*
* @param { number } id - Notification ID.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Cancels a notification with the specified ID. This API uses an asynchronous callback to return the result.
*
* @param { number } id - Notification ID.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function cancel(id: number, callback: AsyncCallback<void>): void;
/**
* Cancels a notification with the specified ID and label. This API uses an asynchronous callback to return the result.
*
* @param { number } id - Notification ID.
* @param { string } label - Notification label.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function cancel(id: number, label: string, callback: AsyncCallback<void>): void;
/**
* Cancels a notification with the specified ID and optional label. This API uses a promise to return the result.
*
* @param { number } id - Notification ID.
* @param { string } [label] - Notification label. This parameter is left empty by default.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function cancel(id: number, label?: string): Promise<void>;
/**
* Cancel a notification with the representative and ID.
*
* @param { BundleOption } representativeBundle - bundle option of the representative.
* @param { number } id - ID of the notification to cancel, which must be unique in the application.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600017 - There is no corresponding agent relationship configuration.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function cancel(representativeBundle: BundleOption, id: number): Promise<void>;
/**
* Cancel a representative notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { number } id - ID of the notification to cancel, which must be unique in the application.
* @param { string } representativeBundle - bundle name of the representative.
* @param { number } userId - userid of the representative.
* @param { AsyncCallback<void> } callback - The callback of cancelAsBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function cancelAsBundle(
id: number,
representativeBundle: string,
userId: number,
callback: AsyncCallback<void>
): void;
/**
* Cancel a representative notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { number } id - ID of the notification to cancel, which must be unique in the application.
* @param { string } representativeBundle - bundle name of the representative.
* @param { number } userId - userid of the representative.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise<void>;
/**
* Cancel a representative notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { BundleOption } representativeBundle - bundle option of the representative.
* @param { number } id - ID of the notification to cancel, which must be unique in the application.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
function cancelAsBundle(representativeBundle: BundleOption, id: number): Promise<void>;
/**
* Cancels all notifications of this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Cancels all notifications of this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function cancelAll(callback: AsyncCallback<void>): void;
/**
* Cancels all notifications of this application. This API uses a promise to return the result.
*
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Cancels all notifications of this application. This API uses a promise to return the result.
*
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function cancelAll(): Promise<void>;
/**
* Creates a notification slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSlot } slot - Indicates the notification slot to be created, which is set by {@link NotificationSlot}.
* @param { AsyncCallback<void> } callback - The callback of addSlot.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function addSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void;
/**
* Creates a notification slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSlot } slot - Indicates the notification slot to be created, which is set by {@link NotificationSlot}.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function addSlot(slot: NotificationSlot): Promise<void>;
/**
* Adds a notification slot of a specified type. This API uses an asynchronous callback to return the result.
*
* @param { SlotType } type - Type of the notification slot to add.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function addSlot(type: SlotType, callback: AsyncCallback<void>): void;
/**
* Adds a notification slot of a specified type. This API uses a promise to return the result.
*
* @param { SlotType } type - Type of the notification slot to add.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function addSlot(type: SlotType): Promise<void>;
/**
* Creates notification slots.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<NotificationSlot> } slots - Indicates the notification slots to be created, which is set by {@link NotificationSlot}.
* @param { AsyncCallback<void> } callback - The callback of addSlots.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function addSlots(slots: Array<NotificationSlot>, callback: AsyncCallback<void>): void;
/**
* Creates notification slots.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<NotificationSlot> } slots - Indicates the notification slots to be created, which is set by {@link NotificationSlot}.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function addSlots(slots: Array<NotificationSlot>): Promise<void>;
/**
* Obtains a notification slot of a specified type. This API uses an asynchronous callback to return the result.
*
* @param { SlotType } slotType - Type of a notification slot, such as social communication, service notification, content consultation, and so on.
* @param { AsyncCallback<NotificationSlot> } callback - Callback used to return the result. If the operation is successful, err is undefined
* and data is the obtained NotificationSlot; otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>): void;
/**
* Obtains a notification slot of a specified type. This API uses a promise to return the result.
*
* @param { SlotType } slotType - Type of a notification slot, such as social communication, service notification, content consultation, and so on.
* @returns { Promise<NotificationSlot> } 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.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function getSlot(slotType: SlotType): Promise<NotificationSlot>;
/**
* Obtains all notification slots of this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<Array<NotificationSlot>> } callback - Callback used to return the result. If the operation is successful, err is undefined
* and data is the obtained NotificationSlot array; otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function getSlots(callback: AsyncCallback<Array<NotificationSlot>>): void;
/**
* Obtains all notification slots of this application. This API uses a promise to return the result.
*
* @returns { Promise<Array<NotificationSlot>> } Promise used to return the NotificationSlot array.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function getSlots(): Promise<Array<NotificationSlot>>;
/**
* Obtains allow notification application list.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<Array<BundleOption>> } Returns all enable notification applications.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
function getAllNotificationEnabledBundles(): Promise<Array<BundleOption>>;
/**
* Removes a notification slot of a specified type for this application. This API uses an asynchronous callback to return the result.
*
* @param { SlotType } slotType - Type of a notification slot, such as social communication, service notification, content consultation, and so on.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function removeSlot(slotType: SlotType, callback: AsyncCallback<void>): void;
/**
* Removes a notification slot of a specified type for this application. This API uses a promise to return the result.
*
* @param { SlotType } slotType - Type of a notification slot, such as social communication, service notification, content consultation, and so on.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function removeSlot(slotType: SlotType): Promise<void>;
/**
* Removes all notification slots for this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function removeAllSlots(callback: AsyncCallback<void>): void;
/**
* Removes all notification slots for this application. This API uses a promise to return the result.
*
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function removeAllSlots(): Promise<void>;
/**
* Set whether the application can send notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setNotificationEnable.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function setNotificationEnable(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void;
/**
* Set whether the application can send notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function setNotificationEnable(bundle: BundleOption, enable: boolean): Promise<void>;
/**
* Checks whether this application allows to publish notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<boolean> } callback - The callback of isNotificationEnabled.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback<boolean>): void;
/**
* Checks whether this application allows to publish notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<boolean> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isNotificationEnabled(bundle: BundleOption): Promise<boolean>;
/**
* Checks whether notification is enabled for the specified application. This API uses an asynchronous callback to return the result.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<boolean> } callback - Callback used to return the result. The value true means that the
* notification is enabled, and false means the opposite.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Checks whether notification is enabled for the specified application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result. The value true means that the
* notification is enabled, and false means the opposite.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Checks whether notification is enabled for the specified application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result. The value true means that the
* notification is enabled, and false means the opposite.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isNotificationEnabled(callback: AsyncCallback<boolean>): void;
/**
* Checks whether notification is enabled for the specified application. This API uses a promise to return the result.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<boolean> } Promise used to return the result. The value true means that the notification is enabled, and false means the opposite.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Checks whether notification is enabled for the specified application. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result. The value true means that the notification is enabled, and false means the opposite.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Checks whether notification is enabled for the specified application. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result. The value true means that the notification is enabled, and false means the opposite.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isNotificationEnabled(): Promise<boolean>;
/**
* Checks whether notification is enabled for the specified application. This API returns the result synchronously.
*
* @returns { boolean } Result of the notification enabling status. The value true means that the notification is enabled,
* and false means the opposite.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 12
*/
function isNotificationEnabledSync(): boolean;
/**
* Checks whether this application allows to publish notifications under the user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userid of the representative.
* @param { AsyncCallback<boolean> } callback - The callback of isNotificationEnabled.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isNotificationEnabled(userId: number, callback: AsyncCallback<boolean>): void;
/**
* Checks whether this application allows to publish notifications under the user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userid of the representative.
* @returns { Promise<boolean> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isNotificationEnabled(userId: number): Promise<boolean>;
/**
* Sets whether to allow the specified application to show badge.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of displayBadge.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Sets whether to allow the specified application to show badge.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of displayBadge.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void;
/**
* Sets whether to allow the specified application to show badge.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Sets whether to allow the specified application to show badge.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function displayBadge(bundle: BundleOption, enable: boolean): Promise<void>;
/**
* Obtains the flag that whether to allow the application to show badge.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<boolean> } callback - The callback of isBadgeDisplayed.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains the flag that whether to allow the application to show badge.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<boolean> } callback - The callback of isBadgeDisplayed.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback<boolean>): void;
/**
* Obtains the flag that whether to allow the application to show badge.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<boolean> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains the flag that whether to allow the application to show badge.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<boolean> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isBadgeDisplayed(bundle: BundleOption): Promise<boolean>;
/**
* Update all notification slots for the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { NotificationSlot } slot - Indicates the notification slot.
* @param { AsyncCallback<void> } callback - The callback of setSlotByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Update all notification slots for the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { NotificationSlot } slot - Indicates the notification slot.
* @param { AsyncCallback<void> } callback - The callback of setSlotByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback<void>): void;
/**
* Update all notification slots for the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { NotificationSlot } slot - Indicates the notification slot.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Update all notification slots for the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { NotificationSlot } slot - Indicates the notification slot.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise<void>;
/**
* Obtains all notification slots belonging to the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<Array<NotificationSlot>> } callback - The callback of getSlotsByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains all notification slots belonging to the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<Array<NotificationSlot>> } callback - The callback of getSlotsByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array<NotificationSlot>>): void;
/**
* Get notification slot for the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } slotType - Indicates the notification slot.
* @returns { Promise<NotificationSlot> } Returns the NotificationSlot.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Get notification slot for the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } slotType - Indicates the notification slot.
* @returns { Promise<NotificationSlot> } Returns the NotificationSlot.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getSlotByBundle(bundle: BundleOption, slotType: SlotType): Promise<NotificationSlot>;
/**
* Obtains all notification slots belonging to the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<Array<NotificationSlot>> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains all notification slots belonging to the specified bundle.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<Array<NotificationSlot>> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getSlotsByBundle(bundle: BundleOption): Promise<Array<NotificationSlot>>;
/**
* Obtains number of slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<number> } callback - The callback of getSlotNumByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains number of slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<number> } callback - The callback of getSlotNumByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback<number>): void;
/**
* Obtains number of slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<number> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains number of slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<number> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getSlotNumByBundle(bundle: BundleOption): Promise<number>;
/**
* Obtains all active notifications in the current system. The caller must have system permissions to
* call this method.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<Array<NotificationRequest>> } callback - The callback of getAllActiveNotifications.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getAllActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void;
/**
* Obtains all active notifications in the current system. The caller must have system permissions to
* call this method.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<Array<NotificationRequest>> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getAllActiveNotifications(): Promise<Array<NotificationRequest>>;
/**
* Obtains the number of active notifications of this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<number> } callback - Callback used to return the result. If the operation is successful, err is undefined and data is the
* obtained number of active notifications; otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getActiveNotificationCount(callback: AsyncCallback<number>): void;
/**
* Obtains the number of active notifications of this application. This API uses a promise to return the result.
*
* @returns { Promise<number> } Promise used to return the result.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getActiveNotificationCount(): Promise<number>;
/**
* Obtains the active notifications of this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<Array<NotificationRequest>> } callback - Callback used to return the result. If the operation is successful,
* err is undefined and data is the obtained NotificationRequest array;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void;
/**
* Obtains the active notifications of this application. This API uses a promise to return the result.
*
* @returns { Promise<Array<NotificationRequest>> } Promise used to return the result.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getActiveNotifications(): Promise<Array<NotificationRequest>>;
/**
* Get the live view notification by bundle option and notification key. If the extraInfoKeys is provided,
* filter the additional information of the live view notification and return the filtered result.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationFilter } filter - The bundle, notification key and additional information filter of the live view notification.
* @param { AsyncCallback<NotificationRequest> } callback - The callback of getActiveNotificationByFilter.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
function getActiveNotificationByFilter(filter: NotificationFilter, callback: AsyncCallback<NotificationRequest>): void;
/**
* Get the live view notification by bundle option and notification key. If the extraInfoKeys is provided,
* filter the additional information of the live view notification and return the filtered result.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationFilter } filter - The bundle, notification key and additional information filter of the live view notification.
* @returns { Promise<NotificationRequest> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
function getActiveNotificationByFilter(filter: NotificationFilter): Promise<NotificationRequest>;
/**
* Cancels notifications under a notification group of this application. This API uses an asynchronous callback to return the result.
*
* @param { string } groupName - Name of the notification group, which is specified through NotificationRequest when the notification is published.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined; otherwise,
* err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function cancelGroup(groupName: string, callback: AsyncCallback<void>): void;
/**
* Cancels notifications under a notification group of this application. This API uses a promise to return the result.
*
* @param { string } groupName - Name of the notification group, which is specified through NotificationRequest when the notification is published.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function cancelGroup(groupName: string): Promise<void>;
/**
* Delete the notification of a specified group for this application.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { string } groupName - The name of the group.
* @param { AsyncCallback<void> } callback - The callback of removeGroupByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback<void>): void;
/**
* Delete the notification of a specified group for this application.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { string } groupName - The name of the group.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function removeGroupByBundle(bundle: BundleOption, groupName: string): Promise<void>;
/**
* Set the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - The Do Not Disturb date.
* @param { AsyncCallback<void> } callback - The callback of setDoNotDisturbDate.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Set the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - The Do Not Disturb date.
* @param { AsyncCallback<void> } callback - The callback of setDoNotDisturbDate.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback<void>): void;
/**
* Set the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - The Do Not Disturb date.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Set the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - The Do Not Disturb date.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDoNotDisturbDate(date: DoNotDisturbDate): Promise<void>;
/**
* Set the Do Not Disturb date under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - The Do Not Disturb date.
* @param { number } userId - The userId.
* @param { AsyncCallback<void> } callback - The callback of setDoNotDisturbDate.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Set the Do Not Disturb date under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - The Do Not Disturb date.
* @param { number } userId - The userId.
* @param { AsyncCallback<void> } callback - The callback of setDoNotDisturbDate.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallback<void>): void;
/**
* Set the Do Not Disturb date under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - The Do Not Disturb date.
* @param { number } userId - The userId.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Set the Do Not Disturb date under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - The Do Not Disturb date.
* @param { number } userId - The userId.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise<void>;
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<DoNotDisturbDate> } callback - The callback is used to return the Do Not Disturb date.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<DoNotDisturbDate> } callback - The callback is used to return the Do Not Disturb date.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getDoNotDisturbDate(callback: AsyncCallback<DoNotDisturbDate>): void;
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<DoNotDisturbDate> } Returns the Do Not Disturb date.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<DoNotDisturbDate> } Returns the Do Not Disturb date.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getDoNotDisturbDate(): Promise<DoNotDisturbDate>;
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @param { AsyncCallback<DoNotDisturbDate> } callback - The callback is used to return the Do Not Disturb date.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @param { AsyncCallback<DoNotDisturbDate> } callback - The callback is used to return the Do Not Disturb date.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getDoNotDisturbDate(userId: number, callback: AsyncCallback<DoNotDisturbDate>): void;
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @returns { Promise<DoNotDisturbDate> } Returns the Do Not Disturb date.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @returns { Promise<DoNotDisturbDate> } Returns the Do Not Disturb date.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getDoNotDisturbDate(userId: number): Promise<DoNotDisturbDate>;
/**
* Obtains whether to support the Do Not Disturb mode.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<boolean> } callback - The callback is used to return whether Do Not Disturb
* mode is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function isSupportDoNotDisturbMode(callback: AsyncCallback<boolean>): void;
/**
* Obtains whether to support the Do Not Disturb mode.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<boolean> } Returns whether Do Not Disturb mode is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function isSupportDoNotDisturbMode(): Promise<boolean>;
/**
* Checks whether a specified template is supported before using NotificationTemplate to publish a notification.
* This API uses an asynchronous callback to return the result.
*
* @param { string } templateName - Template name. Currently, only downloadTemplate is supported.
* @param { AsyncCallback<boolean> } callback - Callback used to return the result. The value true means that the specified template is supported,
* and false means the opposite.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function isSupportTemplate(templateName: string, callback: AsyncCallback<boolean>): void;
/**
* Checks whether a specified template is supported before using NotificationTemplate to publish a notification. This API uses a promise to return the result.
*
* @param { string } templateName - Template name. Currently, only downloadTemplate is supported.
* @returns { Promise<boolean> } Promise used to return the result. The value true means that the specified template
* is supported, and false means the opposite.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function isSupportTemplate(templateName: string): Promise<boolean>;
/**
* Requests notification to be enabled for this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Requests notification to be enabled for this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600013 - A notification dialog box is already displayed.
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Requests notification to be enabled for this application. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600013 - A notification dialog box is already displayed.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since 12
* @deprecated since 12
* @useinstead requestEnableNotification
*/
function requestEnableNotification(callback: AsyncCallback<void>): void;
/**
* Requests notification to be enabled for this application. You can call this API to display a dialog box prompting the user to enable
* notification for your application before publishing a notification. This API uses an asynchronous callback to return the result.
*
* @param { UIAbilityContext } context - Ability context bound to the notification dialog box.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @StageModelOnly
* @since 10
*/
/**
* Requests notification to be enabled for this application. You can call this API to display a dialog box prompting the user to enable
* notification for your application before publishing a notification. This API uses an asynchronous callback to return the result.
*
* @param { UIAbilityContext } context - Ability context bound to the notification dialog box.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600013 - A notification dialog box is already displayed.
* @syscap SystemCapability.Notification.Notification
* @StageModelOnly
* @since 11
*/
/**
* Requests notification to be enabled for this application. You can call this API to display a dialog box prompting the user to enable
* notification for your application before publishing a notification. This API uses an asynchronous callback to return the result.
*
* @param { UIAbilityContext } context - Ability context bound to the notification dialog box.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful, err is undefined;
* otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600013 - A notification dialog box is already displayed.
* @syscap SystemCapability.Notification.Notification
* @StageModelOnly
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback<void>): void;
/**
* Requests notification to be enabled for this application. This API uses a promise to return the URI of the file in the destination directory.
*
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Requests notification to be enabled for this application. This API uses a promise to return the URI of the file in the destination directory.
*
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600013 - A notification dialog box is already displayed.
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Requests notification to be enabled for this application. This API uses a promise to return the URI of the file in the destination directory.
*
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600013 - A notification dialog box is already displayed.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since 12
* @deprecated since 12
* @useinstead requestEnableNotification
*/
function requestEnableNotification(): Promise<void>;
/**
* Requests notification to be enabled for this application. You can call this API to display a dialog box prompting the user to enable
* notification for your application before publishing a notification. This API uses a promise to return the result.
*
* @param { UIAbilityContext } context - Ability context bound to the notification dialog box.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @StageModelOnly
* @since 10
*/
/**
* Requests notification to be enabled for this application. You can call this API to display a dialog box prompting the user to enable
* notification for your application before publishing a notification. This API uses a promise to return the result.
*
* @param { UIAbilityContext } context - Ability context bound to the notification dialog box.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600013 - A notification dialog box is already displayed.
* @syscap SystemCapability.Notification.Notification
* @StageModelOnly
* @since 11
*/
/**
* Requests notification to be enabled for this application. You can call this API to display a dialog box prompting the user to enable
* notification for your application before publishing a notification. This API uses a promise to return the result.
*
* @param { UIAbilityContext } context - Ability context bound to the notification dialog box.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600004 - Notification disabled.
* @throws { BusinessError } 1600013 - A notification dialog box is already displayed.
* @syscap SystemCapability.Notification.Notification
* @StageModelOnly
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
function requestEnableNotification(context: UIAbilityContext): Promise<void>;
/**
* Sets whether the device supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setDistributedEnable.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Sets whether the device supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setDistributedEnable.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDistributedEnable(enable: boolean, callback: AsyncCallback<void>): void;
/**
* Sets whether the device supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Sets whether the device supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDistributedEnable(enable: boolean): Promise<void>;
/**
* Checks whether the device supports cross-device notifications. This API uses an asynchronous callback to return the result.
*
* @param { AsyncCallback<boolean> } callback - Callback used to return the result. The value true means that
* distributed notification is enabled, and false means the opposite.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function isDistributedEnabled(callback: AsyncCallback<boolean>): void;
/**
* Checks whether the device supports cross-device notifications. This API uses a promise to return the result.
*
* @returns { Promise<boolean> } Promise used to return the result. The value true means that distributed notification
* is enabled, and false means the opposite.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
function isDistributedEnabled(): Promise<boolean>;
/**
* Sets whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setDistributedEnableByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Sets whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setDistributedEnableByBundle.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDistributedEnableByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void;
/**
* Sets whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Sets whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDistributedEnableByBundle(bundle: BundleOption, enable: boolean): Promise<void>;
/**
* Sets whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { string } deviceType - The device type.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Sets whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { string } deviceType - The device type.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDistributedEnabledByBundle(bundle: BundleOption, deviceType: string, enable: boolean): Promise<void>;
/**
* Obtains whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<boolean> } callback - The callback is used to return whether the distributed
* notification is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<boolean> } callback - The callback is used to return whether the distributed
* notification is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback<boolean>): void;
/**
* Obtains whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<boolean> } Returns whether the distributed notification is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<boolean> } Returns whether the distributed notification is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function isDistributedEnabledByBundle(bundle: BundleOption): Promise<boolean>;
/**
* Obtains whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { string } deviceType - The device type.
* @returns { Promise<boolean> } Returns whether the distributed notification is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Obtains whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { string } deviceType - The device type.
* @returns { Promise<boolean> } Returns whether the distributed notification is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function isDistributedEnabledByBundle(bundle: BundleOption, deviceType: string): Promise<boolean>;
/**
* Sets whether applications supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<DistributedBundleEnableInfo> } bundleEnableInfos - The enable bundles.
* @param { string } deviceType - The device type.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
*/
function setDistributedEnableByBundles(bundleEnableInfos: Array<DistributedBundleEnableInfo>, deviceType: string): Promise<void>;
/**
* Sets whether an application supports smart reminders across devices.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } deviceType - The device type.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Sets whether an application supports smart reminders across devices.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } deviceType - The device type.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setSmartReminderEnabled(deviceType: string, enable: boolean): Promise<void>;
/**
* Obtains whether an application supports smart reminders across devices.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } deviceType - The device type.
* @returns { Promise<boolean> } Returns whether the smart reminders across devices notification is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Obtains whether an application supports smart reminders across devices.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } deviceType - The device type.
* @returns { Promise<boolean> } Returns whether the smart reminders across devices notification is supported.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function isSmartReminderEnabled(deviceType: string): Promise<boolean>;
/**
* Obtains the remind modes of the notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<DeviceRemindType> } callback - The callback is used to return the RemindType.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains the remind modes of the notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<DeviceRemindType> } callback - The callback is used to return the RemindType.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getDeviceRemindType(callback: AsyncCallback<DeviceRemindType>): void;
/**
* Obtains the remind modes of the notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<DeviceRemindType> } Returns the RemindType.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains the remind modes of the notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<DeviceRemindType> } Returns the RemindType.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getDeviceRemindType(): Promise<DeviceRemindType>;
/**
* Set whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setNotificationEnableSlot.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Set whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setNotificationEnableSlot.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Set whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setNotificationEnableSlot.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function setNotificationEnableSlot(
bundle: BundleOption,
type: SlotType,
enable: boolean,
callback: AsyncCallback<void>
): void;
/**
* Set whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { boolean } enable - Set enable or not.
* @param { boolean } isForceControl - Is the notification slot enable affected by the application
* notification enable, false means affected.
* @param { AsyncCallback<void> } callback - The callback of setNotificationEnableSlot.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Set whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { boolean } enable - Set enable or not.
* @param { boolean } isForceControl - Is the notification slot enable affected by the application
* notification enable, false means affected.
* @param { AsyncCallback<void> } callback - The callback of setNotificationEnableSlot.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function setNotificationEnableSlot(
bundle: BundleOption,
type: SlotType,
enable: boolean,
isForceControl: boolean,
callback: AsyncCallback<void>,
): void;
/**
* Set whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Set whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { boolean } enable - Set enable or not.
* @param { boolean } isForceControl - Is the notification slot enable affected by the application
* notification enable, false means affected.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Set whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { boolean } enable - Set enable or not.
* @param { boolean } isForceControl - Is the notification slot enable affected by the application
* notification enable, false means affected.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean, isForceControl?: boolean): Promise<void>;
/**
* Obtains whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { AsyncCallback<boolean> } callback - The callback is used to return whether the application slot is enabled.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @param { AsyncCallback<boolean> } callback - The callback is used to return whether the application slot is enabled.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback<boolean>): void;
/**
* Obtains whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @returns { Promise<boolean> } Returns whether the application slot is enabled.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Obtains whether the application slot is enabled.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { SlotType } type - Type of the notification slot.
* @returns { Promise<boolean> } Returns whether the application slot is enabled.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise<boolean>;
/**
* Set whether to sync notifications to devices that do not have the app installed.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setSyncNotificationEnabledWithoutApp.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Set whether to sync notifications to devices that do not have the app installed.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @param { boolean } enable - Set enable or not.
* @param { AsyncCallback<void> } callback - The callback of setSyncNotificationEnabledWithoutApp.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: AsyncCallback<void>): void;
/**
* Set whether to sync notifications to devices that do not have the app installed.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Set whether to sync notifications to devices that do not have the app installed.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @param { boolean } enable - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise<void>;
/**
* Obtains whether to sync notifications to devices that do not have the app installed.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @param { AsyncCallback<boolean> } callback - The callback is used to return whether to sync notifications to devices.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback<boolean>): void;
/**
* Obtains whether to sync notifications to devices that do not have the app installed.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @returns { Promise<boolean> } Returns whether to sync notifications to devices.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function getSyncNotificationEnabledWithoutApp(userId: number): Promise<boolean>;
/**
* Sets the notification badge number. This API uses an asynchronous callback to return the result.
*
* @param { number } badgeNumber - Notification badge number to set. If badgeNumber is set to 0, badges are cleared;
* if the value is greater than 99, 99+ is displayed on the badge.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful,
* err is undefined; otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @since 10
*/
/**
* Sets the notification badge number. This API uses an asynchronous callback to return the result.
*
* @param { number } badgeNumber - Notification badge number to set. If badgeNumber is set to 0, badges are cleared;
* if the value is greater than 99, 99+ is displayed on the badge.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful,
* err is undefined; otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since 12
*/
/**
* Sets the notification badge number. This API uses an asynchronous callback to return the result.
*
* @param { number } badgeNumber - Notification badge number to set. If badgeNumber is set to 0, badges are cleared;
* if the value is greater than 99, 99+ is displayed on the badge.
* @param { AsyncCallback<void> } callback - Callback used to return the result. If the operation is successful,
* err is undefined; otherwise, err is an error object.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since 18
*/
function setBadgeNumber(badgeNumber: number, callback: AsyncCallback<void>): void;
/**
* Sets the notification badge number. This API uses a promise to return the result.
*
* @param { number } badgeNumber - Notification badge number to set. If badgeNumber is set to 0, badges are cleared;
* if the value is greater than 99, 99+ is displayed on the badge.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @since 10
*/
/**
* Sets the notification badge number. This API uses a promise to return the result.
*
* @param { number } badgeNumber - Notification badge number to set. If badgeNumber is set to 0, badges are cleared;
* if the value is greater than 99, 99+ is displayed on the badge.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since 12
*/
/**
* Sets the notification badge number. This API uses a promise to return the result.
*
* @param { number } badgeNumber - Notification badge number to set. If badgeNumber is set to 0, badges are cleared;
* if the value is greater than 99, 99+ is displayed on the badge.
* @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. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since 18
*/
function setBadgeNumber(badgeNumber: number): Promise<void>;
/**
* Set badge number by bundle.
*
* @param { BundleOption } bundle - Use the bundleOption to carry bundleName and uid of the application.
* @param { number } badgeNumber - Badge number.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600017 - There is no corresponding agent relationship configuration.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Set badge number by bundle.
*
* @param { BundleOption } bundle - Use the bundleOption to carry bundleName and uid of the application.
* @param { number } badgeNumber - Badge number.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 1600017 - There is no corresponding agent relationship configuration.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setBadgeNumberByBundle(bundle: BundleOption, badgeNumber: number): Promise<void>;
/**
* Subscribe the callback for check notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { 'checkNotification' } type - Type of the callback to listen for.
* @param { function } callback - callback - The callback of check notifications.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 10
*/
/**
* Subscribe the callback for check notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { 'checkNotification' } type - Type of the callback to listen for.
* @param { function } callback - callback - The callback of check notifications.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function on(type: 'checkNotification', callback: (checkInfo: NotificationCheckInfo) => NotificationCheckResult): void;
/**
* Subscribe the callback for check notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { 'checkNotification' } type - Type of the callback to listen for.
* @param { NotificationCheckRequest } checkRequest - Check Request for filter notification request.
* @param { function } callback - callback - The callback of check notifications.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Subscribe the callback for check notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { 'checkNotification' } type - Type of the callback to listen for.
* @param { NotificationCheckRequest } checkRequest - Check Request for filter notification request.
* @param { function } callback - callback - The callback of check notifications.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function on(type: 'checkNotification', checkRequest: NotificationCheckRequest,
callback: (checkInfo: NotificationCheckInfo) => Promise<NotificationCheckResult>): void;
/**
* Unsubscribe the callback for check notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { 'checkNotification' } type - Type of the callback to listen for.
* @param { function } [callback] - callback - The callback of check notifications.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 10
*/
/**
* Unsubscribe the callback for check notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { 'checkNotification' } type - Type of the callback to listen for.
* @param { function } [callback] - callback - The callback of check notifications.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function off(
type: 'checkNotification',
callback?: (checkInfo: NotificationCheckInfo) => NotificationCheckResult
): void;
/**
* Trigger system live view notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { number } notificationId - The notification id.
* @param { ButtonOptions } buttonOptions - The button option.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Trigger system live view notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { number } notificationId - The notification id.
* @param { ButtonOptions } buttonOptions - The button option.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function triggerSystemLiveView(bundle: BundleOption, notificationId: number, buttonOptions: ButtonOptions): Promise<void>;
/**
* Subscribe to system live view notifications
*
* @param { SystemLiveViewSubscriber } subscriber - The system live vie notification subscriber.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Subscribe to system live view notifications
*
* @param { SystemLiveViewSubscriber } subscriber - The system live vie notification subscriber.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function subscribeSystemLiveView(subscriber: SystemLiveViewSubscriber): Promise<void>;
/**
* Set basic configurations of application-level notification channels.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { number } slotFlags - Indicates the slotFlags.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Set basic configurations of application-level notification channels.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { number } slotFlags - Indicates the slotFlags.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function setSlotFlagsByBundle(bundle: BundleOption, slotFlags: number): Promise<void>;
/**
* Obtains basic configurations of application-level notification channels.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<number> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
/**
* Obtains basic configurations of application-level notification channels.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<number> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function getSlotFlagsByBundle(bundle: BundleOption): Promise<number>;
/**
* Obtains a notification setting of the calling application.
*
* @returns { Promise<NotificationSetting> } Returns notificationsetting of this application.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @since 20
*/
function getNotificationSetting(): Promise<NotificationSetting>;
/**
* Add do not disturb notification templates.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<DoNotDisturbProfile> } templates - The array of Notification templates.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Add do not disturb notification templates.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<DoNotDisturbProfile> } templates - The array of Notification templates.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function addDoNotDisturbProfile(templates: Array<DoNotDisturbProfile>): Promise<void>;
/**
* Remove do not disturb notification templates.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<DoNotDisturbProfile> } templates - The array of Notification templates.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Remove do not disturb notification templates.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<DoNotDisturbProfile> } templates - The array of Notification templates.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function removeDoNotDisturbProfile(templates: Array<DoNotDisturbProfile>): Promise<void>;
/**
* Set system additional config information of notification
*
* @permission ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { string } key - addition config key.
* @param { string } value - addition config value.
* @returns { Promise<number> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 12
*/
/**
* Set system additional config information of notification
*
* @permission ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @param { string } key - addition config key.
* @param { string } value - addition config value.
* @returns { Promise<number> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setAdditionalConfig(key: string, value: string): Promise<number>;
/**
* Opens the notification settings page of the application, which is displayed in semi-modal mode and can be used to set
* the notification enabling and notification mode. This API uses a promise to return the result.
*
* @param { UIAbilityContext } context - Ability context bound to the notification settings page.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600018 - the notification settings window is already displayed.
* @syscap SystemCapability.Notification.NotificationSettings
* @stagemodelonly
* @since 13
*/
/**
* Opens the notification settings page of the application, which is displayed in semi-modal mode and can be used to set
* the notification enabling and notification mode. This API uses a promise to return the result.
*
* @param { UIAbilityContext } context - Ability context bound to the notification settings page.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600018 - the notification settings window is already displayed.
* @syscap SystemCapability.Notification.NotificationSettings
* @stagemodelonly
* @since 18
*/
function openNotificationSettings(context: UIAbilityContext): Promise<void>;
/**
* Get do not disturb profile by id.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } id - The id of profile.
* @returns { Promise<DoNotDisturbProfile> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600019 - The do-not-disturb profile does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 13
*/
/**
* Get do not disturb profile by id.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } id - The id of profile.
* @returns { Promise<DoNotDisturbProfile> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600019 - The do-not-disturb profile does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function getDoNotDisturbProfile(id: number): Promise<DoNotDisturbProfile>;
/**
* Disabling notifications based on the application list.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER or ohos.permission.MANAGE_EDM_POLICY
* @param { boolean } disabled - The switch of disableNotification.
* @param { Array<string> } bundleList - The bundles of disableNotification.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
/**
* Disabling notifications based on the application list.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER or ohos.permission.MANAGE_EDM_POLICY
* @param { boolean } disabled - The switch of disableNotification.
* @param { Array<string> } bundleList - The bundles of disableNotification.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts{ '1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
function disableNotificationFeature(disabled:boolean, bundleList: Array<string>): Promise<void>;
/**
* Disabling notifications based on the application list.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER or ohos.permission.MANAGE_EDM_POLICY
* @param { boolean } disabled - The switch of disableNotification.
* @param { Array<string> } bundleList - The bundles of disableNotification.
* @param { number } userId - the userId.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed.
* The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
*/
function disableNotificationFeature(disabled: boolean, bundleList: Array<string>, userId: number): Promise<void>;
/**
* Set target device status.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } deviceType - The device.
* @param { number } status - The device status.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setTargetDeviceStatus(deviceType: string, status: number): Promise<void>;
/**
* Set notification slot synchronization switch.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { SlotType } slot - The slot type.
* @param { string } deviceType - The device type.
* @param { boolean } enabled - The switch state.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function setDistributedEnabledBySlot(slot: SlotType, deviceType: string, enabled: boolean): Promise<void>;
/**
* Get notification slot synchronization switch.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { SlotType } slot - The slot type.
* @param { string } deviceType - The device type.
* @returns { Promise<boolean> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 18
*/
function isDistributedEnabledBySlot(slot: SlotType, deviceType: string): Promise<boolean>;
/**
* Obtains whether the device supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } deviceType - The device type.
* @returns { Promise<boolean> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
*/
function isDistributedEnabled(deviceType: string): Promise<boolean>;
/**
* Sets whether the device supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { boolean } enable - Set enable or not.
* @param { string } deviceType - The device type.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
*/
function setDistributedEnabled(enable: boolean, deviceType: string): Promise<void>;
/**
* Get distributed device list.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<Array<string>> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
*/
function getDistributedDeviceList(): Promise<Array<string>>;
/**
* Set the switch status of silent reminders.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { boolean } enabled - Set enable or not.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
function setSilentReminderEnabled(bundle: BundleOption, enabled: boolean): Promise<void>;
/**
* Obtains whether an application silent reminder is enable.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @returns { Promise<SwitchState> } Returns whether an application silent reminder is enable.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
function isSilentReminderEnabled(bundle: BundleOption): Promise<SwitchState>;
/**
* Represents the state of a switch,
* distinguishing system defaults from user modifications.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
export enum SwitchState {
/**
* User-modified OFF state,
* Represents an off state that was explicitly set by the user.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
USER_MODIFIED_OFF = 0,
/**
* User-modified ON state,
* Represents an on state that was explicitly set by the user.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
USER_MODIFIED_ON = 1,
/**
* System default OFF state,
* Represents the initial off state before any user modification.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
SYSTEM_DEFAULT_OFF = 2,
/**
* System default ON state,
* Represents the initial on state before any user modification.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
SYSTEM_DEFAULT_ON = 3,
}
/**
* Describes a button option for a triggering.
*
* @typedef ButtonOptions
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface ButtonOptions {
/**
* The button name for a triggering.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
buttonName: string;
}
/**
* Describes a subscriber for system live view.
*
* @typedef SystemLiveViewSubscriber
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface SystemLiveViewSubscriber {
/**
* The callback function that receives a new button option of a notification.
*
* @type { ?function }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
onResponse?: (notificationId: number, buttonOptions: ButtonOptions) => void;
}
/**
* Describes the parameters of check notifications.
*
* @typedef NotificationCheckInfo
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface NotificationCheckInfo {
/**
* The application bundle name for publishing notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
bundleName: string;
/**
* The notification id.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
notificationId: number;
/**
* Label of the notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { ?string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
label?: string;
/**
* The notification content type.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { ContentType }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
contentType: ContentType;
/**
* UserId of the notification creator.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
creatorUserId: number;
/**
* Type of the notification slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { SlotType }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
slotType: SlotType;
/**
* Additional information of the live view notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { ?Record<string, Object> }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
extraInfos?: Record<string, Object>;
}
/**
* Describes the result of check notifications.
*
* @typedef NotificationCheckResult
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface NotificationCheckResult {
/**
* The result code. 0-display, 1-no display
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
code: number;
/**
* The result message.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @type { string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
message: string;
}
/**
* Describes a NotificationSetting instance.
*
* @typedef NotificationSetting
* @syscap SystemCapability.Notification.Notification
* @since 20
* @arkts 1.1&1.2
*/
export interface NotificationSetting {
/**
* Indicates whether vibration is enabled.
*
* @type { boolean }
* @syscap SystemCapability.Notification.Notification
* @since 20
* @arkts 1.1&1.2
*/
vibrationEnabled: boolean;
/**
* Indicates whether sound is enabled.
*
* @type { boolean }
* @syscap SystemCapability.Notification.Notification
* @since 20
* @arkts 1.1&1.2
*/
soundEnabled: boolean;
}
/**
* Enumerates the notification slot types.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Enumerates the notification slot types.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export enum SlotType {
/**
* Unknown type. This type corresponds to SlotLevel being LEVEL_MIN.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Unknown type. This type corresponds to SlotLevel being LEVEL_MIN.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
UNKNOWN_TYPE = 0,
/**
* Notification slot for social communication. This type corresponds to SlotLevel being LEVEL_HIGH.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Notification slot for social communication. This type corresponds to SlotLevel being LEVEL_HIGH.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
SOCIAL_COMMUNICATION = 1,
/**
* Notification slot for service information. This type corresponds to SlotLevel being LEVEL_HIGH.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Notification slot for service information. This type corresponds to SlotLevel being LEVEL_HIGH.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
SERVICE_INFORMATION = 2,
/**
* Notification slot for content consultation. This type corresponds to SlotLevel being LEVEL_MIN.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Notification slot for content consultation. This type corresponds to SlotLevel being LEVEL_MIN.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
CONTENT_INFORMATION = 3,
/**
* Live view. A third-party application cannot directly create a notification of this slot type. After the system proxy creates a system live view,
* the third-party application releases a notification with the same ID to update the specified content.
* This type corresponds to SlotLevel being LEVEL_DEFAULT.
*
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Live view. A third-party application cannot directly create a notification of this slot type. After the system proxy creates a system live view,
* the third-party application releases a notification with the same ID to update the specified content.
* This type corresponds to SlotLevel being LEVEL_DEFAULT.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
LIVE_VIEW = 4,
/**
* Customer service message. This type is used for messages between users and customer service providers. The messages must be initiated by users.
* This type corresponds to SlotLevel being LEVEL_DEFAULT.
*
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Customer service message. This type is used for messages between users and customer service providers. The messages must be initiated by users.
* This type corresponds to SlotLevel being LEVEL_DEFAULT.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
CUSTOMER_SERVICE = 5,
/**
* NotificationSlot for emergency information.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
EMERGENCY_INFORMATION = 10,
/**
* Notification slot for other purposes. This type corresponds to SlotLevel being LEVEL_MIN.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Notification slot for other purposes. This type corresponds to SlotLevel being LEVEL_MIN.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
OTHER_TYPES = 0xFFFF
}
/**
* Enumerates the notification content types.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Enumerates the notification content types.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export enum ContentType {
/**
* Normal text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Normal text notification.
*
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_CONTENT_BASIC_TEXT,
/**
* Long text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Long text notification.
*
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_CONTENT_LONG_TEXT,
/**
* Picture-attached notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Picture-attached notification.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_CONTENT_PICTURE,
/**
* Conversation notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Conversation notification.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_CONTENT_CONVERSATION,
/**
* Multi-line text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Multi-line text notification.
*
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_CONTENT_MULTILINE,
/**
* Live view notification. A third-party application cannot directly create a notification of this type.
* After the system proxy creates a system live view, the third-party application releases a notification with the same ID to update the specified content.
*
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Live view notification. A third-party application cannot directly create a notification of this type.
* After the system proxy creates a system live view, the third-party application releases a notification with the same ID to update the specified content.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_CONTENT_SYSTEM_LIVE_VIEW,
/**
* Common live view notification. Only system applications are supported.
*
* @syscap SystemCapability.Notification.Notification
* @since 11
*/
/**
* Common live view notification. Only system applications are supported.
*
* @syscap SystemCapability.Notification.Notification
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_CONTENT_LIVE_VIEW,
}
/**
* Enumerates the notification level.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export enum SlotLevel {
/**
* Notification is disabled.
*
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
LEVEL_NONE = 0,
/**
* Notification is enabled, but the notification icon is not displayed in the status bar, with no banner and alert tone.
*
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
LEVEL_MIN = 1,
/**
* Notification is enabled, and the notification icon is displayed in the status bar, with no banner and alert tone.
*
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
LEVEL_LOW = 2,
/**
* Notification is enabled, and the notification icon is displayed in the status bar, with an alert tone but no banner.
*
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
LEVEL_DEFAULT = 3,
/**
* Notification is enabled, and the notification icon is displayed in the status bar, with an alert tone and banner.
*
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
LEVEL_HIGH = 4
}
/**
* The type of the Do Not Disturb.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export enum DoNotDisturbType {
/**
* Non do not disturb type notification
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
TYPE_NONE = 0,
/**
* Execute do not disturb once in the set time period (only watch hours and minutes)
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
TYPE_ONCE = 1,
/**
* Execute do not disturb every day with a set time period (only watch hours and minutes)
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
TYPE_DAILY = 2,
/**
* Execute in the set time period (specify the time, month, day and hour)
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
TYPE_CLEARLY = 3
}
/**
* Describes a DoNotDisturbDate instance.
*
* @typedef DoNotDisturbDate
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface DoNotDisturbDate {
/**
* the type of the Do Not Disturb.
*
* @type { DoNotDisturbType }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
type: DoNotDisturbType;
/**
* The start time of the Do Not Disturb.
*
* @type { Date }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
begin: Date;
/**
* The end time of the Do Not Disturb.
*
* @type { Date }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
end: Date;
}
/**
* Describes a DistributedBundleEnableInfo instance.
*
* @typedef DistributedBundleEnableInfo
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
export interface DistributedBundleEnableInfo {
/**
* The bundle name.
*
* @type { string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
bundleName: string;
/**
* The uid.
*
* @type { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
uid: number;
/**
* Indicates whether application is enabled.
*
* @type { ?boolean }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
enable?: boolean;
}
/**
* Describes a DoNotDisturbProfile instance.
*
* @typedef DoNotDisturbProfile
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface DoNotDisturbProfile {
/**
* The profile id of the Do Not disturb.
*
* @type { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
id: number;
/**
* The profile name of the Do Not disturb.
*
* @type { string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
name: string;
/**
* The trustlist of application.
*
* @type { ?Array<BundleOption> }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
trustlist?: Array<BundleOption>;
}
/**
* The remind type of the notification.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export enum DeviceRemindType {
/**
* The device is not in use, no reminder
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
IDLE_DONOT_REMIND = 0,
/**
* The device is not in use, remind
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
IDLE_REMIND = 1,
/**
* The device is in use, no reminder
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
ACTIVE_DONOT_REMIND = 2,
/**
* The device is in use, reminder
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
ACTIVE_REMIND = 3
}
/**
* Notification source type
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export enum SourceType {
/**
* General notification
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
TYPE_NORMAL = 0,
/**
* Continuous notification
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
TYPE_CONTINUOUS = 1,
/**
* Scheduled notification
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
TYPE_TIMER = 2
}
/**
* Enum for notification control flag status.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export enum NotificationControlFlagStatus {
/**
* Manipulating of the enumeration by bitwise-or operation represents the closing of ringtone.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_STATUS_CLOSE_SOUND = 1 << 0,
/**
* Manipulating of the enumeration by bitwise-or operation represents the closing of lock screen.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_STATUS_CLOSE_LOCKSCREEN = 1 << 1,
/**
* Manipulating of the enumeration by bitwise-or operation represents the closing of banner.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_STATUS_CLOSE_BANNER = 1 << 2,
/**
* Manipulating of the enumeration by bitwise-or operation represents the closing of light screen.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_STATUS_CLOSE_LIGHT_SCREEN = 1 << 3,
/**
* Manipulating of the enumeration by bitwise-or operation represents the closing of vibration.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_STATUS_CLOSE_VIBRATION = 1 << 4,
/**
* Manipulating of the enumeration by bitwise-or operation represents the closing of status bar icon.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
NOTIFICATION_STATUS_CLOSE_STATUSBAR_ICON = 1 << 5
}
/**
* Describes a bundleOption in a notification.
*
* @typedef { _BundleOption } BundleOption
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type BundleOption = _BundleOption;
/**
* Describes an action button displayed in a notification.
*
* @typedef { _NotificationActionButton } NotificationActionButton
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationActionButton = _NotificationActionButton;
/**
* Describes a normal text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
/**
* Describes a normal text notification.
*
* @typedef { _NotificationBasicContent } NotificationBasicContent
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationBasicContent = _NotificationBasicContent;
/**
* Describes notification types.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Describes notification types.
*
* @typedef { _NotificationContent } NotificationContent
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationContent = _NotificationContent;
/**
* Describes a long text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Describes a long text notification.
*
* @typedef { _NotificationLongTextContent } NotificationLongTextContent
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationLongTextContent = _NotificationLongTextContent;
/**
* Describes a live view notification.
*
* @typedef { _NotificationLiveViewContent } NotificationLiveViewContent
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationLiveViewContent = _NotificationLiveViewContent;
/**
* Describes a multi-line text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Describes a multi-line text notification.
*
* @typedef { _NotificationMultiLineContent } NotificationMultiLineContent
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationMultiLineContent = _NotificationMultiLineContent;
/**
* Describes a picture-attached notification.
*
* @typedef { _NotificationPictureContent } NotificationPictureContent
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationPictureContent = _NotificationPictureContent;
/**
* Describes a system live view notification.
*
* @typedef { _NotificationSystemLiveViewContent } NotificationSystemLiveViewContent
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationSystemLiveViewContent = _NotificationSystemLiveViewContent;
/**
* Describes a NotificationFlags instance.
*
* @typedef { _NotificationFlags } NotificationFlags
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationFlags = _NotificationFlags;
/**
* The status of the notification flag.
*
* @typedef { _NotificationFlagStatus } NotificationFlagStatus
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationFlagStatus = _NotificationFlagStatus;
/**
* Defines a NotificationRequest instance.
*
* @syscap SystemCapability.Notification.Notification
* @since 9
*/
/**
* Defines a NotificationRequest instance.
*
* @typedef { _NotificationRequest } NotificationRequest
* @syscap SystemCapability.Notification.Notification
* @crossplatform
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationRequest = _NotificationRequest;
/**
* Defines a UnifiedGroupInfo instance.
*
* @typedef { _UnifiedGroupInfo } UnifiedGroupInfo
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type UnifiedGroupInfo = _UnifiedGroupInfo;
/**
* Defines a NotificationFilter instance.
*
* @typedef { _NotificationFilter } NotificationFilter
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationFilter = _NotificationFilter;
/**
* Defines a NotificationCheckRequest instance.
*
* @typedef { _NotificationCheckRequest } NotificationCheckRequest
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationCheckRequest = _NotificationCheckRequest;
/**
* Describes distributed options.
*
* @typedef { _DistributedOptions } DistributedOptions
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type DistributedOptions = _DistributedOptions;
/**
* Describes a NotificationSlot instance.
*
* @typedef { _NotificationSlot } NotificationSlot
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationSlot = _NotificationSlot;
/**
* Describes live view notification option type.
*
* @typedef { _LiveViewStatus } LiveViewStatus
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type LiveViewStatus = _LiveViewStatus;
/**
* Describes live view notification task type.
*
* @typedef { _LiveViewTypes } LiveViewTypes
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type LiveViewTypes = _LiveViewTypes;
/**
* Provides sorting information about an active notification.
*
* @typedef { _NotificationSorting } NotificationSorting
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationSorting = _NotificationSorting;
/**
* Describes a NotificationTemplate instance.
*
* @typedef { _NotificationTemplate } NotificationTemplate
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationTemplate = _NotificationTemplate;
/**
* Describes a NotificationUserInput instance.
*
* @typedef { _NotificationUserInput } NotificationUserInput
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationUserInput = _NotificationUserInput;
/**
* Describes a system live view capsule type.
*
* @typedef { _NotificationCapsule } NotificationCapsule
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationCapsule = _NotificationCapsule;
/**
* Describes a system live view button type.
*
* @typedef { _NotificationButton } NotificationButton
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationButton = _NotificationButton;
/**
* Describes a system live view time type.
*
* @typedef { _NotificationTime } NotificationTime
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationTime = _NotificationTime;
/**
* Describes a system live view progress type.
*
* @typedef { _NotificationProgress } NotificationProgress
* @syscap SystemCapability.Notification.Notification
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationProgress = _NotificationProgress;
}
export default notificationManager;
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

搜索帮助