提交 e20ba630 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 9f5c3ed7
...@@ -10,10 +10,6 @@ ...@@ -10,10 +10,6 @@
import Url from '@ohos.url' import Url from '@ohos.url'
``` ```
## 系统能力
SystemCapability.Utils.Lang
## URLSearchParams ## URLSearchParams
...@@ -23,6 +19,8 @@ constructor(init?: string[][] | Record&lt;string, string&gt; | string | URLSearc ...@@ -23,6 +19,8 @@ constructor(init?: string[][] | Record&lt;string, string&gt; | string | URLSearc
URLSearchParams的构造函数。 URLSearchParams的构造函数。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -32,11 +30,11 @@ URLSearchParams的构造函数。 ...@@ -32,11 +30,11 @@ URLSearchParams的构造函数。
**示例:** **示例:**
```js ```js
var objectParams = new URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]); var objectParams = new Url.URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]);
var objectParams1 = new URLSearchParams({"fod" : 1 , "bard" : 2}); var objectParams1 = new Url.URLSearchParams({"fod" : 1 , "bard" : 2});
var objectParams2 = new URLSearchParams('?fod=1&bard=2'); var objectParams2 = new Url.URLSearchParams('?fod=1&bard=2');
var urlObject = new URL('https://developer.mozilla.org/?fod=1&bard=2'); var urlObject = new Url.URL('https://developer.mozilla.org/?fod=1&bard=2');
var params = new URLSearchParams(urlObject.search); var params = new Url.URLSearchParams(urlObject.search);
``` ```
...@@ -46,6 +44,8 @@ append(name: string, value: string): void ...@@ -46,6 +44,8 @@ append(name: string, value: string): void
将新的键值对插入到查询字符串。 将新的键值对插入到查询字符串。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -56,8 +56,8 @@ append(name: string, value: string): void ...@@ -56,8 +56,8 @@ append(name: string, value: string): void
**示例:** **示例:**
```js ```js
let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2'); let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new URLSearchParams(urlObject.search.slice(1)); let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsObject.append('fod', 3); paramsObject.append('fod', 3);
``` ```
...@@ -68,6 +68,8 @@ delete(name: string): void ...@@ -68,6 +68,8 @@ delete(name: string): void
删除指定名称的键值对。 删除指定名称的键值对。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -77,8 +79,8 @@ delete(name: string): void ...@@ -77,8 +79,8 @@ delete(name: string): void
**示例:** **示例:**
```js ```js
let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2'); let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsobject = new URLSearchParams(urlObject.search.slice(1)); let paramsobject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsobject.delete('fod'); paramsobject.delete('fod');
``` ```
...@@ -89,6 +91,8 @@ getAll(name: string): string[] ...@@ -89,6 +91,8 @@ getAll(name: string): string[]
获取指定名称的所有键值对。 获取指定名称的所有键值对。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -104,8 +108,8 @@ getAll(name: string): string[] ...@@ -104,8 +108,8 @@ getAll(name: string): string[]
**示例:** **示例:**
```js ```js
let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2'); let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new URLSearchParams(urlObject.search.slice(1)); let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsObject.append('fod', 3); // Add a second value for the fod parameter. paramsObject.append('fod', 3); // Add a second value for the fod parameter.
console.log(params.getAll('fod')) // Output ["1","3"]. console.log(params.getAll('fod')) // Output ["1","3"].
``` ```
...@@ -117,6 +121,8 @@ entries(): IterableIterator<[string, string]> ...@@ -117,6 +121,8 @@ entries(): IterableIterator<[string, string]>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。 返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -126,7 +132,7 @@ entries(): IterableIterator<[string, string]> ...@@ -126,7 +132,7 @@ entries(): IterableIterator<[string, string]>
**示例:** **示例:**
```js ```js
var searchParamsObject = new URLSearchParams("keyName1=valueName1&keyName2=valueName2"); var searchParamsObject = new Url.URLSearchParams("keyName1=valueName1&keyName2=valueName2");
for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pairs for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pairs
console.log(pair[0]+ ', '+ pair[1]); console.log(pair[0]+ ', '+ pair[1]);
} }
...@@ -139,6 +145,8 @@ forEach(callbackfn: (value: string, key: string, searchParams: this) => void, th ...@@ -139,6 +145,8 @@ forEach(callbackfn: (value: string, key: string, searchParams: this) => void, th
通过回调函数来遍历URLSearchParams实例对象上的键值对。 通过回调函数来遍历URLSearchParams实例对象上的键值对。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -157,7 +165,7 @@ forEach(callbackfn: (value: string, key: string, searchParams: this) => void, th ...@@ -157,7 +165,7 @@ forEach(callbackfn: (value: string, key: string, searchParams: this) => void, th
**示例:** **示例:**
```js ```js
const myURLObject = new URL('https://developer.exampleUrl/?fod=1&bard=2'); const myURLObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
myURLObject.searchParams.forEach((value, name, searchParams) => { myURLObject.searchParams.forEach((value, name, searchParams) => {
console.log(name, value, myURLObject.searchParams === searchParams); console.log(name, value, myURLObject.searchParams === searchParams);
}); });
...@@ -170,6 +178,8 @@ get(name: string): string | null ...@@ -170,6 +178,8 @@ get(name: string): string | null
获取指定名称对应的第一个值。 获取指定名称对应的第一个值。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -186,7 +196,7 @@ get(name: string): string | null ...@@ -186,7 +196,7 @@ get(name: string): string | null
**示例:** **示例:**
```js ```js
var paramsOject = new URLSearchParams(document.location.search.substring(1)); var paramsOject = new Url.URLSearchParams(document.location.search.substring(1));
var name = paramsOject.get("name"); // is the string "Jonathan" var name = paramsOject.get("name"); // is the string "Jonathan"
var age = parseInt(paramsOject.get("age"), 10); // is the number 18 var age = parseInt(paramsOject.get("age"), 10); // is the number 18
var address = paramsOject.get("address"); // null var address = paramsOject.get("address"); // null
...@@ -199,6 +209,8 @@ has(name: string): boolean ...@@ -199,6 +209,8 @@ has(name: string): boolean
判断一个指定的键名对应的值是否存在。 判断一个指定的键名对应的值是否存在。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -214,8 +226,8 @@ has(name: string): boolean ...@@ -214,8 +226,8 @@ has(name: string): boolean
**示例:** **示例:**
```js ```js
let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2'); let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new URLSearchParams(urlObject.search.slice(1)); let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsObject.has('bard') === true; paramsObject.has('bard') === true;
``` ```
...@@ -226,6 +238,8 @@ set(name: string, value: string): void ...@@ -226,6 +238,8 @@ set(name: string, value: string): void
将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。 将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -236,8 +250,8 @@ set(name: string, value: string): void ...@@ -236,8 +250,8 @@ set(name: string, value: string): void
**示例:** **示例:**
```js ```js
let urlObject = new URL('https://developer.exampleUrl/?fod=1&bard=2'); let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new URLSearchParams(urlObject.search.slice(1)); let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsObject.set('baz', 3); // Add a third parameter. paramsObject.set('baz', 3); // Add a third parameter.
``` ```
...@@ -246,13 +260,14 @@ paramsObject.set('baz', 3); // Add a third parameter. ...@@ -246,13 +260,14 @@ paramsObject.set('baz', 3); // Add a third parameter.
sort(): void sort(): void
对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。 对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。
**系统能力:** SystemCapability.Utils.Lang
**示例:** **示例:**
```js ```js
var searchParamsObject = new URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object var searchParamsObject = new Url.URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object
searchParamsObject.sort(); // Sort the key/value pairs searchParamsObject.sort(); // Sort the key/value pairs
console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=2&c=3&d=4 console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=2&c=3&d=4
``` ```
...@@ -262,9 +277,10 @@ console.log(searchParamsObject.toString()); // Display the sorted query string / ...@@ -262,9 +277,10 @@ console.log(searchParamsObject.toString()); // Display the sorted query string /
keys(): IterableIterator&lt;string&gt; keys(): IterableIterator&lt;string&gt;
返回一个所有键值对的name的ES6迭代器。 返回一个所有键值对的name的ES6迭代器。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -274,7 +290,7 @@ keys(): IterableIterator&lt;string&gt; ...@@ -274,7 +290,7 @@ keys(): IterableIterator&lt;string&gt;
**示例:** **示例:**
```js ```js
var searchParamsObject = new URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing var searchParamsObject = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
for (var key of searchParamsObject .keys()) { // Output key-value pairs for (var key of searchParamsObject .keys()) { // Output key-value pairs
console.log(key); console.log(key);
} }
...@@ -287,6 +303,8 @@ values(): IterableIterator&lt;string&gt; ...@@ -287,6 +303,8 @@ values(): IterableIterator&lt;string&gt;
返回一个所有键值对的value的ES6迭代器。 返回一个所有键值对的value的ES6迭代器。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -296,7 +314,7 @@ values(): IterableIterator&lt;string&gt; ...@@ -296,7 +314,7 @@ values(): IterableIterator&lt;string&gt;
**示例:** **示例:**
```js ```js
var searchParams = new URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing var searchParams = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
for (var value of searchParams.values()) { for (var value of searchParams.values()) {
console.log(value); console.log(value);
} }
...@@ -307,9 +325,10 @@ for (var value of searchParams.values()) { ...@@ -307,9 +325,10 @@ for (var value of searchParams.values()) {
[Symbol.iterator]\(): IterableIterator&lt;[string, string]&gt; [Symbol.iterator]\(): IterableIterator&lt;[string, string]&gt;
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。 返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -319,7 +338,7 @@ for (var value of searchParams.values()) { ...@@ -319,7 +338,7 @@ for (var value of searchParams.values()) {
**示例:** **示例:**
```js ```js
const paramsObject = new URLSearchParams('fod=bay&edg=bap'); const paramsObject = new Url.URLSearchParams('fod=bay&edg=bap');
for (const [name, value] of paramsObject) { for (const [name, value] of paramsObject) {
console.log(name, value); console.log(name, value);
} }
...@@ -330,9 +349,10 @@ for (const [name, value] of paramsObject) { ...@@ -330,9 +349,10 @@ for (const [name, value] of paramsObject) {
toString(): string toString(): string
返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。 返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -342,8 +362,8 @@ toString(): string ...@@ -342,8 +362,8 @@ toString(): string
**示例:** **示例:**
```js ```js
let url = new URL('https://developer.exampleUrl/?fod=1&bard=2'); let url = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new URLSearchParams(url.search.slice(1)); let params = new Url.URLSearchParams(url.search.slice(1));
params.append('fod', 3); params.append('fod', 3);
console.log(params.toString()); console.log(params.toString());
``` ```
...@@ -351,9 +371,10 @@ console.log(params.toString()); ...@@ -351,9 +371,10 @@ console.log(params.toString());
## URL ## URL
### 属性 ### 属性
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| hash | string | 是 | 是 | 获取和设置URL的片段部分。 | | hash | string | 是 | 是 | 获取和设置URL的片段部分。 |
...@@ -374,9 +395,10 @@ console.log(params.toString()); ...@@ -374,9 +395,10 @@ console.log(params.toString());
constructor(url: string, base?: string | URL) constructor(url: string, base?: string | URL)
URL的构造函数。 URL的构造函数。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -388,17 +410,17 @@ URL的构造函数。 ...@@ -388,17 +410,17 @@ URL的构造函数。
```js ```js
var mm = 'http://username:password@host:8080'; var mm = 'http://username:password@host:8080';
var a = new URL("/", mm); // Output 'http://username:password@host:8080/'; var a = new Url.URL("/", mm); // Output 'http://username:password@host:8080/';
var b = new URL(mm); // Output 'http://username:password@host:8080/'; var b = new Url.URL(mm); // Output 'http://username:password@host:8080/';
new URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1'; new Url.URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1';
var c = new URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1'; var c = new Url.URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1';
new URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1'; new Url.URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1';
new URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1'; new Url.URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1';
new URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1 new Url.URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1
new URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL new Url.URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL
new URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL new Url.URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL
new URL('http://www.shanxi.com', ); // Output http://www.shanxi.com/ new Url.URL('http://www.shanxi.com', ); // Output http://www.shanxi.com/
new URL('http://www.shanxi.com', b); // Output http://www.shanxi.com/ new Url.URL('http://www.shanxi.com', b); // Output http://www.shanxi.com/
``` ```
...@@ -408,6 +430,8 @@ toString(): string ...@@ -408,6 +430,8 @@ toString(): string
将解析过后的URL转化为字符串。 将解析过后的URL转化为字符串。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -417,7 +441,7 @@ toString(): string ...@@ -417,7 +441,7 @@ toString(): string
**示例:** **示例:**
```js ```js
const url = new URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
url.toString() url.toString()
``` ```
...@@ -426,9 +450,10 @@ url.toString() ...@@ -426,9 +450,10 @@ url.toString()
toJSON(): string toJSON(): string
将解析过后的URL转化为JSON字符串。 将解析过后的URL转化为JSON字符串。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -437,6 +462,6 @@ toJSON(): string ...@@ -437,6 +462,6 @@ toJSON(): string
**示例:** **示例:**
```js ```js
const url = new URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
url.toJSON() url.toJSON()
``` ```
...@@ -208,9 +208,6 @@ decode(input: Uint8Array, options?: { stream?: false }): string ...@@ -208,9 +208,6 @@ decode(input: Uint8Array, options?: { stream?: false }): string
result[4] = 0x62; result[4] = 0x62;
result[5] = 0x63; result[5] = 0x63;
console.log("input num:"); console.log("input num:");
for(var j= 0; j < 6; j++) {
console.log(result[j]);
}
var retStr = textDecoder.decode( result , {stream: false}); var retStr = textDecoder.decode( result , {stream: false});
console.log("retStr = " + retStr); console.log("retStr = " + retStr);
``` ```
...@@ -262,6 +259,7 @@ encode(input?: string): Uint8Array ...@@ -262,6 +259,7 @@ encode(input?: string): Uint8Array
**示例:** **示例:**
```js ```js
var textEncoder = new util.TextEncoder(); var textEncoder = new util.TextEncoder();
var buffer = new ArrayBuffer(20);
var result = new Uint8Array(buffer); var result = new Uint8Array(buffer);
result = textEncoder.encode("\uD800¥¥"); result = textEncoder.encode("\uD800¥¥");
``` ```
......
...@@ -10,10 +10,6 @@ ...@@ -10,10 +10,6 @@
import xml from '@ohos.xml'; import xml from '@ohos.xml';
``` ```
## 系统能力
SystemCapability.Utils.Lang
## XmlSerializer ## XmlSerializer
...@@ -23,6 +19,8 @@ constructor(buffer: ArrayBuffer | DataView, encoding?: string) ...@@ -23,6 +19,8 @@ constructor(buffer: ArrayBuffer | DataView, encoding?: string)
XmlSerializer的构造函数。 XmlSerializer的构造函数。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -45,6 +43,8 @@ setAttributes(name: string, value: string): void ...@@ -45,6 +43,8 @@ setAttributes(name: string, value: string): void
设置Attributes方法。 设置Attributes方法。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -55,6 +55,8 @@ setAttributes(name: string, value: string): void ...@@ -55,6 +55,8 @@ setAttributes(name: string, value: string): void
**示例:** **示例:**
```js ```js
var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView); var thatSer = new xml.XmlSerializer(bufView);
thatSer.setAttributes("importance", "high"); thatSer.setAttributes("importance", "high");
``` ```
...@@ -66,6 +68,8 @@ addEmptyElement(name: string): void ...@@ -66,6 +68,8 @@ addEmptyElement(name: string): void
写入一个空元素。 写入一个空元素。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -75,6 +79,8 @@ addEmptyElement(name: string): void ...@@ -75,6 +79,8 @@ addEmptyElement(name: string): void
**示例:** **示例:**
```js ```js
var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView); var thatSer = new xml.XmlSerializer(bufView);
thatSer.addEmptyElement("b"); // => <b/> thatSer.addEmptyElement("b"); // => <b/>
``` ```
...@@ -86,9 +92,13 @@ setDeclaration(): void ...@@ -86,9 +92,13 @@ setDeclaration(): void
设置Declaration方法。 设置Declaration方法。
**系统能力:** SystemCapability.Utils.Lang
**示例:** **示例:**
```js ```js
var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView); var thatSer = new xml.XmlSerializer(bufView);
thatSer.setDeclaration() // => <?xml version="1.0" encoding="utf-8"?>; thatSer.setDeclaration() // => <?xml version="1.0" encoding="utf-8"?>;
``` ```
...@@ -100,6 +110,8 @@ startElement(name: string): void ...@@ -100,6 +110,8 @@ startElement(name: string): void
根据给定名称写入元素开始标记。 根据给定名称写入元素开始标记。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -122,9 +134,13 @@ endElement(): void ...@@ -122,9 +134,13 @@ endElement(): void
写入元素结束标记。 写入元素结束标记。
**系统能力:** SystemCapability.Utils.Lang
**示例:** **示例:**
```js ```js
var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView); var thatSer = new xml.XmlSerializer(bufView);
thatSer.setNamespace("h", "http://www.w3.org/TR/html4/"); thatSer.setNamespace("h", "http://www.w3.org/TR/html4/");
thatSer.startElement("table"); thatSer.startElement("table");
...@@ -140,6 +156,8 @@ setNamespace(prefix: string, namespace: string): void ...@@ -140,6 +156,8 @@ setNamespace(prefix: string, namespace: string): void
写入当前元素标记的命名空间。 写入当前元素标记的命名空间。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -164,6 +182,8 @@ setComment(text: string): void ...@@ -164,6 +182,8 @@ setComment(text: string): void
写入comment属性。 写入comment属性。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -187,6 +207,8 @@ setCDATA(text: string): void ...@@ -187,6 +207,8 @@ setCDATA(text: string): void
写入CDATA属性。 写入CDATA属性。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -208,6 +230,8 @@ setText(text: string): void ...@@ -208,6 +230,8 @@ setText(text: string): void
设置Text方法。 设置Text方法。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -232,6 +256,8 @@ setDocType(text: string): void ...@@ -232,6 +256,8 @@ setDocType(text: string): void
写入DocType属性。 写入DocType属性。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -256,6 +282,8 @@ constructor(buffer: ArrayBuffer | DataView, encoding?: string) ...@@ -256,6 +282,8 @@ constructor(buffer: ArrayBuffer | DataView, encoding?: string)
创建并返回一个XmlPullParser对象,该XmlPullParser对象传参两个, 第一参数是ArrayBuffer或DataView类型的一段内存,第二个参数为文件格式(默认为UTF-8) 创建并返回一个XmlPullParser对象,该XmlPullParser对象传参两个, 第一参数是ArrayBuffer或DataView类型的一段内存,第二个参数为文件格式(默认为UTF-8)
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -289,6 +317,8 @@ parse(option: ParseOptions): void ...@@ -289,6 +317,8 @@ parse(option: ParseOptions): void
该接口用于解析xml。 该接口用于解析xml。
**系统能力:** SystemCapability.Utils.Lang
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -329,6 +359,8 @@ that.parse(options); ...@@ -329,6 +359,8 @@ that.parse(options);
xml解析选项。 xml解析选项。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -349,6 +381,8 @@ getColumnNumber(): number ...@@ -349,6 +381,8 @@ getColumnNumber(): number
获取当前列号,从1开始。 获取当前列号,从1开始。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -362,6 +396,8 @@ getDepth(): number ...@@ -362,6 +396,8 @@ getDepth(): number
获取元素的当前深度。 获取元素的当前深度。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -375,6 +411,8 @@ getLineNumber(): number ...@@ -375,6 +411,8 @@ getLineNumber(): number
获取当前行号,从1开始。 获取当前行号,从1开始。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -388,6 +426,8 @@ getName(): string ...@@ -388,6 +426,8 @@ getName(): string
获取当前元素名称。 获取当前元素名称。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -401,6 +441,8 @@ getNamespace(): string ...@@ -401,6 +441,8 @@ getNamespace(): string
获取当前元素的命名空间。 获取当前元素的命名空间。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -414,6 +456,8 @@ getPrefix(): string ...@@ -414,6 +456,8 @@ getPrefix(): string
获取当前元素前缀。 获取当前元素前缀。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -427,6 +471,8 @@ getText(): string ...@@ -427,6 +471,8 @@ getText(): string
获取当前事件的文本内容。 获取当前事件的文本内容。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -440,6 +486,8 @@ isEmptyElementTag(): boolean ...@@ -440,6 +486,8 @@ isEmptyElementTag(): boolean
判断当前元素是否为空元素。 判断当前元素是否为空元素。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -453,6 +501,8 @@ isWhitespace(): boolean ...@@ -453,6 +501,8 @@ isWhitespace(): boolean
判断当前文本事件是否仅包含空格字符。 判断当前文本事件是否仅包含空格字符。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -466,6 +516,8 @@ getAttributeCount(): number ...@@ -466,6 +516,8 @@ getAttributeCount(): number
获取当前开始标记的属性数。 获取当前开始标记的属性数。
**系统能力:** SystemCapability.Utils.Lang
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
...@@ -476,6 +528,8 @@ getAttributeCount(): number ...@@ -476,6 +528,8 @@ getAttributeCount(): number
事件枚举。 事件枚举。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang
| 名称 | 枚举值 | 说明 | | 名称 | 枚举值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| START_DOCUMENT | 0 | 启动文件事件。 | | START_DOCUMENT | 0 | 启动文件事件。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册