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

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.xml.d.ts 44.86 KB
一键复制 编辑 原始数据 按行查看 历史
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559
/*
* Copyright (c) 2021 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 ArkTS
*/
/**
* The xml module provides utilities for converting XML text to Javascript object, XML generation and parsing.
*
* @namespace xml
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The xml module provides utilities for converting XML text to Javascript object, XML generation and parsing.
*
* @namespace xml
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The xml module provides utilities for converting XML text to Javascript object, XML generation and parsing.
*
* @namespace xml
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace xml {
/**
* The XmlDynamicSerializer interface is used to dynamically generate an xml file.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
* @name XmlDynamicSerializer
*/
class XmlDynamicSerializer {
/**
* A parameterized constructor used to create a new XmlDynamicSerializer instance.
* The input parameter is an encoding format of string type.
*
* @param { string } [encoding] - [encoding='utf8'] this is its encoding, only support utf-8.
* @throws { BusinessError } 10200066 - Incorrect encoding format, only support utf-8.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
constructor(encoding?: string);
/**
* Write an attribute to xml element.
*
* @param { string } name - Key name of the attribute. Cannot be an empty string.
* @param { string } value - Values of attribute.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200063 - Illegal position for xml.
* @throws { BusinessError } 10200064 - Cannot be an empty string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
setAttributes(name: string, value: string): void;
/**
* Add an empty element.
*
* @param { string } name - Name of the element.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200064 - Cannot be an empty string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
addEmptyElement(name: string): void;
/**
* Writes xml declaration with encoding. For example: <?xml version="1.0" encoding="utf-8"?>.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200063 - Illegal position for xml.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
setDeclaration(): void;
/**
* Writes a element start tag with the given name.
*
* @param { string } name - Name of the element.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200064 - Cannot be an empty string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
startElement(name: string): void;
/**
* Writes end tag of the element.
*
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200065 - There is no match between the startElement and the endElement.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
endElement(): void;
/**
* Writes the namespace of the current element tag.
*
* @param { string } prefix - Values name of the prefix. Cannot be an empty string.
* @param { string } namespace - Values of namespace. Cannot be an empty string.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200064 - Cannot be an empty string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
setNamespace(prefix: string, namespace: string): void;
/**
* Writes the comment to xml.
*
* @param { string } text - Values of comment. Cannot be an empty string.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200064 - Cannot be an empty string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
setComment(text: string): void;
/**
* Writes the CDATA.
*
* @param { string } text - Values of CDATA. Cannot be an empty string.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200064 - Cannot be an empty string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
setCdata(text: string): void;
/**
* Writes the text to xml element.
*
* @param { string } text - Values of text. Cannot be an empty string.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200064 - Cannot be an empty string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
setText(text: string): void;
/**
* Writes the DOCTYPE.
*
* @param { string } text - Values of docType. Cannot be an empty string.
* @throws { BusinessError } 10200062 - The cumulative length of xml has exceeded the upper limit 100000.
* @throws { BusinessError } 10200064 - Cannot be an empty string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
setDocType(text: string): void;
/**
* Get an ArrayBuffer from a XmlDynamicSerializer instance.
*
* @returns { ArrayBuffer } - Returns ArrayBuffer result from a XmlDynamicSerializer instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'20', '1.2':'20'}
* @arkts 1.1&1.2
*/
getOutput(): ArrayBuffer;
}
/**
* The XmlSerializer interface is used to generate an xml file.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
* @name XmlSerializer
*/
/**
* The XmlSerializer interface is used to generate an xml file.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
* @name XmlSerializer
*/
/**
* The XmlSerializer interface is used to generate an xml file.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
* @name XmlSerializer
*/
class XmlSerializer {
/**
* A parameterized constructor used to create a new XmlSerializer instance.
* As the input parameter of the constructor function, init supports three types.
* The input parameter is an Arrarybuffer.
* The input parameter is a DataView.
* The input parameter is an encoding format of string type.
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* A parameterized constructor used to create a new XmlSerializer instance.
* As the input parameter of the constructor function, init supports three types.
* The input parameter is an Arrarybuffer.
* The input parameter is a DataView.
* The input parameter is an encoding format of string type.
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A constructor used to create an XmlSerializer instance.
*
* @param { ArrayBuffer | DataView } buffer - ArrayBuffer or DataView for storing the XML information to set.
* @param { string } [encoding] - Encoding format. The default value is 'utf-8' (the only format currently supported).
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
constructor(buffer: ArrayBuffer | DataView, encoding?: string);
/**
* Write an attribute.
*
* @param { string } name - Key name of the attribute.
* @param { string } value - Values of attribute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Write an attribute.
*
* @param { string } name - Key name of the attribute.
* @param { string } value - Values of attribute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sets an attribute.
*
* @param { string } name - Key of the attribute.
* @param { string } value - Value of the attribute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types; 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
setAttributes(name: string, value: string): void;
/**
* Add an empty element.
*
* @param { string } name - Key name of the attribute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Add an empty element.
*
* @param { string } name - Key name of the attribute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Adds an empty element.
*
* @param { string } name - Name of the empty element to add.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
addEmptyElement(name: string): void;
/**
* Writes xml declaration with encoding. For example: <?xml version="1.0" encoding="utf-8"?>.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Writes xml declaration with encoding. For example: <?xml version="1.0" encoding="utf-8"?>.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sets a file declaration with encoding.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
setDeclaration(): void;
/**
* Writes a element start tag with the given name.
*
* @param { string } name - Name of the element.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Writes a element start tag with the given name.
*
* @param { string } name - Name of the element.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes the start tag based on the given element name.
*
* @param { string } name - Name of the element.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
startElement(name: string): void;
/**
* Writes end tag of the element.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Writes end tag of the element.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Writes the end tag of the element.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
endElement(): void;
/**
* Writes the namespace of the current element tag.
*
* @param { string } prefix - Values name of the prefix.
* @param { string } namespace - Values of namespace.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Writes the namespace of the current element tag.
*
* @param { string } prefix - Values name of the prefix.
* @param { string } namespace - Values of namespace.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sets the namespace for an element tag.
*
* @param { string } prefix - Prefix of the element and its child elements.
* @param { string } namespace - Namespace to set.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
setNamespace(prefix: string, namespace: string): void;
/**
* Writes the comment.
*
* @param { string } text - Values of comment.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Writes the comment.
*
* @param { string } text - Values of comment.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sets a comment.
*
* @param { string } text - Comment to set.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
setComment(text: string): void;
/**
* Writes the CDATA.
*
* @param { string } text - Values of CDATA.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Writes the CDATA.
*
* @param { string } text - Values of CDATA.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Adds data to the CDATA tag. The structure of the generated CDATA tag is "<! <![CDATA["+ Data added + "]]>".
*
* @param { string } text - CDATA data to set.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
setCDATA(text: string): void;
/**
* Writes the text.
*
* @param { string } text - Values of text.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Writes the text.
*
* @param { string } text - Values of text.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sets a tag value.
*
* @param { string } text - Tag value to set, which is the content of the text attribute.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
setText(text: string): void;
/**
* Writes the DOCTYPE.
*
* @param { string } text - Values of docType.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Writes the DOCTYPE.
*
* @param { string } text - Values of docType.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sets a document type.
*
* @param { string } text - Content of DocType to set.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
setDocType(text: string): void;
}
/**
* The event types represented by XML elements.
*
* @enum { number }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The event types represented by XML elements.
*
* @enum { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The event types represented by XML elements.
*
* @enum { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
enum EventType {
/**
* Start a document.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Start a document.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Start a document.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
START_DOCUMENT,
/**
* End a document.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* End a document.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* End a document.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
END_DOCUMENT,
/**
* Start a tag.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Start a tag.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Start a tag.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
START_TAG,
/**
* End a tag.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* End a tag.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* End a tag.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
END_TAG,
/**
* Character data.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Character data.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Character data.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
TEXT,
/**
* A CDATA sections.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* A CDATA sections.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A CDATA sections.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
CDSECT,
/**
* An XML comment.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* An XML comment.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* An XML comment.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
COMMENT,
/**
* An XML document type declaration.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* An XML document type declaration.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* An XML document type declaration.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
DOCDECL,
/**
* An XML processing instruction declaration.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* An XML processing instruction declaration.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* An XML processing instruction declaration.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
INSTRUCTION,
/**
* An entity reference.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* An entity reference.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* An entity reference.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
ENTITY_REFERENCE,
/**
* A whitespace.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* A whitespace.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A whitespace.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
WHITESPACE
}
/**
* The current parse info.
*
* @typedef ParseInfo
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The current parse info.
*
* @typedef ParseInfo
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The current parse info.
*
* @typedef ParseInfo
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
interface ParseInfo {
/**
* The current column number, starting from 1.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The current column number, starting from 1.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the current column number, starting from 1.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getColumnNumber(): number;
/**
* The current depth of the element.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The current depth of the element.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the depth of this element.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getDepth(): number;
/**
* The current line number, starting from 1.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The current line number, starting from 1.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the current line number, starting from 1.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getLineNumber(): number;
/**
* The current element's name.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The current element's name.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the name of this element.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getName(): string;
/**
* The current element's namespace.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The current element's namespace.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the namespace of this element.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getNamespace(): string;
/**
* The current element's prefix.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The current element's prefix.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the prefix of this element.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getPrefix(): string;
/**
* The text content of the current event as String.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The text content of the current event as String.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the text of the current event.
*
* @returns { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getText(): string;
/**
* Returns true if the current element is empty.
*
* @returns { boolean }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Returns true if the current element is empty.
*
* @returns { boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether the current element is empty.
*
* @returns { boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
isEmptyElementTag(): boolean;
/**
* Checks whether the current TEXT event contains only whitespace characters.
*
* @returns { boolean }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Checks whether the current TEXT event contains only whitespace characters.
*
* @returns { boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether the current event contains only whitespace characters.
*
* @returns { boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
isWhitespace(): boolean;
/**
* Returns the number of attributes of the current start tag.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Returns the number of attributes of the current start tag.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the number of attributes for the current start tag.
*
* @returns { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
getAttributeCount(): number;
}
/**
* Parse options for XmlPullParser.
*
* @typedef ParseOptions
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Parse options for XmlPullParser.
*
* @typedef ParseOptions
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Parse options for XmlPullParser.
*
* @typedef ParseOptions
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
interface ParseOptions {
/**
* Whether to parsing Doctype of the elements.
*
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Whether to parsing Doctype of the elements.
*
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Whether to parsing Doctype of the elements.
*
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
supportDoctype?: boolean;
/**
* Whether to ignore parsing texts of the elements.
*
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Whether to ignore parsing texts of the elements.
*
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Whether to ignore parsing texts of the elements.
*
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
ignoreNameSpace?: boolean;
/**
* Tag value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Tag value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Tag value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
tagValueCallbackFunction?: (name: string, value: string) => boolean;
/**
* Attribute value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Attribute value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Attribute value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
attributeValueCallbackFunction?: (name: string, value: string) => boolean;
/**
* Token value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Token value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Token value callback function.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
tokenValueCallbackFunction?: (eventType: EventType, value: ParseInfo) => boolean;
/**
* Attribute value and tag callback function.
*
* @type { ?AttributeWithTagCb }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
*/
attributeWithTagCallbackFunction?: AttributeWithTagCb;
}
/**
* The type of ParseOptions attributeWithTagCallbackFunction.
*
* @typedef { function } AttributeWithTagCb
* @param { string } tagName - The tag in xml parse node
* @param { string } key - The key in xml parse node
* @param { string } value - The value in xml parse node
* @returns { boolean } - whether continue to parse xml data
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 20
*/
type AttributeWithTagCb = (tagName: string, key: string, value: string) => boolean;
/**
* The XmlPullParser interface is used to parse the existing xml file.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
* @name XmlPullParser
*/
/**
* The XmlPullParser interface is used to parse the existing xml file.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
* @name XmlPullParser
*/
/**
* The XmlPullParser interface is used to parse the existing xml file.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
* @name XmlPullParser
*/
class XmlPullParser {
/**
* A constructor used to create a new XmlPullParser instance.
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* A constructor used to create a new XmlPullParser instance.
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates and returns an XmlPullParser object.
*
* @param { ArrayBuffer | DataView } buffer - A instance, the new XmlPullParser with.
* @param { string } [encoding] - [encoding='utf8'] this is its encoding.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
constructor(buffer: ArrayBuffer | DataView, encoding?: string);
/**
* Starts parsing the XML file.
*
* @param { ParseOptions } option - Parse options for XmlPullParser, the interface including
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Starts parsing the XML file.
*
* @param { ParseOptions } option - Parse options for XmlPullParser, the interface including
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Starts parsing the XML file.
*
* @param { ParseOptions } option - Parse options for XmlPullParser, the interface including
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Starts parsing the XML file.
*
* @param { ParseOptions } option - Parse options for XmlPullParser, the interface including
* two Boolean variables and three callback functions.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 14
* @useinstead ohos.xml.XmlPullParser.parseXml
*/
parse(option: ParseOptions): void;
/**
* Parses XML information.
*
* @param { ParseOptions } option - XML parsing options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'14', '1.2':'20'}
* @arkts 1.1&1.2
*/
parseXml(option: ParseOptions): void;
}
}
export default xml;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助