1 Star 0 Fork 3.9K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.contact.d.ts 130.87 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497
/*
* Copyright (C) 2021-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* 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 ContactsKit
*/
import { AsyncCallback } from './@ohos.base';
import type Context from './application/BaseContext';
/**
* Contains variety of system contact, provides functions for adding, updating and deleting these system contact
* and provides methods for querying the information of contact.
*
* @namespace contact
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Contains variety of system contact, provides functions for adding, updating and deleting these system contact
* and provides methods for querying the information of contact.
*
* @namespace contact
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
declare namespace contact {
/**
* Creates a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Contact } contact - Indicates the contact information.
* @param { AsyncCallback<number> } callback - Returns the contact ID (which can be obtained
* by {@link Contact#getId()}) if the creation is successful. returns {@link Contact#INVALID_CONTACT_ID} if the
* creation fails.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.addContact#addContact
*/
function addContact(contact: Contact, callback: AsyncCallback<number>): void;
/**
* Creates a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Contact } contact - Indicates the contact information.
* @param { AsyncCallback<number> } callback - Returns the contact ID (which can be obtained
* by {@link Contact#getId()}) if the creation is successful. returns {@link Contact#INVALID_CONTACT_ID} if the
* creation fails.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
/**
* Creates a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Contact } contact - Indicates the contact information.
* @param { AsyncCallback<number> } callback - Returns the contact ID (which can be obtained
* by {@link Contact#getId()}) if the creation is successful. returns {@link Contact#INVALID_CONTACT_ID} if the
* creation fails.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 12
*/
function addContact(context: Context, contact: Contact, callback: AsyncCallback<number>): void;
/**
* Creates a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Contact } contact - Indicates the contact information.
* @returns { Promise<number> } Returns the contact ID (which can be obtained by {@link Contact#getId()}) if the
* creation is successful. returns {@link Contact#INVALID_CONTACT_ID} if the creation fails.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.addContact#addContact
*/
function addContact(contact: Contact): Promise<number>;
/**
* Creates a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Contact } contact - Indicates the contact information.
* @returns { Promise<number> } Returns the contact ID (which can be obtained by {@link Contact#getId()}) if the
* creation is successful. returns {@link Contact#INVALID_CONTACT_ID} if the creation fails.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
/**
* Creates a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Contact } contact - Indicates the contact information.
* @returns { Promise<number> } Returns the contact ID (which can be obtained by {@link Contact#getId()}) if the
* creation is successful. returns {@link Contact#INVALID_CONTACT_ID} if the creation fails.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 12
*/
function addContact(context: Context, contact: Contact): Promise<number>;
/**
* Select contact.
*
* @permission ohos.permission.READ_CONTACTS
* @param { AsyncCallback<Array<Contact>> } callback - Indicates the callback for getting the result of the call.
* Returns the contact list which user select; returns empty contact list if user not select.
* @syscap SystemCapability.Applications.Contacts
* @since 7
* @deprecated since 10
* @useinstead contact.selectContact#selectContacts
*/
function selectContact(callback: AsyncCallback<Array<Contact>>): void;
/**
* Select contact.
*
* @param { AsyncCallback<Array<Contact>> } callback - Indicates the callback for getting the result of the call.
* Returns the contact list which user select; returns empty contact list if user not select.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.Contacts
* @since 10
*/
/**
* Select contact.
*
* @param { AsyncCallback<Array<Contact>> } callback - Indicates the callback for getting the result of the call.
* Returns the contact list which user select; returns empty contact list if user not select.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.Contacts
* @atomicservice
* @since 11
*/
function selectContacts(callback: AsyncCallback<Array<Contact>>): void;
/**
* Select contact.
*
* @permission ohos.permission.READ_CONTACTS
* @returns { Promise<Array<Contact>> } Returns the contact list which user select;
* returns empty contact list if user not select.
* @syscap SystemCapability.Applications.Contacts
* @since 7
* @deprecated since 10
* @useinstead contact.selectContact#selectContacts
*/
function selectContact(): Promise<Array<Contact>>;
/**
* Select contact.
*
* @returns { Promise<Array<Contact>> } Returns the contact list which user select;
* returns empty contact list if user not select.
* @syscap SystemCapability.Applications.Contacts
* @since 10
*/
/**
* Select contact.
*
* @returns { Promise<Array<Contact>> } Returns the contact list which user select;
* returns empty contact list if user not select.
* @syscap SystemCapability.Applications.Contacts
* @atomicservice
* @since 11
*/
function selectContacts(): Promise<Array<Contact>>;
/**
* Select contact with option.
*
* @param { ContactSelectionOptions } options - Indicates the Single-select or multiple-select.
* @param { AsyncCallback<Array<Contact>> } callback - Indicates the callback for getting the result of the call.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.Contacts
* @since 10
*/
/**
* Select contact with option.
*
* @param { ContactSelectionOptions } options - Indicates the Single-select or multiple-select.
* @param { AsyncCallback<Array<Contact>> } callback - Indicates the callback for getting the result of the call.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.Contacts
* @atomicservice
* @since 11
*/
function selectContacts(options: ContactSelectionOptions, callback: AsyncCallback<Array<Contact>>): void;
/**
* Select contact with option.
*
* @param { ContactSelectionOptions } options - Indicates the Single-select or multiple-select.
* @returns { Promise<Array<Contact>> } Returns the contact list which user select;
* returns empty contact list if user not select.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.Contacts
* @since 10
*/
/**
* Select contact with option.
*
* @param { ContactSelectionOptions } options - Indicates the Single-select or multiple-select.
* @returns { Promise<Array<Contact>> } Returns the contact list which user select;
* returns empty contact list if user not select.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.Contacts
* @atomicservice
* @since 11
*/
function selectContacts(options: ContactSelectionOptions): Promise<Array<Contact>>;
/**
* Deletes a specified contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { string } key - Indicates the unique query key of a contact to delete.
* @param { AsyncCallback<void> } callback - Return the callback function.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.deleteContact#deleteContact
*/
function deleteContact(key: string, callback: AsyncCallback<void>): void;
/**
* Deletes a specified contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } key - Indicates the unique query key of a contact to delete.
* @param { AsyncCallback<void> } callback - Return the callback function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function deleteContact(context: Context, key: string, callback: AsyncCallback<void>): void;
/**
* Deletes a specified contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { string } key - Indicates the unique query key of a contact to delete.
* @returns { Promise<void> } The promise returned by the function.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.deleteContact#deleteContact
*/
function deleteContact(key: string): Promise<void>;
/**
* Deletes a specified contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } key - Indicates the unique query key of a contact to delete.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function deleteContact(context: Context, key: string): Promise<void>;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } key - Indicates the unique query key of a contact.
* @param { AsyncCallback<Contact> } callback - Returns the specified contact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContact#queryContact
*/
function queryContact(key: string, callback: AsyncCallback<Contact>): void;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } key - Indicates the unique query key of a contact.
* @param { AsyncCallback<Contact> } callback - Returns the specified contact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContact(context: Context, key: string, callback: AsyncCallback<Contact>): void;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } key - Indicates the unique query key of a contact.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Contact> } callback - Returns the specified contact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContact#queryContact
*/
function queryContact(key: string, holder: Holder, callback: AsyncCallback<Contact>): void;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } key - Indicates the unique query key of a contact.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Contact> } callback - Returns the specified contact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContact(context: Context, key: string, holder: Holder, callback: AsyncCallback<Contact>): void;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } key - Indicates the unique query key of a contact.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Contact> } callback - Returns the specified contact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContact#queryContact
*/
function queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } key - Indicates the unique query key of a contact.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Contact> } callback - Returns the specified contact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContact(context: Context, key: string, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } key - Indicates the unique query key of a contact.
* @param { Holder } holder - Indicates the contact holder.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Contact> } callback - Returns the specified contact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContact#queryContact
*/
function queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } key - Indicates the unique query key of a contact.
* @param { Holder } holder - Indicates the contact holder.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Contact> } callback - Returns the specified contact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContact(context: Context, key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } key - Indicates the unique query key of a contact.
* @param { Holder } holder - Indicates the contact holder.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<Contact> } Returns the specified contact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContact#queryContact
*/
function queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise<Contact>;
/**
* Queries a specified contact of specified attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } key - Indicates the unique query key of a contact.
* @param { Holder } holder - Indicates the contact holder.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<Contact> } Returns the specified contact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContact(context: Context, key: string, holder?: Holder, attrs?: ContactAttributes): Promise<Contact>;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContacts#queryContacts
*/
function queryContacts(callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContacts(context: Context, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContacts#queryContacts
*/
function queryContacts(holder: Holder, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContacts(context: Context, holder: Holder, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContacts#queryContacts
*/
function queryContacts(attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContacts(context: Context, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContacts#queryContacts
*/
function queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContacts(context: Context, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<Array<Contact>> } Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContacts#queryContacts
*/
function queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>;
/**
* Queries contacts with query conditions.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<Array<Contact>> } Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContacts(context: Context, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>;
/**
* Queries contacts by a specified email address.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } email - Indicates the email address.
* @param { AsyncCallback<Array<Contact>> } callback - Returns a {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByEmail#queryContactsByEmail
*/
function queryContactsByEmail(email: string, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a specified email address.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } email - Indicates the email address.
* @param { AsyncCallback<Array<Contact>> } callback - Returns a {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByEmail(context: Context, email: string, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a specified email address and contact holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } email - Indicates the email address.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns a {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByEmail#queryContactsByEmail
*/
function queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a specified email address and contact holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } email - Indicates the email address.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns a {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByEmail(context: Context, email: string, holder: Holder,
callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a specified email address and contact attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } email - Indicates the email address.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns a {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByEmail#queryContactsByEmail
*/
function queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a specified email address and contact attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } email - Indicates the email address.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns a {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByEmail(context: Context, email: string, attrs: ContactAttributes,
callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a specified email address, contact holder, and contact attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } email - Indicates the email address.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns a {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByEmail#queryContactsByEmail
*/
function queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a specified email address, contact holder, and contact attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } email - Indicates the email address.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns a {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByEmail(context: Context, email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a specified email address, contact holder, and contact attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } email - Indicates the email address.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<Array<Contact>> } Returns a {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByEmail#queryContactsByEmail
*/
function queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>;
/**
* Queries contacts by a specified email address, contact holder, and contact attributes.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } email - Indicates the email address.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attributes.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<Array<Contact>> } Returns a {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByEmail(context: Context, email: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>;
/**
* Queries contacts by a phone number.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByPhoneNumber#queryContactsByPhoneNumber
*/
function queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a phone number.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByPhoneNumber(context: Context, phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a phone number and contact holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByPhoneNumber#queryContactsByPhoneNumber
*/
function queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a phone number and contact holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a phone number and contact attribute.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes will be used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByPhoneNumber#queryContactsByPhoneNumber
*/
function queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a phone number and contact attribute.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes will be used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByPhoneNumber(context: Context, phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a phone number, contact holder and contact attribute.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes will be used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByPhoneNumber#queryContactsByPhoneNumber
*/
function queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a phone number, contact holder and contact attribute.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes will be used for matching.
* @param { AsyncCallback<Array<Contact>> } callback - Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, attrs: ContactAttributes,
callback: AsyncCallback<Array<Contact>>): void;
/**
* Queries contacts by a phone number, contact holder and contact attribute.
*
* @permission ohos.permission.READ_CONTACTS
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes will be used for matching.
* @returns { Promise<Array<Contact>> } Returns the {@code Contact} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryContactsByPhoneNumber#queryContactsByPhoneNumber
*/
function queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>;
/**
* Queries contacts by a phone number, contact holder and contact attribute.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { string } phoneNumber - Indicates the phone number.
* Only full match is supported, and wildcards are not supported.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes will be used for matching.
* @returns { Promise<Array<Contact>> } Returns the {@code Contact} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>;
/**
* Queries contact groups.
*
* @permission ohos.permission.READ_CONTACTS
* @param { AsyncCallback<Array<Group>> } callback - Returns the contact group list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryGroups#queryGroups
*/
function queryGroups(callback: AsyncCallback<Array<Group>>): void;
/**
* Queries contact groups.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { AsyncCallback<Array<Group>> } callback - Returns the contact group list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryGroups(context: Context, callback: AsyncCallback<Array<Group>>): void;
/**
* Queries contact groups by contact holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Array<Group>> } callback - Returns the contact group list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryGroups#queryGroups
*/
function queryGroups(holder: Holder, callback: AsyncCallback<Array<Group>>): void;
/**
* Queries contact groups by contact holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<Array<Group>> } callback - Returns the contact group list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryGroups(context: Context, holder: Holder, callback: AsyncCallback<Array<Group>>): void;
/**
* Queries contact groups by contact holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @returns { Promise<Array<Group>> } Returns the contact group list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryGroups#queryGroups
*/
function queryGroups(holder?: Holder): Promise<Array<Group>>;
/**
* Queries contact groups by contact holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @returns { Promise<Array<Group>> } Returns the contact group list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryGroups(context: Context, holder?: Holder): Promise<Array<Group>>;
/**
* Queries contact holders.
*
* @permission ohos.permission.READ_CONTACTS
* @param { AsyncCallback<Array<Holder>> } callback - Returns the {@code Holder} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryHolders#queryHolders
*/
function queryHolders(callback: AsyncCallback<Array<Holder>>): void;
/**
* Queries contact holders.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { AsyncCallback<Array<Holder>> } callback - Returns the {@code Holder} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryHolders(context: Context, callback: AsyncCallback<Array<Holder>>): void;
/**
* Queries contact holders.
*
* @permission ohos.permission.READ_CONTACTS
* @returns { Promise<Array<Holder>> } Returns the {@code Holder} list object.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryHolders#queryHolders
*/
function queryHolders(): Promise<Array<Holder>>;
/**
* Queries contact holders.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @returns { Promise<Array<Holder>> } Returns the {@code Holder} list object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryHolders(context: Context): Promise<Array<Holder>>;
/**
* Obtains the query key of a contact based on a specified ID.
*
* @permission ohos.permission.READ_CONTACTS
* @param { number } id - Indicates the contact ID.
* @param { AsyncCallback<string> } callback - Returns the query key of the contact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryKey#queryKey
*/
function queryKey(id: number, callback: AsyncCallback<string>): void;
/**
* Obtains the query key of a contact based on a specified ID.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { number } id - Indicates the contact ID.
* @param { AsyncCallback<string> } callback - Returns the query key of the contact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryKey(context: Context, id: number, callback: AsyncCallback<string>): void;
/**
* Obtains the query key of a contact based on a specified ID and holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { number } id - Indicates the contact ID.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<string> } callback - Returns the query key of the contact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryKey#queryKey
*/
function queryKey(id: number, holder: Holder, callback: AsyncCallback<string>): void;
/**
* Obtains the query key of a contact based on a specified ID and holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { number } id - Indicates the contact ID.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @param { AsyncCallback<string> } callback - Returns the query key of the contact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryKey(context: Context, id: number, holder: Holder, callback: AsyncCallback<string>): void;
/**
* Obtains the query key of a contact based on a specified ID and holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { number } id - Indicates the contact ID.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @returns { Promise<string> } Returns the query key of the contact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryKey#queryKey
*/
function queryKey(id: number, holder?: Holder): Promise<string>;
/**
* Obtains the query key of a contact based on a specified ID and holder.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { number } id - Indicates the contact ID.
* @param { Holder } holder - Indicates the contact holder.
* If this parameter is null, the default holder is used for matching.
* @returns { Promise<string> } Returns the query key of the contact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryKey(context: Context, id: number, holder?: Holder): Promise<string>;
/**
* Queries information about "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { AsyncCallback<Contact> } callback - Returns information about "my card".
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryMyCard#queryMyCard
*/
function queryMyCard(callback: AsyncCallback<Contact>): void;
/**
* Queries information about "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { AsyncCallback<Contact> } callback - Returns information about "my card".
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryMyCard(context: Context, callback: AsyncCallback<Contact>): void;
/**
* Queries information about "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Contact> } callback - Returns information about "my card".
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryMyCard#queryMyCard
*/
function queryMyCard(attrs: ContactAttributes, callback: AsyncCallback<Contact>): void;
/**
* Queries information about "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<Contact> } callback - Returns information about "my card".
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryMyCard(context: Context, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void;
/**
* Queries information about "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<Contact> } Returns information about "my card".
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.queryMyCard#queryMyCard
*/
function queryMyCard(attrs?: ContactAttributes): Promise<Contact>;
/**
* Queries information about "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<Contact> } Returns information about "my card".
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function queryMyCard(context: Context, attrs?: ContactAttributes): Promise<Contact>;
/**
* Updates specified attributes of a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Contact } contact - Indicates the contact whose information is to update.
* @param { AsyncCallback<void> } callback - The callback of updateContact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.updateContact#updateContact
*/
function updateContact(contact: Contact, callback: AsyncCallback<void>): void;
/**
* Updates specified attributes of a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Contact } contact - Indicates the contact whose information is to update.
* @param { AsyncCallback<void> } callback - The callback of updateContact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function updateContact(context: Context, contact: Contact, callback: AsyncCallback<void>): void;
/**
* Updates specified attributes of a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Contact } contact - Indicates the contact whose information is to update.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<void> } callback - The callback of updateContact.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.updateContact#updateContact
*/
function updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback<void>): void;
/**
* Updates specified attributes of a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Contact } contact - Indicates the contact whose information is to update.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes are used for matching.
* @param { AsyncCallback<void> } callback - The callback of updateContact.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function updateContact(context: Context, contact: Contact, attrs: ContactAttributes, callback: AsyncCallback<void>): void;
/**
* Updates specified attributes of a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Contact } contact - Indicates the contact whose information is to update.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<void> } The promise returned by the function.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.updateContact#updateContact
*/
function updateContact(contact: Contact, attrs?: ContactAttributes): Promise<void>;
/**
* Updates specified attributes of a contact.
*
* @permission ohos.permission.WRITE_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { Contact } contact - Indicates the contact whose information is to update.
* @param { ContactAttributes } attrs - Indicates the contact attribute.
* If this parameter is null, all attributes are used for matching.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function updateContact(context: Context, contact: Contact, attrs?: ContactAttributes): Promise<void>;
/**
* Checks whether the contact ID is in the local phone book.
*
* @permission ohos.permission.READ_CONTACTS
* @param { number } id - Indicates the contact ID.
* @param { AsyncCallback<boolean> } callback - The callback of isLocalContact.
* Returns {@code true} if the contact ID is in the local phone book; returns {@code false} otherwise.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.isLocalContact#isLocalContact
*/
function isLocalContact(id: number, callback: AsyncCallback<boolean>): void;
/**
* Checks whether the contact ID is in the local phone book.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { number } id - Indicates the contact ID.
* @param { AsyncCallback<boolean> } callback - The callback of isLocalContact.
* Returns {@code true} if the contact ID is in the local phone book; returns {@code false} otherwise.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function isLocalContact(context: Context, id: number, callback: AsyncCallback<boolean>): void;
/**
* Checks whether the contact ID is in the local phone book.
*
* @permission ohos.permission.READ_CONTACTS
* @param { number } id - Indicates the contact ID.
* @returns { Promise<boolean> } Returns {@code true} if the contact ID is in the local phone book,
* returns {@code false} otherwise.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.isLocalContact#isLocalContact
*/
function isLocalContact(id: number): Promise<boolean>;
/**
* Checks whether the contact ID is in the local phone book.
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { number } id - Indicates the contact ID.
* @returns { Promise<boolean> } Returns {@code true} if the contact ID is in the local phone book,
* returns {@code false} otherwise.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function isLocalContact(context: Context, id: number): Promise<boolean>;
/**
* Checks whether the contact ID is of "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { number } id - Indicates the contact ID.
* @param { AsyncCallback<boolean> } callback - The callback of isMyCard.
* Returns {@code true} if the contact ID is of "my card"; returns {@code false} otherwise.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.deleteContact#deleteContact
*/
function isMyCard(id: number, callback: AsyncCallback<boolean>): void;
/**
* Checks whether the contact ID is of "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { number } id - Indicates the contact ID.
* @param { AsyncCallback<boolean> } callback - The callback of isMyCard.
* Returns {@code true} if the contact ID is of "my card"; returns {@code false} otherwise.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function isMyCard(context: Context, id: number, callback: AsyncCallback<boolean>): void;
/**
* Checks whether the contact ID is of "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { number } id - Indicates the contact ID.
* @returns { Promise<boolean> } Returns true if the contact ID is of "my card", returns false otherwise.
* @syscap SystemCapability.Applications.ContactsData
* @since 7
* @deprecated since 10
* @useinstead contact.isMyCard#isMyCard
*/
function isMyCard(id: number): Promise<boolean>;
/**
* Checks whether the contact ID is of "my card".
*
* @permission ohos.permission.READ_CONTACTS
* @param { Context } context - Indicates the context of application or capability.
* @param { number } id - Indicates the contact ID.
* @returns { Promise<boolean> } Returns true if the contact ID is of "my card", returns false otherwise.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
* @syscap SystemCapability.Applications.ContactsData
* @since 10
*/
function isMyCard(context: Context, id: number): Promise<boolean>;
/**
* ContactSelectionOptions Object
*
* @interface ContactSelectionOptions
* @syscap SystemCapability.Applications.Contacts
* @since 10
*/
/**
* ContactSelectionOptions Object
*
* @interface ContactSelectionOptions
* @syscap SystemCapability.Applications.Contacts
* @atomicservice
* @since 11
*/
interface ContactSelectionOptions {
/**
* Indicates the Single-select or multiple-select.
*
* @type { ?boolean }
* @syscap SystemCapability.Applications.Contacts
* @since 10
*/
/**
* Indicates the Single-select or multiple-select.
*
* @type { ?boolean }
* @syscap SystemCapability.Applications.Contacts
* @atomicservice
* @since 11
*/
isMultiSelect?: boolean;
}
/**
* Provides methods for contact information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for contact information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Contact {
/**
* Indicates the contact invalid ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact invalid ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly INVALID_CONTACT_ID: -1
/**
* Indicates the contact ID.
*
* @type { ?number }
* @readonly
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact ID.
*
* @type { ?number }
* @readonly
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
readonly id?: number
/**
* Indicates the query key that identifies the contact.
*
* @type { ?string }
* @readonly
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the query key that identifies the contact.
*
* @type { ?string }
* @readonly
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
readonly key?: string
/**
* Indicates the contact attributes.
*
* @type { ?ContactAttributes }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact attributes.
*
* @type { ?ContactAttributes }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
contactAttributes?: ContactAttributes
/**
* Indicates list of contact email addresses.
*
* @type { ?Email[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates list of contact email addresses.
*
* @type { ?Email[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
emails?: Email[]
/**
* Indicates an event (special date) of the contact.
*
* @type { ?Event[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an event (special date) of the contact.
*
* @type { ?Event[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
events?: Event[]
/**
* Indicates a group of the contact.
*
* @type { ?Group[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a group of the contact.
*
* @type { ?Group[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
groups?: Group[]
/**
* Indicates an IM address of the contact.
*
* @type { ?ImAddress[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an IM address of the contact.
*
* @type { ?ImAddress[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
imAddresses?: ImAddress[]
/**
* Indicates a phone number of the contact.
*
* @type { ?PhoneNumber[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a phone number of the contact.
*
* @type { ?PhoneNumber[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
phoneNumbers?: PhoneNumber[]
/**
* Indicates the contact portrait.
*
* @type { ?Portrait }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact portrait.
*
* @type { ?Portrait }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
portrait?: Portrait
/**
* Indicates a postal address of the contact.
*
* @type { ?PostalAddress[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a postal address of the contact.
*
* @type { ?PostalAddress[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
postalAddresses?: PostalAddress[]
/**
* Indicates a relation of the contact.
*
* @type { ?Relation[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a relation of the contact.
*
* @type { ?Relation[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
relations?: Relation[]
/**
* Indicates a Session Initiation Protocol (SIP) address of the contact.
*
* @type { ?SipAddress[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a Session Initiation Protocol (SIP) address of the contact.
*
* @type { ?SipAddress[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
sipAddresses?: SipAddress[]
/**
* Indicates a website of the contact.
*
* @type { ?Website[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a website of the contact.
*
* @type { ?Website[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
websites?: Website[]
/**
* Indicates the contact name.
*
* @type { ?Name }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact name.
*
* @type { ?Name }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
name?: Name
/**
* Indicates the contact nickname.
*
* @type { ?NickName }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact nickname.
*
* @type { ?NickName }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
nickName?: NickName
/**
* Indicates the contact note.
*
* @type { ?Note }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact note.
*
* @type { ?Note }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
note?: Note
/**
* Indicates organization information about the contact.
*
* @type { ?Organization }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates organization information about the contact.
*
* @type { ?Organization }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
organization?: Organization
}
/**
* Provides methods for contact attributes information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for contact attributes information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class ContactAttributes {
/**
* Indicates the contact attributes.
*
* @type { Attribute[] }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact attributes.
*
* @type { Attribute[] }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
attributes: Attribute[]
}
/**
* Provides methods for attribute information
*
* @enum { number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for attribute information
*
* @enum { number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
enum Attribute {
/**
* Indicates the contact event.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact event.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_CONTACT_EVENT,
/**
* Indicates the email address.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the email address.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_EMAIL,
/**
* Indicates the contact group.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact group.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_GROUP_MEMBERSHIP,
/**
* Indicates the instant messaging (IM) address.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the instant messaging (IM) address.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_IM,
/**
* Indicates the name.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the name.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_NAME,
/**
* Indicates the nickname.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the nickname.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_NICKNAME,
/**
* Indicates the note.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the note.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_NOTE,
/**
* Indicates the organization.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the organization.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_ORGANIZATION,
/**
* Indicates the phone number.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the phone number.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_PHONE,
/**
* Indicates the portrait.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the portrait.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_PORTRAIT,
/**
* Indicates the postal address.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the postal address.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_POSTAL_ADDRESS,
/**
* Indicates the relation.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the relation.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_RELATION,
/**
* Indicates the Session Initiation Protocol (SIP) address.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the Session Initiation Protocol (SIP) address.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_SIP_ADDRESS,
/**
* Indicates the website.
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the website.
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
ATTR_WEBSITE
}
/**
* Provides methods for email information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for email information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Email {
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly CUSTOM_LABEL: 0
/**
* Indicates a home email.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a home email.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly EMAIL_HOME: 1
/**
* Indicates a work email.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a work email.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly EMAIL_WORK: 2
/**
* Indicates an email of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an email of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly EMAIL_OTHER: 3
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly INVALID_LABEL_ID: -1
/**
* Indicates the email address.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the email address.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
email: string
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelName?: string
/**
* Indicates the displayed email name.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the displayed email name.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
displayName?: string
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelId?: number
}
/**
* Provides methods for event information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for event information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Event {
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly CUSTOM_LABEL: 0
/**
* Indicates an anniversary event.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an anniversary event.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly EVENT_ANNIVERSARY: 1
/**
* Indicates an event of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an event of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly EVENT_OTHER: 2
/**
* Indicates an birthday event.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an birthday event.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly EVENT_BIRTHDAY: 3
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly INVALID_LABEL_ID: -1
/**
* Indicates the event date.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the event date.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
eventDate: string
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelName?: string
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelId?: number
}
/**
* Provides methods for group information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for group information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Group {
/**
* Indicates the contact group ID.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact group ID.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
groupId?: number
/**
* Indicates the contact group title.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the contact group title.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
title: string
}
/**
* Provides methods for holder information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
class Holder {
/**
* Indicates the bundle name of a contact holder.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
readonly bundleName: string
/**
* Indicates the displayed name of a contact holder.
*
* @type { ?string }
* @readonly
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
readonly displayName?: string
/**
* Indicates the holder ID.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
holderId?: number
}
/**
* Provides methods for ImAddress information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for ImAddress information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class ImAddress {
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly CUSTOM_LABEL: -1
/**
* Indicates an AIM instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an AIM instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly IM_AIM: 0
/**
* Indicates a Windows Live instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a Windows Live instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly IM_MSN: 1
/**
* Indicates a Yahoo instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a Yahoo instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly IM_YAHOO: 2
/**
* Indicates a Skype instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a Skype instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly IM_SKYPE: 3
/**
* Indicates a QQ instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a QQ instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly IM_QQ: 4
/**
* Indicates an ICQ instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an ICQ instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly IM_ICQ: 6
/**
* Indicates a Jabber instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a Jabber instant message.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly IM_JABBER: 7
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly INVALID_LABEL_ID: -2
/**
* Indicates the IM address.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the IM address.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
imAddress: string
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelName?: string
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelId?: number
}
/**
* Provides methods for name information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for name information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Name {
/**
* Indicates the family name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the family name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
familyName?: string
/**
* Indicates the phonetic family name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the phonetic family name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
familyNamePhonetic?: string
/**
* Indicates the full name of the contact.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the full name of the contact.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
fullName: string
/**
* Indicates the given name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the given name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
givenName?: string
/**
* Indicates the phonetic given name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the phonetic given name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
givenNamePhonetic?: string
/**
* Indicates the middle name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the middle name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
middleName?: string
/**
* Indicates the phonetic middle name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the phonetic middle name of the contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
middleNamePhonetic?: string
/**
* Indicates the prefix of the contact name.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the prefix of the contact name.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
namePrefix?: string
/**
* Indicates the suffix of this contact name.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the suffix of this contact name.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
nameSuffix?: string
}
/**
* Provides methods for nick name information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for nick name information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class NickName {
/**
* Indicates the nickname of the contact.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the nickname of the contact.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
nickName: string
}
/**
* Provides methods for note information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for note information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Note {
/**
* Indicates the note content.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the note content.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
noteContent: string
}
/**
* Provides methods for organization information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for organization information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Organization {
/**
* Indicates the name of the organization to which the contact belongs.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the name of the organization to which the contact belongs.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
name: string
/**
* Indicates the title of the organization.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the title of the organization.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
title?: string
}
/**
* Provides methods for phone number information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for phone number information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class PhoneNumber {
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly CUSTOM_LABEL: 0
/**
* Indicates a home number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a home number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_HOME: 1
/**
* Indicates a mobile phone number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a mobile phone number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_MOBILE: 2
/**
* Indicates a work number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a work number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_WORK: 3
/**
* Indicates a work fax number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a work fax number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_FAX_WORK: 4
/**
* Indicates a home fax number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a home fax number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_FAX_HOME: 5
/**
* Indicates a pager number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a pager number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_PAGER: 6
/**
* Indicates a number of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a number of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_OTHER: 7
/**
* Indicates a callback number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a callback number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_CALLBACK: 8
/**
* Indicates a car number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a car number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_CAR: 9
/**
* Indicates a company director number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a company director number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_COMPANY_MAIN: 10
/**
* Indicates an Integrated Services Digital Network (ISDN) number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an Integrated Services Digital Network (ISDN) number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_ISDN: 11
/**
* Indicates a main number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a main number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_MAIN: 12
/**
* Indicates a number of the OTHER_FAX type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a number of the OTHER_FAX type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_OTHER_FAX: 13
/**
* Indicates a radio number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a radio number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_RADIO: 14
/**
* Indicates a telex number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a telex number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_TELEX: 15
/**
* Indicates a teletypewriter (TTY) or test-driven development (TDD) number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a teletypewriter (TTY) or test-driven development (TDD) number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_TTY_TDD: 16
/**
* Indicates a work mobile phone number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a work mobile phone number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_WORK_MOBILE: 17
/**
* Indicates a work pager number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a work pager number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_WORK_PAGER: 18
/**
* Indicates an assistant number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an assistant number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_ASSISTANT: 19
/**
* Indicates an MMS number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an MMS number.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly NUM_MMS: 20
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly INVALID_LABEL_ID: -1
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelName?: string
/**
* Indicates the phone number of the contact.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the phone number of the contact.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
phoneNumber: string
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelId?: number
}
/**
* Provides methods for portrait information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for portrait information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Portrait {
/**
* Indicates the uri of the contact portrait.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the uri of the contact portrait.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
uri: string
}
/**
* Provides methods for postal address information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for postal address information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class PostalAddress {
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly CUSTOM_LABEL: 0
/**
* Indicates a home address.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a home address.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly ADDR_HOME: 1
/**
* Indicates a work address.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a work address.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly ADDR_WORK: 2
/**
* Indicates an address of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an address of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly ADDR_OTHER: 3
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly INVALID_LABEL_ID: -1
/**
* Indicates the city where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the city where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
city?: string
/**
* Indicates the country/region where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the country/region where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
country?: string
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelName?: string
/**
* Indicates the neighborhood where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the neighborhood where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
neighborhood?: string
/**
* Indicates the post box of this contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the post box of this contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
pobox?: string
/**
* Indicates the postal address of this contact.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the postal address of this contact.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
postalAddress: string
/**
* Indicates the postal code of this contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the postal code of this contact.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
postcode?: string
/**
* Indicates the area where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the area where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
region?: string
/**
* Indicates the street where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the street where this contact is located.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
street?: string
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelId?: number
}
/**
* Provides methods for relation information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for relation information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Relation {
/**
* Indicates custom relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates custom relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly CUSTOM_LABEL: 0
/**
* Indicates assistant relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates assistant relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_ASSISTANT: 1
/**
* Indicates brother relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates brother relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_BROTHER: 2
/**
* Indicates child relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates child relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_CHILD: 3
/**
* Indicates domestic partner relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates domestic partner relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_DOMESTIC_PARTNER: 4
/**
* Indicates father relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates father relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_FATHER: 5
/**
* Indicates friend relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates friend relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_FRIEND: 6
/**
* Indicates manager relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates manager relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_MANAGER: 7
/**
* Indicates mother relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates mother relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_MOTHER: 8
/**
* Indicates parent relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates parent relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_PARENT: 9
/**
* Indicates partner relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates partner relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_PARTNER: 10
/**
* Indicates referrer relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates referrer relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_REFERRED_BY: 11
/**
* Indicates relative relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates relative relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_RELATIVE: 12
/**
* Indicates sister relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates sister relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_SISTER: 13
/**
* Indicates spouse relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates spouse relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly RELATION_SPOUSE: 14
/**
* Indicates invalid relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates invalid relationship type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly INVALID_LABEL_ID: -1
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelName?: string
/**
* Indicates the relation name.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the relation name.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
relationName: string
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelId?: number
}
/**
* Provides methods for sip address information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for sip address information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class SipAddress {
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a custom label.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly CUSTOM_LABEL: 0
/**
* Indicates a home SIP address.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a home SIP address.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly SIP_HOME: 1
/**
* Indicates a work SIP address.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates a work SIP address.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly SIP_WORK: 2
/**
* Indicates an SIP address of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an SIP address of the OTHER type.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly SIP_OTHER: 3
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates an invalid label ID.
*
* @type { number }
* @readonly
* @static
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
static readonly INVALID_LABEL_ID: -1
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label name of an attribute.
*
* @type { ?string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelName?: string
/**
* Indicates the SIP address.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the SIP address.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
sipAddress: string
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the label id.
*
* @type { ?number }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
labelId?: number
}
/**
* Provides methods for website information
*
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Provides methods for website information
*
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
class Website {
/**
* Indicates the website.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @since 7
*/
/**
* Indicates the website.
*
* @type { string }
* @syscap SystemCapability.Applications.ContactsData
* @atomicservice
* @since 11
*/
website: string
}
}
export default contact;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助