Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“4978b75bcd96ec98bcaca4bb6a8f20434c210dbb”上不存在“...reference/apis/js-apis-file-environment.md”
提交 5b59ac7a 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 eb4b61f9
显示空白变更内容
内联 并排
Showing with 8892 addition and 678 deletion
en/application-dev/background-agent-scheduled-reminder/Readme-EN.md 0 → 100644
浏览文件 @ 5b59ac7a
# Agent-Powered Scheduled Reminders
- [Overview](background-agent-scheduled-reminder-overview.md)
- [Development Guidelines](background-agent-scheduled-reminder-guide.md)
en/application-dev/background-agent-scheduled-reminder/background-agent-scheduled-reminder-guide.md 0 → 100644
浏览文件 @ 5b59ac7a
# Development Guidelines<a name="EN-US_TOPIC_0000001185364575"></a>
## When to Use<a name="section18502174174019"></a>
You can set your application to call the **ReminderRequest** class to create scheduled reminders for countdown timers, calendar events, and alarm clocks. When the created reminders are published, the timing and pop-up notification functions of your application will be taken over by the reminder agent in the background, even when your application is frozen or exits.
## Available APIs<a name="section1633115419401"></a>
**reminderAgent** encapsulates the methods for publishing and canceling reminders.
**Table 1** Major APIs in reminderAgent
<a name="table1731550155318"></a>
<table><thead align="left"><tr id="row4419501537"><th class="cellrowborder" valign="top" width="57.38999999999999%" id="mcps1.2.3.1.1"><p id="p54150165315"><a name="p54150165315"></a><a name="p54150165315"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="42.61%" id="mcps1.2.3.1.2"><p id="p941150145313"><a name="p941150145313"></a><a name="p941150145313"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row34145016535"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p430944542010"><a name="p430944542010"></a><a name="p430944542010"></a>function publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback&lt;number&gt;): void;</p>
<p id="p830954512202"><a name="p830954512202"></a><a name="p830954512202"></a>function publishReminder(reminderReq: ReminderRequest): Promise&lt;number&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p13562171015712"><a name="p13562171015712"></a><a name="p13562171015712"></a>Publishes a scheduled reminder.</p>
<p id="p9591131611311"><a name="p9591131611311"></a><a name="p9591131611311"></a>The maximum number of valid notifications (excluding expired ones that will not pop up again) is 30 for one application and 2000 for the entire system.</p>
</td>
</tr>
<tr id="row1746172917474"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p44291637103317"><a name="p44291637103317"></a><a name="p44291637103317"></a>function cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void;</p>
<p id="p14430123714332"><a name="p14430123714332"></a><a name="p14430123714332"></a>function cancelReminder(reminderId: number): Promise&lt;void&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p3465939173317"><a name="p3465939173317"></a><a name="p3465939173317"></a>Cancels a specified reminder. (The value of <strong id="b83631346162614"><a name="b83631346162614"></a><a name="b83631346162614"></a>reminderId</strong> is obtained from the return value of <strong id="b236420465267"><a name="b236420465267"></a><a name="b236420465267"></a>publishReminder</strong>.)</p>
</td>
</tr>
<tr id="row10992232154714"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p1989534943310"><a name="p1989534943310"></a><a name="p1989534943310"></a>function getValidReminders(callback: AsyncCallback&lt;Array&lt;ReminderRequest&gt;&gt;): void;</p>
<p id="p289513497333"><a name="p289513497333"></a><a name="p289513497333"></a>function getValidReminders(): Promise&lt;Array&lt;ReminderRequest&gt;&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p184651639143320"><a name="p184651639143320"></a><a name="p184651639143320"></a>Obtains all valid reminders set by the current application.</p>
</td>
</tr>
<tr id="row933265824817"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p1061757123319"><a name="p1061757123319"></a><a name="p1061757123319"></a>function cancelAllReminders(callback: AsyncCallback&lt;void&gt;): void;</p>
<p id="p6615577336"><a name="p6615577336"></a><a name="p6615577336"></a>function cancelAllReminders(): Promise&lt;void&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p19451839143310"><a name="p19451839143310"></a><a name="p19451839143310"></a>Cancels all reminders set by the current application.</p>
</td>
</tr>
<tr id="row1241412130349"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p8882181819348"><a name="p8882181819348"></a><a name="p8882181819348"></a>function addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback&lt;void&gt;): void;</p>
<p id="p4882218173414"><a name="p4882218173414"></a><a name="p4882218173414"></a>function addNotificationSlot(slot: NotificationSlot): Promise&lt;void&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p142081320344"><a name="p142081320344"></a><a name="p142081320344"></a>Registers a <a href="../nottoctopics/en-us_topic_0000001180018813.md#section1382174172015">NotificationSlot</a> instance to be used by the reminder.</p>
</td>
</tr>
<tr id="row74014178349"><td class="cellrowborder" valign="top" width="57.38999999999999%" headers="mcps1.2.3.1.1 "><p id="p12474202953413"><a name="p12474202953413"></a><a name="p12474202953413"></a>function removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback&lt;void&gt;): void;</p>
<p id="p174748294340"><a name="p174748294340"></a><a name="p174748294340"></a>function removeNotificationSlot(slotType: notification.SlotType): Promise&lt;void&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="42.61%" headers="mcps1.2.3.1.2 "><p id="p1407141783410"><a name="p1407141783410"></a><a name="p1407141783410"></a>Removes a <a href="../nottoctopics/en-us_topic_0000001180018813.md#section1382174172015">NotificationSlot</a> instance of a specified type.</p>
</td>
</tr>
</tbody>
</table>
**ActionButtonType** enumerates types of buttons displayed in a reminder notification.
**Table 2** ActionButtonType enumeration
<a name="table8534712161513"></a>
<table><thead align="left"><tr id="row14540181231510"><th class="cellrowborder" valign="top" width="38.190000000000005%" id="mcps1.2.3.1.1"><p id="p1454718124159"><a name="p1454718124159"></a><a name="p1454718124159"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="61.809999999999995%" id="mcps1.2.3.1.2"><p id="p13547131219152"><a name="p13547131219152"></a><a name="p13547131219152"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row145471112121520"><td class="cellrowborder" valign="top" width="38.190000000000005%" headers="mcps1.2.3.1.1 "><p id="p25473122155"><a name="p25473122155"></a><a name="p25473122155"></a>ACTION_BUTTON_TYPE_CLOSE</p>
</td>
<td class="cellrowborder" valign="top" width="61.809999999999995%" headers="mcps1.2.3.1.2 "><p id="p13547161217154"><a name="p13547161217154"></a><a name="p13547161217154"></a>Close button, which can be tapped to stop the reminder alert tone, close the reminder notification, and cancel the reminder snoozing.</p>
</td>
</tr>
</tbody>
</table>
**ReminderType** enumerates the reminder types.
**Table 3** ReminderType enumeration
<a name="table486010552014"></a>
<table><thead align="left"><tr id="row2866856201"><th class="cellrowborder" valign="top" width="39.06%" id="mcps1.2.3.1.1"><p id="p986695162012"><a name="p986695162012"></a><a name="p986695162012"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="60.940000000000005%" id="mcps1.2.3.1.2"><p id="p1486620518202"><a name="p1486620518202"></a><a name="p1486620518202"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row786610513207"><td class="cellrowborder" valign="top" width="39.06%" headers="mcps1.2.3.1.1 "><p id="p13866125202014"><a name="p13866125202014"></a><a name="p13866125202014"></a>REMINDER_TYPE_TIMER</p>
</td>
<td class="cellrowborder" valign="top" width="60.940000000000005%" headers="mcps1.2.3.1.2 "><p id="p13866458201"><a name="p13866458201"></a><a name="p13866458201"></a>Countdown reminder.</p>
</td>
</tr>
<tr id="row186685122014"><td class="cellrowborder" valign="top" width="39.06%" headers="mcps1.2.3.1.1 "><p id="p0866453206"><a name="p0866453206"></a><a name="p0866453206"></a>REMINDER_TYPE_CALENDAR</p>
</td>
<td class="cellrowborder" valign="top" width="60.940000000000005%" headers="mcps1.2.3.1.2 "><p id="p128661457206"><a name="p128661457206"></a><a name="p128661457206"></a>Calendar reminder.</p>
</td>
</tr>
<tr id="row286616512011"><td class="cellrowborder" valign="top" width="39.06%" headers="mcps1.2.3.1.1 "><p id="p128664572016"><a name="p128664572016"></a><a name="p128664572016"></a>REMINDER_TYPE_ALARM</p>
</td>
<td class="cellrowborder" valign="top" width="60.940000000000005%" headers="mcps1.2.3.1.2 "><p id="p1786685122014"><a name="p1786685122014"></a><a name="p1786685122014"></a>Alarm reminder.</p>
</td>
</tr>
</tbody>
</table>
**ActionButton** defines a button displayed in the reminder notification.
**Table 4** ActionButton instance
<a name="table880311117225"></a>
<table><thead align="left"><tr id="row1480321118225"><th class="cellrowborder" valign="top" width="23.630000000000003%" id="mcps1.2.5.1.1"><p id="p1180321117222"><a name="p1180321117222"></a><a name="p1180321117222"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="16.81%" id="mcps1.2.5.1.2"><p id="p111051815193913"><a name="p111051815193913"></a><a name="p111051815193913"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.2.5.1.3"><p id="p765614597419"><a name="p765614597419"></a><a name="p765614597419"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="52.04%" id="mcps1.2.5.1.4"><p id="p1580412112223"><a name="p1580412112223"></a><a name="p1580412112223"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row28041711182219"><td class="cellrowborder" valign="top" width="23.630000000000003%" headers="mcps1.2.5.1.1 "><p id="p5804191132211"><a name="p5804191132211"></a><a name="p5804191132211"></a>title</p>
</td>
<td class="cellrowborder" valign="top" width="16.81%" headers="mcps1.2.5.1.2 "><p id="p8105161593916"><a name="p8105161593916"></a><a name="p8105161593916"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p7656659154110"><a name="p7656659154110"></a><a name="p7656659154110"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.04%" headers="mcps1.2.5.1.4 "><p id="p16804121112213"><a name="p16804121112213"></a><a name="p16804121112213"></a>Text on the button.</p>
</td>
</tr>
<tr id="row1080481114223"><td class="cellrowborder" valign="top" width="23.630000000000003%" headers="mcps1.2.5.1.1 "><p id="p8804811142212"><a name="p8804811142212"></a><a name="p8804811142212"></a>type</p>
</td>
<td class="cellrowborder" valign="top" width="16.81%" headers="mcps1.2.5.1.2 "><p id="p15105201573910"><a name="p15105201573910"></a><a name="p15105201573910"></a><a href="#table8534712161513">ActionButtonType</a></p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p196561059134118"><a name="p196561059134118"></a><a name="p196561059134118"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.04%" headers="mcps1.2.5.1.4 "><p id="p1080461192212"><a name="p1080461192212"></a><a name="p1080461192212"></a>Button type.</p>
</td>
</tr>
</tbody>
</table>
**WantAgent** sets the package and ability that are redirected to when the reminder notification is clicked.
**Table 5** WantAgent instance
<a name="table9490856350"></a>
<table><thead align="left"><tr id="row84962056352"><th class="cellrowborder" valign="top" width="23.917608239176083%" id="mcps1.2.5.1.1"><p id="p1849612519352"><a name="p1849612519352"></a><a name="p1849612519352"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="16.8983101689831%" id="mcps1.2.5.1.2"><p id="p1074419616402"><a name="p1074419616402"></a><a name="p1074419616402"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.519248075192481%" id="mcps1.2.5.1.3"><p id="p1281819114219"><a name="p1281819114219"></a><a name="p1281819114219"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="51.66483351664834%" id="mcps1.2.5.1.4"><p id="p7496125163511"><a name="p7496125163511"></a><a name="p7496125163511"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row114962512358"><td class="cellrowborder" valign="top" width="23.917608239176083%" headers="mcps1.2.5.1.1 "><p id="p15496856359"><a name="p15496856359"></a><a name="p15496856359"></a>pkgName</p>
</td>
<td class="cellrowborder" valign="top" width="16.8983101689831%" headers="mcps1.2.5.1.2 "><p id="p157445644017"><a name="p157445644017"></a><a name="p157445644017"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.2.5.1.3 "><p id="p17891915421"><a name="p17891915421"></a><a name="p17891915421"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.66483351664834%" headers="mcps1.2.5.1.4 "><p id="p24967514355"><a name="p24967514355"></a><a name="p24967514355"></a>Name of the package redirected to when the reminder notification is clicked.</p>
</td>
</tr>
<tr id="row5496135183515"><td class="cellrowborder" valign="top" width="23.917608239176083%" headers="mcps1.2.5.1.1 "><p id="p1449610533519"><a name="p1449610533519"></a><a name="p1449610533519"></a>abilityName</p>
</td>
<td class="cellrowborder" valign="top" width="16.8983101689831%" headers="mcps1.2.5.1.2 "><p id="p13744196164011"><a name="p13744196164011"></a><a name="p13744196164011"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.2.5.1.3 "><p id="p20815196420"><a name="p20815196420"></a><a name="p20815196420"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.66483351664834%" headers="mcps1.2.5.1.4 "><p id="p14966511359"><a name="p14966511359"></a><a name="p14966511359"></a>Name of the ability redirected to when the reminder notification is clicked.</p>
</td>
</tr>
</tbody>
</table>
**MaxScreenWantAgent** sets the name of the target package and ability to start automatically when the reminder arrives and the device is not in use. If the device is in use, a notification will be displayed.
**Table 6** MaxScreenWantAgent instance
<a name="table191319843714"></a>
<table><thead align="left"><tr id="row9131814374"><th class="cellrowborder" valign="top" width="24.44%" id="mcps1.2.5.1.1"><p id="p0131810372"><a name="p0131810372"></a><a name="p0131810372"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="16.74%" id="mcps1.2.5.1.2"><p id="p5493222124018"><a name="p5493222124018"></a><a name="p5493222124018"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.2.5.1.3"><p id="p12420143816426"><a name="p12420143816426"></a><a name="p12420143816426"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="51.300000000000004%" id="mcps1.2.5.1.4"><p id="p613188203712"><a name="p613188203712"></a><a name="p613188203712"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row81317819379"><td class="cellrowborder" valign="top" width="24.44%" headers="mcps1.2.5.1.1 "><p id="p1213083379"><a name="p1213083379"></a><a name="p1213083379"></a>pkgName</p>
</td>
<td class="cellrowborder" valign="top" width="16.74%" headers="mcps1.2.5.1.2 "><p id="p449311228408"><a name="p449311228408"></a><a name="p449311228408"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p54201738184212"><a name="p54201738184212"></a><a name="p54201738184212"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.300000000000004%" headers="mcps1.2.5.1.4 "><p id="p13390173423710"><a name="p13390173423710"></a><a name="p13390173423710"></a>Name of the package that is automatically started when the reminder arrives and the device is not in use.</p>
</td>
</tr>
<tr id="row14131285372"><td class="cellrowborder" valign="top" width="24.44%" headers="mcps1.2.5.1.1 "><p id="p913178203713"><a name="p913178203713"></a><a name="p913178203713"></a>abilityName</p>
</td>
<td class="cellrowborder" valign="top" width="16.74%" headers="mcps1.2.5.1.2 "><p id="p149352254017"><a name="p149352254017"></a><a name="p149352254017"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p11420193815427"><a name="p11420193815427"></a><a name="p11420193815427"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.300000000000004%" headers="mcps1.2.5.1.4 "><p id="p639093443717"><a name="p639093443717"></a><a name="p639093443717"></a>Name of the ability that is automatically started when the reminder arrives and the device is not in use.</p>
</td>
</tr>
</tbody>
</table>
**ReminderRequest** defines the reminder to publish.
**Table 7** ReminderRequest instance
<a name="table121851239193814"></a>
<table><thead align="left"><tr id="row1019153914389"><th class="cellrowborder" valign="top" width="24.94%" id="mcps1.2.5.1.1"><p id="p712019463387"><a name="p712019463387"></a><a name="p712019463387"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="17.06%" id="mcps1.2.5.1.2"><p id="p13510183419404"><a name="p13510183419404"></a><a name="p13510183419404"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.2.5.1.3"><p id="p19861165634219"><a name="p19861165634219"></a><a name="p19861165634219"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="50.480000000000004%" id="mcps1.2.5.1.4"><p id="p171201246103818"><a name="p171201246103818"></a><a name="p171201246103818"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row419114391388"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p919193953819"><a name="p919193953819"></a><a name="p919193953819"></a>reminderType</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p3510113419402"><a name="p3510113419402"></a><a name="p3510113419402"></a><a href="#table486010552014">ReminderType</a></p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p2861175674219"><a name="p2861175674219"></a><a name="p2861175674219"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p1019193963812"><a name="p1019193963812"></a><a name="p1019193963812"></a>Type of the reminder.</p>
</td>
</tr>
<tr id="row11911939103813"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p1619123919389"><a name="p1619123919389"></a><a name="p1619123919389"></a>actionButton</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p18510034194010"><a name="p18510034194010"></a><a name="p18510034194010"></a>[<a href="#table880311117225">ActionButton</a>?, <a href="#table880311117225">ActionButton</a>?]</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p686185619429"><a name="p686185619429"></a><a name="p686185619429"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p3191133963820"><a name="p3191133963820"></a><a name="p3191133963820"></a>Action button displayed in the reminder notification.</p>
</td>
</tr>
<tr id="row16191739173818"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p1192203917389"><a name="p1192203917389"></a><a name="p1192203917389"></a>wantAgent</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p751063415403"><a name="p751063415403"></a><a name="p751063415403"></a><a href="#table9490856350">WantAgent</a></p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p2073141213436"><a name="p2073141213436"></a><a name="p2073141213436"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p819218395387"><a name="p819218395387"></a><a name="p819218395387"></a>Information about the ability that is redirected to when the notification is clicked.</p>
</td>
</tr>
<tr id="row1619273923810"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p4192123913811"><a name="p4192123913811"></a><a name="p4192123913811"></a>maxScreenWantAgent</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p451023412402"><a name="p451023412402"></a><a name="p451023412402"></a><a href="#table191319843714">MaxScreenWantAgent</a></p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p107401912144311"><a name="p107401912144311"></a><a name="p107401912144311"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p119213933815"><a name="p119213933815"></a><a name="p119213933815"></a>Information about the ability that is automatically started when the reminder arrives. If the device is in use, a notification will be displayed.</p>
</td>
</tr>
<tr id="row15192739143819"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p111927395386"><a name="p111927395386"></a><a name="p111927395386"></a>ringDuration</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p9510183415406"><a name="p9510183415406"></a><a name="p9510183415406"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p11747712154313"><a name="p11747712154313"></a><a name="p11747712154313"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p219216392383"><a name="p219216392383"></a><a name="p219216392383"></a>Ring duration.</p>
</td>
</tr>
<tr id="row0192183918384"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p1819210398387"><a name="p1819210398387"></a><a name="p1819210398387"></a>snoozeTimes</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p1251019344404"><a name="p1251019344404"></a><a name="p1251019344404"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p14753151217435"><a name="p14753151217435"></a><a name="p14753151217435"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p61921339123820"><a name="p61921339123820"></a><a name="p61921339123820"></a>Number of reminder snooze times.</p>
</td>
</tr>
<tr id="row6192193913384"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p191928395381"><a name="p191928395381"></a><a name="p191928395381"></a>timeInterval</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p1851013348407"><a name="p1851013348407"></a><a name="p1851013348407"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p157581712164315"><a name="p157581712164315"></a><a name="p157581712164315"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p719203912388"><a name="p719203912388"></a><a name="p719203912388"></a>Reminder snooze interval.</p>
</td>
</tr>
<tr id="row22821842154410"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p2282104244419"><a name="p2282104244419"></a><a name="p2282104244419"></a>title</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p1428204218441"><a name="p1428204218441"></a><a name="p1428204218441"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p313612319485"><a name="p313612319485"></a><a name="p313612319485"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p1028274244411"><a name="p1028274244411"></a><a name="p1028274244411"></a>Reminder title.</p>
</td>
</tr>
<tr id="row119442450449"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p994411458444"><a name="p994411458444"></a><a name="p994411458444"></a>content</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p10944164517447"><a name="p10944164517447"></a><a name="p10944164517447"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p191361723134820"><a name="p191361723134820"></a><a name="p191361723134820"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p159451245154413"><a name="p159451245154413"></a><a name="p159451245154413"></a>Reminder content.</p>
</td>
</tr>
<tr id="row1428595417443"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p92856546444"><a name="p92856546444"></a><a name="p92856546444"></a>expiredContent</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p9285125419445"><a name="p9285125419445"></a><a name="p9285125419445"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p8136202364819"><a name="p8136202364819"></a><a name="p8136202364819"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p2286115418440"><a name="p2286115418440"></a><a name="p2286115418440"></a>Extended content to be displayed when the reminder expires.</p>
</td>
</tr>
<tr id="row56012507442"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p760105019447"><a name="p760105019447"></a><a name="p760105019447"></a>snoozeContent</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p460195019444"><a name="p460195019444"></a><a name="p460195019444"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p27102634812"><a name="p27102634812"></a><a name="p27102634812"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p66021050104419"><a name="p66021050104419"></a><a name="p66021050104419"></a>Extended content to be displayed when the reminder is snoozing.</p>
</td>
</tr>
<tr id="row123271239450"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p14327113104513"><a name="p14327113104513"></a><a name="p14327113104513"></a>notificationId</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p19327173154514"><a name="p19327173154514"></a><a name="p19327173154514"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p12898269481"><a name="p12898269481"></a><a name="p12898269481"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p16327733456"><a name="p16327733456"></a><a name="p16327733456"></a>Notification ID used by the reminder. For details, see the API reference of the <strong id="b1391142771410"><a name="b1391142771410"></a><a name="b1391142771410"></a>NotificationRequest.setNotificationId(int id)</strong> method.</p>
</td>
</tr>
<tr id="row4369223114511"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.2.5.1.1 "><p id="p13370423174515"><a name="p13370423174515"></a><a name="p13370423174515"></a>slotType</p>
</td>
<td class="cellrowborder" valign="top" width="17.06%" headers="mcps1.2.5.1.2 "><p id="p8370102334517"><a name="p8370102334517"></a><a name="p8370102334517"></a><a href="../nottoctopics/en-us_topic_0000001180018813.md#section072355105110">SlotType</a></p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.2.5.1.3 "><p id="p41151626144814"><a name="p41151626144814"></a><a name="p41151626144814"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.480000000000004%" headers="mcps1.2.5.1.4 "><p id="p193705238459"><a name="p193705238459"></a><a name="p193705238459"></a>Type of the slot used by the reminder</p>
</td>
</tr>
</tbody>
</table>
**ReminderRequestCalendar** extends **ReminderRequest** and defines a reminder for a calendar event.
The earliest reminder time must be later than the current time.
**Table 8** ReminderRequestCalendar instance
<a name="table19307315135210"></a>
<table><thead align="left"><tr id="row113131315175216"><th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.1"><p id="p656917217528"><a name="p656917217528"></a><a name="p656917217528"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="17.48%" id="mcps1.2.5.1.2"><p id="p1356913214522"><a name="p1356913214522"></a><a name="p1356913214522"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.22%" id="mcps1.2.5.1.3"><p id="p125701221135211"><a name="p125701221135211"></a><a name="p125701221135211"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="50.3%" id="mcps1.2.5.1.4"><p id="p1757012113526"><a name="p1757012113526"></a><a name="p1757012113526"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row16314201516528"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p83141715105220"><a name="p83141715105220"></a><a name="p83141715105220"></a>dateTime</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.2.5.1.2 "><p id="p73141315165214"><a name="p73141315165214"></a><a name="p73141315165214"></a><a href="#table16133167515">LocalDateTime</a></p>
</td>
<td class="cellrowborder" valign="top" width="7.22%" headers="mcps1.2.5.1.3 "><p id="p4314201510524"><a name="p4314201510524"></a><a name="p4314201510524"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.3%" headers="mcps1.2.5.1.4 "><p id="p1031461511522"><a name="p1031461511522"></a><a name="p1031461511522"></a>Reminder time.</p>
</td>
</tr>
<tr id="row631461520524"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p1431419151526"><a name="p1431419151526"></a><a name="p1431419151526"></a>repeatMonths</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.2.5.1.2 "><p id="p1231415155525"><a name="p1231415155525"></a><a name="p1231415155525"></a>Array&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="7.22%" headers="mcps1.2.5.1.3 "><p id="p1031461595220"><a name="p1031461595220"></a><a name="p1031461595220"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.3%" headers="mcps1.2.5.1.4 "><p id="p2031411555218"><a name="p2031411555218"></a><a name="p2031411555218"></a>Months in which the reminder repeats.</p>
</td>
</tr>
<tr id="row731481513526"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p031471515525"><a name="p031471515525"></a><a name="p031471515525"></a>repeatDays</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.2.5.1.2 "><p id="p1031401513523"><a name="p1031401513523"></a><a name="p1031401513523"></a>Array&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="7.22%" headers="mcps1.2.5.1.3 "><p id="p93141115135214"><a name="p93141115135214"></a><a name="p93141115135214"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="50.3%" headers="mcps1.2.5.1.4 "><p id="p18314141515212"><a name="p18314141515212"></a><a name="p18314141515212"></a>Date on which the reminder repeats.</p>
</td>
</tr>
</tbody>
</table>
**ReminderRequestAlarm** extends **ReminderRequest** and defines a reminder for the alarm clock.
**Table 9** ReminderRequestAlarm instance
<a name="table187631616124414"></a>
<table><thead align="left"><tr id="row87697166445"><th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.1"><p id="p6561172104414"><a name="p6561172104414"></a><a name="p6561172104414"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="17.83%" id="mcps1.2.5.1.2"><p id="p135622219448"><a name="p135622219448"></a><a name="p135622219448"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.31%" id="mcps1.2.5.1.3"><p id="p256218218446"><a name="p256218218446"></a><a name="p256218218446"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="49.86%" id="mcps1.2.5.1.4"><p id="p1656212110445"><a name="p1656212110445"></a><a name="p1656212110445"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row2770151624415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p157701016164417"><a name="p157701016164417"></a><a name="p157701016164417"></a>hour</p>
</td>
<td class="cellrowborder" valign="top" width="17.83%" headers="mcps1.2.5.1.2 "><p id="p577071644418"><a name="p577071644418"></a><a name="p577071644418"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.31%" headers="mcps1.2.5.1.3 "><p id="p17770141618445"><a name="p17770141618445"></a><a name="p17770141618445"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.86%" headers="mcps1.2.5.1.4 "><p id="p1770161618444"><a name="p1770161618444"></a><a name="p1770161618444"></a>Hour portion of the reminder time.</p>
</td>
</tr>
<tr id="row1177019161448"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p77705169442"><a name="p77705169442"></a><a name="p77705169442"></a>minute</p>
</td>
<td class="cellrowborder" valign="top" width="17.83%" headers="mcps1.2.5.1.2 "><p id="p127701216134415"><a name="p127701216134415"></a><a name="p127701216134415"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.31%" headers="mcps1.2.5.1.3 "><p id="p1477018169442"><a name="p1477018169442"></a><a name="p1477018169442"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.86%" headers="mcps1.2.5.1.4 "><p id="p17703161445"><a name="p17703161445"></a><a name="p17703161445"></a>Minute portion of the reminder time.</p>
</td>
</tr>
<tr id="row16770416194410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p157706167440"><a name="p157706167440"></a><a name="p157706167440"></a>daysOfWeek</p>
</td>
<td class="cellrowborder" valign="top" width="17.83%" headers="mcps1.2.5.1.2 "><p id="p6770151654411"><a name="p6770151654411"></a><a name="p6770151654411"></a>Array&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="7.31%" headers="mcps1.2.5.1.3 "><p id="p19770616134413"><a name="p19770616134413"></a><a name="p19770616134413"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="49.86%" headers="mcps1.2.5.1.4 "><p id="p16101423134917"><a name="p16101423134917"></a><a name="p16101423134917"></a>Days of a week when the reminder repeats.</p>
</td>
</tr>
</tbody>
</table>
**ReminderRequestTimer** extends **ReminderRequest** and defines a reminder for a scheduled timer.
**Table 10** ReminderRequestTimer instance
<a name="table7213172015507"></a>
<table><thead align="left"><tr id="row72131520155017"><th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.1"><p id="p6603124145017"><a name="p6603124145017"></a><a name="p6603124145017"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="18.09%" id="mcps1.2.5.1.2"><p id="p1860442410503"><a name="p1860442410503"></a><a name="p1860442410503"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.739999999999999%" id="mcps1.2.5.1.3"><p id="p146049246506"><a name="p146049246506"></a><a name="p146049246506"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="49.17%" id="mcps1.2.5.1.4"><p id="p7604724175019"><a name="p7604724175019"></a><a name="p7604724175019"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row172131201507"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p32141320105018"><a name="p32141320105018"></a><a name="p32141320105018"></a>triggerTimeInSeconds</p>
</td>
<td class="cellrowborder" valign="top" width="18.09%" headers="mcps1.2.5.1.2 "><p id="p621420207509"><a name="p621420207509"></a><a name="p621420207509"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.739999999999999%" headers="mcps1.2.5.1.3 "><p id="p13214112075014"><a name="p13214112075014"></a><a name="p13214112075014"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.17%" headers="mcps1.2.5.1.4 "><p id="p7214112014509"><a name="p7214112014509"></a><a name="p7214112014509"></a>Number of seconds in the countdown timer.</p>
</td>
</tr>
</tbody>
</table>
**LocalDateTime** defines a **LocalDateTime** instance.
**Table 11** LocalDateTime instance
<a name="table16133167515"></a>
<table><thead align="left"><tr id="row161321615517"><th class="cellrowborder" valign="top" width="25%" id="mcps1.2.5.1.1"><p id="p5894111825115"><a name="p5894111825115"></a><a name="p5894111825115"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="18.970000000000002%" id="mcps1.2.5.1.2"><p id="p0894161818514"><a name="p0894161818514"></a><a name="p0894161818514"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.39%" id="mcps1.2.5.1.3"><p id="p789419187513"><a name="p789419187513"></a><a name="p789419187513"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="48.64%" id="mcps1.2.5.1.4"><p id="p18949181519"><a name="p18949181519"></a><a name="p18949181519"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row814191617518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p3141716115110"><a name="p3141716115110"></a><a name="p3141716115110"></a>year</p>
</td>
<td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.2.5.1.2 "><p id="p714916145113"><a name="p714916145113"></a><a name="p714916145113"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.39%" headers="mcps1.2.5.1.3 "><p id="p314161620516"><a name="p314161620516"></a><a name="p314161620516"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.64%" headers="mcps1.2.5.1.4 "><p id="p1314716105114"><a name="p1314716105114"></a><a name="p1314716105114"></a>Year.</p>
</td>
</tr>
<tr id="row7147166511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p1314131615111"><a name="p1314131615111"></a><a name="p1314131615111"></a>month</p>
</td>
<td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.2.5.1.2 "><p id="p154047112527"><a name="p154047112527"></a><a name="p154047112527"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.39%" headers="mcps1.2.5.1.3 "><p id="p20835587510"><a name="p20835587510"></a><a name="p20835587510"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.64%" headers="mcps1.2.5.1.4 "><p id="p13143167515"><a name="p13143167515"></a><a name="p13143167515"></a>Month.</p>
</td>
</tr>
<tr id="row61420169512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p1114616185113"><a name="p1114616185113"></a><a name="p1114616185113"></a>day</p>
</td>
<td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.2.5.1.2 "><p id="p44302113521"><a name="p44302113521"></a><a name="p44302113521"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.39%" headers="mcps1.2.5.1.3 "><p id="p12105105818518"><a name="p12105105818518"></a><a name="p12105105818518"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.64%" headers="mcps1.2.5.1.4 "><p id="p171491655111"><a name="p171491655111"></a><a name="p171491655111"></a>Date.</p>
</td>
</tr>
<tr id="row10141616155115"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p114171611514"><a name="p114171611514"></a><a name="p114171611514"></a>hour</p>
</td>
<td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.2.5.1.2 "><p id="p245813117524"><a name="p245813117524"></a><a name="p245813117524"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.39%" headers="mcps1.2.5.1.3 "><p id="p613435845117"><a name="p613435845117"></a><a name="p613435845117"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.64%" headers="mcps1.2.5.1.4 "><p id="p71471645112"><a name="p71471645112"></a><a name="p71471645112"></a>Hour.</p>
</td>
</tr>
<tr id="row201417169511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p1814121615511"><a name="p1814121615511"></a><a name="p1814121615511"></a>minute</p>
</td>
<td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.2.5.1.2 "><p id="p154671511175213"><a name="p154671511175213"></a><a name="p154671511175213"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.39%" headers="mcps1.2.5.1.3 "><p id="p61445587511"><a name="p61445587511"></a><a name="p61445587511"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.64%" headers="mcps1.2.5.1.4 "><p id="p1114141617511"><a name="p1114141617511"></a><a name="p1114141617511"></a>Minute.</p>
</td>
</tr>
<tr id="row114171610510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.2.5.1.1 "><p id="p914131655118"><a name="p914131655118"></a><a name="p914131655118"></a>second</p>
</td>
<td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.2.5.1.2 "><p id="p1847810111524"><a name="p1847810111524"></a><a name="p1847810111524"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.39%" headers="mcps1.2.5.1.3 "><p id="p3141816155111"><a name="p3141816155111"></a><a name="p3141816155111"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="48.64%" headers="mcps1.2.5.1.4 "><p id="p61471645118"><a name="p61471645118"></a><a name="p61471645118"></a>Second.</p>
</td>
</tr>
</tbody>
</table>
## How to Develop<a name="section4207112818418"></a>
>![](../public_sys-resources/icon-note.gif) **NOTE:**
>To publish a reminder, your application needs to apply for the **ohos.permission.PUBLISH\_AGENT\_REMINDER** permission.
Publish a 10-second countdown reminder.
1. Define a countdown timer instance.
```
import reminderAgent from '@ohos.reminderAgent';
import notification from '@ohos.notification';
export default {
timer: {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 10,
actionButton: [
{
title: "close",
type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
}
],
wantAgent: {
pkgName: "com.huawei.phone",
abilityName: "com.huawei.phone.MainAbility"
},
maxScreenWantAgent: {
pkgName: "com.huawei.phone",
abilityName: "com.huawei.phone.MainAbility"
},
title: "this is title",
content: "this is content",
expiredContent: "this reminder has expired",
notificationId: 100,
slotType: notification.SlotType.SOCIAL_COMMUNICATION
}
}
```
2. Publish the reminder.
```
startTimer() {
reminderAgent.publishReminder(this.timer, (err, reminderId) =>{
this.printInfo(JSON.stringify(err));
this.printInfo("reminderId:" + reminderId);
});
}
```
HTML page code:
```
<div class="container">
<button type="text" value="publishReminder" onclick="startTimer"></button>
</div>
```
Sample code for defining a calendar reminder instance:
```
calendar: {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_CALENDAR,
dateTime: {
year: 2050,
month: 7,
day: 30,
hour: 11,
minute: 14,
second: 30
},
repeatMonths: [0],
repeatDays: [0],
actionButton: [
{
title: "close",
type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
},
{
title: "snooze",
type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE
},
],
wantAgent: {
pkgName: "com.huawei.phone",
abilityName: "com.huawei.phone.MainAbility"
},
maxScreenWantAgent: {
pkgName: "com.huawei.phone",
abilityName: "com.huawei.phone.MainAbility"
},
ringDuration: 5,
snoozeTimes: 2,
timeInterval: 5,
title: "this is title",
content: "this is content",
expiredContent: "this reminder has expired",
snoozeContent: "remind later",
notificationId: 100,
slotType: notification.SlotType.SOCIAL_COMMUNICATION
}
```
Sample code for defining an alarm reminder instance:
```
alarm: {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_ALARM,
hour: 11,
minute: 14,
daysOfWeek: [0],
actionButton: [
{
title: "close",
type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
},
{
title: "snooze",
type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE
},
],
wantAgent: {
pkgName: "com.huawei.phone",
abilityName: "com.huawei.phone.MainAbility"
},
maxScreenWantAgent: {
pkgName: "com.huawei.phone",
abilityName: "com.huawei.phone.MainAbility"
},
ringDuration: 5,
snoozeTimes: 2,
timeInterval: 5,
title: "this is title",
content: "this is content",
expiredContent: "this reminder has expired",
snoozeContent: "remind later",
notificationId: 100,
slotType: notification.SlotType.SOCIAL_COMMUNICATION
}
```
en/application-dev/background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md 0 → 100644
浏览文件 @ 5b59ac7a
# Overview<a name="EN-US_TOPIC_0000001139084594"></a>
Your application can call the **ReminderRequest** class to create scheduled reminders for countdown timers, calendar events, and alarm clocks. When the created reminders are published, the timing and pop-up notification functions of your application will be taken over by the reminder agent in the background, even when your application is frozen or exits.
en/application-dev/database/Readme-EN.md
浏览文件 @ 5b59ac7a
# Distributed Data Service # Data Management
- [Distributed Data Service Overview](database-mdds-overview.md) - Distributed Data Service
- [Distributed Data Service Development](database-mdds-guidelines.md) - [Distributed Data Service Overview](database-mdds-overview.md)
- [Distributed Data Service Development](database-mdds-guidelines.md)
- Relational Database Overview
- [RDB Overview](database-relational-overview.md)
- [RDB Development](database-relational-guidelines.md)
- Lightweight Data Store
- [Lightweight Data Store Overview](database-preference-overview.md)
- [Lightweight Data Store Development](database-preference-guidelines.md)
\ No newline at end of file
en/application-dev/database/database-relational-development.md 0 → 100644
浏览文件 @ 5b59ac7a
# RDB Development<a name="EN-US_TOPIC_0000001185510898"></a>
## When to Use<a name="section3905444123020"></a>
On the basis of the SQLite database, the RDB allows you to operate data with or without native SQL statements. An RDB is also called RDB store.
## Available APIs<a name="section5504175713016"></a>
**Creating and Deleting an RDB Store**
The following table describes APIs available for creating and deleting an RDB store.
**Table 1** APIs for creating and deleting an RDB store
<a name="table191861518153620"></a>
<table><thead align="left"><tr id="row14232318163610"><th class="cellrowborder" valign="top" width="16.650000000000002%" id="mcps1.2.4.1.1"><p id="p17444101665110"><a name="p17444101665110"></a><a name="p17444101665110"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="30.61%" id="mcps1.2.4.1.2"><p id="p182321618163611"><a name="p182321618163611"></a><a name="p182321618163611"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="52.739999999999995%" id="mcps1.2.4.1.3"><p id="p1623211815366"><a name="p1623211815366"></a><a name="p1623211815366"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row16783162014173"><td class="cellrowborder" valign="top" width="16.650000000000002%" headers="mcps1.2.4.1.1 "><p id="p17783122019176"><a name="p17783122019176"></a><a name="p17783122019176"></a>dataRdb</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.2.4.1.2 "><p id="p231111599237"><a name="p231111599237"></a><a name="p231111599237"></a>getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback&lt;RdbStore&gt;): void</p>
</td>
<td class="cellrowborder" valign="top" width="52.739999999999995%" headers="mcps1.2.4.1.3 "><p id="p9186112481614"><a name="p9186112481614"></a><a name="p9186112481614"></a>Obtains an RDB store. You can set parameters for the RDB store based on service requirements, call APIs to perform data operations, and use a callback to return the result.</p>
<a name="ul20498114912320"></a><a name="ul20498114912320"></a><ul id="ul20498114912320"><li><strong id="b4112115595818"><a name="b4112115595818"></a><a name="b4112115595818"></a>config</strong>: configuration of the RDB store.</li><li><strong id="b11397121135919"><a name="b11397121135919"></a><a name="b11397121135919"></a>version</strong>: version of the RDB store.</li><li><strong id="b43570718591"><a name="b43570718591"></a><a name="b43570718591"></a>callback</strong>: callback invoked to return the RDB store.</li></ul>
</td>
</tr>
<tr id="row32321018143616"><td class="cellrowborder" valign="top" width="16.650000000000002%" headers="mcps1.2.4.1.1 "><p id="p12399202916814"><a name="p12399202916814"></a><a name="p12399202916814"></a>dataRdb</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.2.4.1.2 "><p id="p3501131011457"><a name="p3501131011457"></a><a name="p3501131011457"></a>getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.739999999999995%" headers="mcps1.2.4.1.3 "><p id="p17526162133220"><a name="p17526162133220"></a><a name="p17526162133220"></a>Obtains an RDB store. You can set parameters for the RDB store based on service requirements, call APIs to perform data operations, and use a promise to return the result.</p>
<a name="ul19719610863"></a><a name="ul19719610863"></a><ul id="ul19719610863"><li><strong id="b153861822027"><a name="b153861822027"></a><a name="b153861822027"></a>config</strong>: configuration of the RDB store.</li><li><strong id="b175492306216"><a name="b175492306216"></a><a name="b175492306216"></a>version</strong>: version of the RDB store.</li></ul>
</td>
</tr>
<tr id="row1423210186365"><td class="cellrowborder" valign="top" width="16.650000000000002%" headers="mcps1.2.4.1.1 "><p id="p94441216175111"><a name="p94441216175111"></a><a name="p94441216175111"></a>dataRdb</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.2.4.1.2 "><p id="p1056516197468"><a name="p1056516197468"></a><a name="p1056516197468"></a>deleteRdbStore(name: string, callback: AsyncCallback&lt;void&gt;): void</p>
</td>
<td class="cellrowborder" valign="top" width="52.739999999999995%" headers="mcps1.2.4.1.3 "><p id="p761845132510"><a name="p761845132510"></a><a name="p761845132510"></a>Deletes an RDB store. This method uses a callback to return the result.</p>
<a name="ul11527402717"></a><a name="ul11527402717"></a><ul id="ul11527402717"><li><strong id="b152695571624"><a name="b152695571624"></a><a name="b152695571624"></a>name</strong>: name of the RDB store to delete.</li><li><strong id="b11959131911316"><a name="b11959131911316"></a><a name="b11959131911316"></a>callback</strong>: callback invoked to return the result. If the RDB store is deleted, <strong id="b717583515112554"><a name="b717583515112554"></a><a name="b717583515112554"></a>true</strong> will be returned. Otherwise, <strong id="b1492094045112554"><a name="b1492094045112554"></a><a name="b1492094045112554"></a>false</strong> will be returned.</li></ul>
</td>
</tr>
<tr id="row923319186367"><td class="cellrowborder" valign="top" width="16.650000000000002%" headers="mcps1.2.4.1.1 "><p id="p66511731173510"><a name="p66511731173510"></a><a name="p66511731173510"></a>dataRdb</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.2.4.1.2 "><p id="p29801620134717"><a name="p29801620134717"></a><a name="p29801620134717"></a>deleteRdbStore(name: string): Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.739999999999995%" headers="mcps1.2.4.1.3 "><p id="p1112512307296"><a name="p1112512307296"></a><a name="p1112512307296"></a>Deletes an RDB store. This method uses a promise to return the result.</p>
<a name="ul114112033"></a><a name="ul114112033"></a><ul id="ul114112033"><li><strong id="b8147125819315"><a name="b8147125819315"></a><a name="b8147125819315"></a>name</strong>: name of the RDB store to delete.</li></ul>
</td>
</tr>
</tbody>
</table>
**Managing Data in an RDB Store**
The RDB provides APIs for inserting, deleting, modifying, and querying data in the local RDB store.
- **Inserting data**
The RDB provides methods for inserting data through **ValuesBucket** in a data table. If the data is inserted successfully, the row number of the data inserted is returned; otherwise, **-1** is returned.
**Table 2** APIs for inserting data to a data table
<a name="table96811457164612"></a>
<table><thead align="left"><tr id="row1971245734616"><th class="cellrowborder" valign="top" width="11.53%" id="mcps1.2.4.1.1"><p id="p102415083812"><a name="p102415083812"></a><a name="p102415083812"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="42.230000000000004%" id="mcps1.2.4.1.2"><p id="p371235717461"><a name="p371235717461"></a><a name="p371235717461"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="46.239999999999995%" id="mcps1.2.4.1.3"><p id="p471215713468"><a name="p471215713468"></a><a name="p471215713468"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row14918412104220"><td class="cellrowborder" valign="top" width="11.53%" headers="mcps1.2.4.1.1 "><p id="p691914127421"><a name="p691914127421"></a><a name="p691914127421"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="42.230000000000004%" headers="mcps1.2.4.1.2 "><p id="p12888149165312"><a name="p12888149165312"></a><a name="p12888149165312"></a>insert(name: string, values: ValuesBucket, callback: AsyncCallback&lt;number&gt;):void</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p891981214423"><a name="p891981214423"></a><a name="p891981214423"></a>Inserts a row of data into a table. This method uses a callback to return the result.</p>
<a name="ul929362324319"></a><a name="ul929362324319"></a><ul id="ul929362324319"><li><strong id="b791810215118"><a name="b791810215118"></a><a name="b791810215118"></a>name</strong>: name of the target table.</li><li><strong id="b1168133481113"><a name="b1168133481113"></a><a name="b1168133481113"></a>values</strong>: data to be inserted into the table.</li><li><strong id="b153601828111218"><a name="b153601828111218"></a><a name="b153601828111218"></a>callback</strong>: callback invoked to return the result. If the operation is successful, the row ID will be returned. Otherwise, <strong id="b1062976631112554"><a name="b1062976631112554"></a><a name="b1062976631112554"></a>-1</strong> will be returned.</li></ul>
</td>
</tr>
<tr id="row17129579467"><td class="cellrowborder" valign="top" width="11.53%" headers="mcps1.2.4.1.1 "><p id="p6240010381"><a name="p6240010381"></a><a name="p6240010381"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="42.230000000000004%" headers="mcps1.2.4.1.2 "><p id="p18352838115114"><a name="p18352838115114"></a><a name="p18352838115114"></a>insert(name: string, values: ValuesBucket): Promise&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p579311300812"><a name="p579311300812"></a><a name="p579311300812"></a>Inserts a row of data into a table. This method uses a promise to return the result.</p>
<a name="ul121533410439"></a><a name="ul121533410439"></a><ul id="ul121533410439"><li><strong id="b928413422120"><a name="b928413422120"></a><a name="b928413422120"></a>name</strong>: name of the target table.</li><li><strong id="b17334499123"><a name="b17334499123"></a><a name="b17334499123"></a>values</strong>: data to be inserted into the table.</li></ul>
</td>
</tr>
</tbody>
</table>
- **Updating data**
Call the **update\(\)** method to pass the new data and specify the update conditions by using **RdbPredicates**. If the data is successfully updated, the row number of the updated data is returned; otherwise, **0** is returned.
**Table 3** APIs for updating data
<a name="table183714445119"></a>
<table><thead align="left"><tr id="row766194475113"><th class="cellrowborder" valign="top" width="8.92%" id="mcps1.2.4.1.1"><p id="p987519262464"><a name="p987519262464"></a><a name="p987519262464"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="45.050000000000004%" id="mcps1.2.4.1.2"><p id="p1766144165119"><a name="p1766144165119"></a><a name="p1766144165119"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="46.03%" id="mcps1.2.4.1.3"><p id="p16663445516"><a name="p16663445516"></a><a name="p16663445516"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1597713174814"><td class="cellrowborder" valign="top" width="8.92%" headers="mcps1.2.4.1.1 "><p id="p14978183124810"><a name="p14978183124810"></a><a name="p14978183124810"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.4.1.2 "><p id="p17502226105513"><a name="p17502226105513"></a><a name="p17502226105513"></a>update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void</p>
</td>
<td class="cellrowborder" valign="top" width="46.03%" headers="mcps1.2.4.1.3 "><p id="p173581429117"><a name="p173581429117"></a><a name="p173581429117"></a>Updates the data that meets the conditions specified by the <strong id="b656572122112554"><a name="b656572122112554"></a><a name="b656572122112554"></a>RdbPredicates</strong> object. This method uses a callback to return the result.</p>
<a name="ul192831157114818"></a><a name="ul192831157114818"></a><ul id="ul192831157114818"><li><strong id="b174257709112554"><a name="b174257709112554"></a><a name="b174257709112554"></a>values</strong>: data to update, which is stored in <strong id="b721764115206"><a name="b721764115206"></a><a name="b721764115206"></a>ValuesBucket</strong>.</li><li><strong id="b09125491559"><a name="b09125491559"></a><a name="b09125491559"></a>rdbPredicates</strong>: conditions for updating data.</li><li><strong id="b10866112471917"><a name="b10866112471917"></a><a name="b10866112471917"></a>callback</strong>: callback invoked to return the number of rows updated.</li></ul>
</td>
</tr>
<tr id="row9207612172712"><td class="cellrowborder" valign="top" width="8.92%" headers="mcps1.2.4.1.1 "><p id="p287617260466"><a name="p287617260466"></a><a name="p287617260466"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.2.4.1.2 "><p id="p19559457195711"><a name="p19559457195711"></a><a name="p19559457195711"></a>update(values: ValuesBucket, rdbPredicates: RdbPredicates): Promise</p>
</td>
<td class="cellrowborder" valign="top" width="46.03%" headers="mcps1.2.4.1.3 "><p id="p102077125277"><a name="p102077125277"></a><a name="p102077125277"></a>Updates the data that meets the conditions specified by the <strong id="b11262847102416"><a name="b11262847102416"></a><a name="b11262847102416"></a>RdbPredicates</strong> object. This method uses a promise to return the result.</p>
<a name="ul3397556155017"></a><a name="ul3397556155017"></a><ul id="ul3397556155017"><li><strong id="b694170152510"><a name="b694170152510"></a><a name="b694170152510"></a>values</strong>: data to update, which is stored in <strong id="b3949012512"><a name="b3949012512"></a><a name="b3949012512"></a>ValuesBucket</strong>.</li><li><strong id="b1992219615"><a name="b1992219615"></a><a name="b1992219615"></a>rdbPredicates</strong>: conditions for updating data.</li></ul>
</td>
</tr>
</tbody>
</table>
- **Deleting data**
Call the **delete\(\)** method to delete data meeting the conditions specified by **RdbPredicates**. If the data is deleted, the row number of the deleted data is returned; otherwise, **0** is returned.
**Table 4** APIs for deleting data
<a name="table12163622913"></a>
<table><thead align="left"><tr id="row111891027912"><th class="cellrowborder" valign="top" width="10.02%" id="mcps1.2.4.1.1"><p id="p3130348174917"><a name="p3130348174917"></a><a name="p3130348174917"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="32.440000000000005%" id="mcps1.2.4.1.2"><p id="p16189172593"><a name="p16189172593"></a><a name="p16189172593"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="57.54%" id="mcps1.2.4.1.3"><p id="p191899219916"><a name="p191899219916"></a><a name="p191899219916"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row23075814814"><td class="cellrowborder" valign="top" width="10.02%" headers="mcps1.2.4.1.1 "><p id="p181301484494"><a name="p181301484494"></a><a name="p181301484494"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="32.440000000000005%" headers="mcps1.2.4.1.2 "><p id="p8308781086"><a name="p8308781086"></a><a name="p8308781086"></a>delete(rdbPredicates: RdbPredicates, callback: AsyncCallback&lt;number&gt;):void</p>
</td>
<td class="cellrowborder" valign="top" width="57.54%" headers="mcps1.2.4.1.3 "><p id="p1746563812810"><a name="p1746563812810"></a><a name="p1746563812810"></a>Deletes data based on the conditions specified by <strong id="b25823275112554"><a name="b25823275112554"></a><a name="b25823275112554"></a>RdbPredicates</strong>. This method uses a callback to return the result.</p>
<a name="ul199371937131312"></a><a name="ul199371937131312"></a><ul id="ul199371937131312"><li><strong id="b9647017192914"><a name="b9647017192914"></a><a name="b9647017192914"></a>rdbPredicates</strong>: conditions for deleting data.</li><li><strong id="b99708313304"><a name="b99708313304"></a><a name="b99708313304"></a>callback</strong>: callback invoked to return the number of rows deleted.</li></ul>
</td>
</tr>
<tr id="row124255515487"><td class="cellrowborder" valign="top" width="10.02%" headers="mcps1.2.4.1.1 "><p id="p1642575144818"><a name="p1642575144818"></a><a name="p1642575144818"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="32.440000000000005%" headers="mcps1.2.4.1.2 "><p id="p194252051194818"><a name="p194252051194818"></a><a name="p194252051194818"></a>delete(rdbPredicates: RdbPredicates): Promise</p>
</td>
<td class="cellrowborder" valign="top" width="57.54%" headers="mcps1.2.4.1.3 "><p id="p124258512483"><a name="p124258512483"></a><a name="p124258512483"></a>Deletes data based on the conditions specified by <strong id="b801327406112554"><a name="b801327406112554"></a><a name="b801327406112554"></a>RdbPredicates</strong>. This method uses a promise to return the result.</p>
<a name="ul0605102031416"></a><a name="ul0605102031416"></a><ul id="ul0605102031416"><li><strong id="b220745383116"><a name="b220745383116"></a><a name="b220745383116"></a>rdbPredicates</strong>: conditions for deleting data.</li></ul>
</td>
</tr>
</tbody>
</table>
- **Querying data**
You can query data in the RDB in either of the following ways:
- Call the **query** method to query data based on the predicates, without passing any SQL statement.
- Run the native SQL statement.
**Table 5** APIs for querying data
<a name="table1431902161617"></a>
<table><thead align="left"><tr id="row2350122161613"><th class="cellrowborder" valign="top" width="12.46%" id="mcps1.2.4.1.1"><p id="p114619172530"><a name="p114619172530"></a><a name="p114619172530"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="40.97%" id="mcps1.2.4.1.2"><p id="p163501211165"><a name="p163501211165"></a><a name="p163501211165"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="46.57%" id="mcps1.2.4.1.3"><p id="p1635118221618"><a name="p1635118221618"></a><a name="p1635118221618"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1351629160"><td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.2.4.1.1 "><p id="p314691719532"><a name="p314691719532"></a><a name="p314691719532"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="40.97%" headers="mcps1.2.4.1.2 "><p id="p1365120526456"><a name="p1365120526456"></a><a name="p1365120526456"></a>query(rdbPredicates: RdbPredicates, columns: Array, callback: AsyncCallback&lt;ResultSet&gt;): void;</p>
</td>
<td class="cellrowborder" valign="top" width="46.57%" headers="mcps1.2.4.1.3 "><p id="p854321661212"><a name="p854321661212"></a><a name="p854321661212"></a>Queries data in the database based on specified conditions. This method uses a callback to return the result.</p>
<a name="ul8744621511"></a><a name="ul8744621511"></a><ul id="ul8744621511"><li><strong id="b10609165211337"><a name="b10609165211337"></a><a name="b10609165211337"></a>rdbPredicates</strong>: conditions for querying data.</li></ul>
<a name="ul976011905112"></a><a name="ul976011905112"></a><ul id="ul976011905112"><li><strong id="b017915301348"><a name="b017915301348"></a><a name="b017915301348"></a>columns</strong>: columns to query. If this parameter is not specified, the query applies to all columns.</li><li><strong id="b45789585356"><a name="b45789585356"></a><a name="b45789585356"></a>callback</strong>: callback invoked to return the result. If the operation is successful, a <strong id="b575560452112554"><a name="b575560452112554"></a><a name="b575560452112554"></a>ResultSet</strong> object will be returned.</li></ul>
</td>
</tr>
<tr id="row156116124816"><td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.2.4.1.1 "><p id="p66112124816"><a name="p66112124816"></a><a name="p66112124816"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="40.97%" headers="mcps1.2.4.1.2 "><p id="p194111833115618"><a name="p194111833115618"></a><a name="p194111833115618"></a>query(rdbPredicates: RdbPredicates, columns: Array): Promise&lt;ResultSet&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="46.57%" headers="mcps1.2.4.1.3 "><p id="p3681422175117"><a name="p3681422175117"></a><a name="p3681422175117"></a>Queries data in the database based on specified conditions. This method uses a promise to return the result.</p>
<a name="ul882719171553"></a><a name="ul882719171553"></a><ul id="ul882719171553"><li><strong id="b42961422123414"><a name="b42961422123414"></a><a name="b42961422123414"></a>rdbPredicates</strong>: conditions for querying data.</li></ul>
<a name="ul982714175553"></a><a name="ul982714175553"></a><ul id="ul982714175553"><li><strong id="b1556413233711"><a name="b1556413233711"></a><a name="b1556413233711"></a>columns</strong>: columns to query. If this parameter is not specified, the query applies to all columns.</li></ul>
</td>
</tr>
<tr id="row196741256281"><td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.2.4.1.1 "><p id="p567445132814"><a name="p567445132814"></a><a name="p567445132814"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="40.97%" headers="mcps1.2.4.1.2 "><p id="p66741959283"><a name="p66741959283"></a><a name="p66741959283"></a>querySql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void</p>
</td>
<td class="cellrowborder" valign="top" width="46.57%" headers="mcps1.2.4.1.3 "><p id="p767418510287"><a name="p767418510287"></a><a name="p767418510287"></a>Queries data in the RDB store using the specified SQL statement. This method uses a callback to return the result.</p>
<a name="ul98232063110"></a><a name="ul98232063110"></a><ul id="ul98232063110"><li><strong id="b161631620174220"><a name="b161631620174220"></a><a name="b161631620174220"></a>sql</strong>: SQL statement.</li></ul>
<a name="ul982192010316"></a><a name="ul982192010316"></a><ul id="ul982192010316"><li><strong id="b125394844210"><a name="b125394844210"></a><a name="b125394844210"></a>bindArgs</strong>: arguments in the SQL statement.</li><li><strong id="b126351142164316"><a name="b126351142164316"></a><a name="b126351142164316"></a>callback</strong>: callback invoked to return the result. If the operation is successful, a <strong id="b1798798407112554"><a name="b1798798407112554"></a><a name="b1798798407112554"></a>ResultSet</strong> object will be returned.</li></ul>
</td>
</tr>
<tr id="row14262191015289"><td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.2.4.1.1 "><p id="p132621010122817"><a name="p132621010122817"></a><a name="p132621010122817"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="40.97%" headers="mcps1.2.4.1.2 "><p id="p5262510122817"><a name="p5262510122817"></a><a name="p5262510122817"></a>querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46.57%" headers="mcps1.2.4.1.3 "><p id="p15262131018288"><a name="p15262131018288"></a><a name="p15262131018288"></a>Queries data in the RDB store using the specified SQL statement. This method uses a promise to return the result.</p>
<a name="ul265516228313"></a><a name="ul265516228313"></a><ul id="ul265516228313"><li><strong id="b17420163394412"><a name="b17420163394412"></a><a name="b17420163394412"></a>sql</strong>: SQL statement.</li></ul>
<a name="ul36551222123116"></a><a name="ul36551222123116"></a><ul id="ul36551222123116"><li><strong id="b19751173811446"><a name="b19751173811446"></a><a name="b19751173811446"></a>bindArgs</strong>: arguments in the SQL statement.</li></ul>
</td>
</tr>
</tbody>
</table>
**Using Predicates**
The RDB provides **RdbPredicates** for you to set database operation conditions.
**Table 6** APIs for RDB predicates
<a name="table1431052112351"></a>
<table><thead align="left"><tr id="row1345821123514"><th class="cellrowborder" valign="top" width="13.850000000000001%" id="mcps1.2.4.1.1"><p id="p142295625511"><a name="p142295625511"></a><a name="p142295625511"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="39.910000000000004%" id="mcps1.2.4.1.2"><p id="p1034572111355"><a name="p1034572111355"></a><a name="p1034572111355"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="46.239999999999995%" id="mcps1.2.4.1.3"><p id="p193451621113517"><a name="p193451621113517"></a><a name="p193451621113517"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row434562114350"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p164375497585"><a name="p164375497585"></a><a name="p164375497585"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p1984411183347"><a name="p1984411183347"></a><a name="p1984411183347"></a>equalTo(field: string, value: ValueType): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p10345221143519"><a name="p10345221143519"></a><a name="p10345221143519"></a>Sets the <strong id="b438950696112554"><a name="b438950696112554"></a><a name="b438950696112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b749976932112554"><a name="b749976932112554"></a><a name="b749976932112554"></a>ValueType</strong> and value equal to the specified value.</p>
<a name="ul39107814371"></a><a name="ul39107814371"></a><ul id="ul39107814371"><li><strong id="b15195122118513"><a name="b15195122118513"></a><a name="b15195122118513"></a>field</strong>: column name in the database table.</li><li><strong id="b18580195411521"><a name="b18580195411521"></a><a name="b18580195411521"></a>value</strong>: value to match the <strong id="b119217321114"><a name="b119217321114"></a><a name="b119217321114"></a>RdbPredicates</strong>.</li><li><strong id="b82912449110"><a name="b82912449110"></a><a name="b82912449110"></a>RdbPredicates</strong>: <strong id="b20646112018129"><a name="b20646112018129"></a><a name="b20646112018129"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row734514211353"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p1221568552"><a name="p1221568552"></a><a name="p1221568552"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p7639121743518"><a name="p7639121743518"></a><a name="p7639121743518"></a>notEqualTo(field: string, value: ValueType): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1634522183511"><a name="p1634522183511"></a><a name="p1634522183511"></a>Sets the <strong id="b1712658660112554"><a name="b1712658660112554"></a><a name="b1712658660112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b726568859112554"><a name="b726568859112554"></a><a name="b726568859112554"></a>ValueType</strong> and value not equal to the specified value.</p>
<a name="ul415220710398"></a><a name="ul415220710398"></a><ul id="ul415220710398"><li><strong id="b066019819910"><a name="b066019819910"></a><a name="b066019819910"></a>field</strong>: column name in the database table.</li><li><strong id="b1810912616128"><a name="b1810912616128"></a><a name="b1810912616128"></a>value</strong>: value to match the <strong id="b1010920661216"><a name="b1010920661216"></a><a name="b1010920661216"></a>RdbPredicates</strong>.</li><li><strong id="b63152431127"><a name="b63152431127"></a><a name="b63152431127"></a>RdbPredicates</strong>: <strong id="b133155430127"><a name="b133155430127"></a><a name="b133155430127"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row634552123510"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p1523656185515"><a name="p1523656185515"></a><a name="p1523656185515"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p1629732110412"><a name="p1629732110412"></a><a name="p1629732110412"></a>beginWrap(): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1334652112353"><a name="p1334652112353"></a><a name="p1334652112353"></a>Adds a left parenthesis to the <strong id="b183257951112554"><a name="b183257951112554"></a><a name="b183257951112554"></a>RdbPredicates</strong>.</p>
<a name="ul3808195613915"></a><a name="ul3808195613915"></a><ul id="ul3808195613915"><li><strong id="b1146415308136"><a name="b1146415308136"></a><a name="b1146415308136"></a>RdbPredicates</strong>: <strong id="b145191852171313"><a name="b145191852171313"></a><a name="b145191852171313"></a>RdbPredicates</strong> with a left parenthesis.</li></ul>
</td>
</tr>
<tr id="row1034662163515"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p1223456145516"><a name="p1223456145516"></a><a name="p1223456145516"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p4253185154216"><a name="p4253185154216"></a><a name="p4253185154216"></a>endWrap(): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1634620216353"><a name="p1634620216353"></a><a name="p1634620216353"></a>Adds a right parenthesis to the <strong id="b717084362112554"><a name="b717084362112554"></a><a name="b717084362112554"></a>RdbPredicates</strong>.</p>
<a name="ul952384823816"></a><a name="ul952384823816"></a><ul id="ul952384823816"><li><strong id="b622114010147"><a name="b622114010147"></a><a name="b622114010147"></a>RdbPredicates</strong>: <strong id="b92234051419"><a name="b92234051419"></a><a name="b92234051419"></a>RdbPredicates</strong> with a right parenthesis.</li></ul>
</td>
</tr>
<tr id="row193467215353"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p1223856175513"><a name="p1223856175513"></a><a name="p1223856175513"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p782515201423"><a name="p782515201423"></a><a name="p782515201423"></a>or(): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p934672153514"><a name="p934672153514"></a><a name="p934672153514"></a>Adds the OR condition to the <strong id="b1180485437112554"><a name="b1180485437112554"></a><a name="b1180485437112554"></a>RdbPredicates</strong>.</p>
<a name="ul1431681603915"></a><a name="ul1431681603915"></a><ul id="ul1431681603915"><li><strong id="b439496101515"><a name="b439496101515"></a><a name="b439496101515"></a>RdbPredicates</strong>: <strong id="b1839456191515"><a name="b1839456191515"></a><a name="b1839456191515"></a>RdbPredicates</strong> with the OR condition.</li></ul>
</td>
</tr>
<tr id="row158263516300"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p1282615143010"><a name="p1282615143010"></a><a name="p1282615143010"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p9222442144210"><a name="p9222442144210"></a><a name="p9222442144210"></a>and(): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1388710815510"><a name="p1388710815510"></a><a name="p1388710815510"></a>Adds the AND condition to the <strong id="b257471589112554"><a name="b257471589112554"></a><a name="b257471589112554"></a>RdbPredicates</strong>.</p>
<a name="ul1727699185710"></a><a name="ul1727699185710"></a><ul id="ul1727699185710"><li><strong id="b18566227141510"><a name="b18566227141510"></a><a name="b18566227141510"></a>RdbPredicates</strong>: <strong id="b185661227171511"><a name="b185661227171511"></a><a name="b185661227171511"></a>RdbPredicates</strong> with the AND condition.</li></ul>
</td>
</tr>
<tr id="row243103215346"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p114393263410"><a name="p114393263410"></a><a name="p114393263410"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p691261154313"><a name="p691261154313"></a><a name="p691261154313"></a>contains(field: string, value: string): RdbPredicats</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p138987821811"><a name="p138987821811"></a><a name="p138987821811"></a>Sets the <strong id="b1636898418112554"><a name="b1636898418112554"></a><a name="b1636898418112554"></a>RdbPredicates</strong> to match a string containing the specified value.</p>
<a name="ul187302357573"></a><a name="ul187302357573"></a><ul id="ul187302357573"><li><strong id="b0662138791"><a name="b0662138791"></a><a name="b0662138791"></a>field</strong>: column name in the database table.</li><li><strong id="b7114767121"><a name="b7114767121"></a><a name="b7114767121"></a>value</strong>: value to match the <strong id="b611466151215"><a name="b611466151215"></a><a name="b611466151215"></a>RdbPredicates</strong>.</li><li>RdbPredicates: <strong id="b14967161332010"><a name="b14967161332010"></a><a name="b14967161332010"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row1823275015527"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p172327507529"><a name="p172327507529"></a><a name="p172327507529"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p111451435154314"><a name="p111451435154314"></a><a name="p111451435154314"></a>beginsWith(field: string, value: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p102321950135210"><a name="p102321950135210"></a><a name="p102321950135210"></a>Sets the <strong id="b895587112554"><a name="b895587112554"></a><a name="b895587112554"></a>RdbPredicates</strong> to match a string that starts with the specified value.</p>
<a name="ul3643102216597"></a><a name="ul3643102216597"></a><ul id="ul3643102216597"><li><strong id="b176634812918"><a name="b176634812918"></a><a name="b176634812918"></a>field</strong>: column name in the database table.</li><li><strong id="b91196671210"><a name="b91196671210"></a><a name="b91196671210"></a>value</strong>: value to match the <strong id="b12119865128"><a name="b12119865128"></a><a name="b12119865128"></a>RdbPredicates</strong>.</li><li><strong id="b163192043181211"><a name="b163192043181211"></a><a name="b163192043181211"></a>RdbPredicates</strong>: <strong id="b13191043101217"><a name="b13191043101217"></a><a name="b13191043101217"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row86756195213"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p566562527"><a name="p566562527"></a><a name="p566562527"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p46356185216"><a name="p46356185216"></a><a name="p46356185216"></a>endsWith(field: string, value: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1063562529"><a name="p1063562529"></a><a name="p1063562529"></a>Sets the <strong id="b1056875172112554"><a name="b1056875172112554"></a><a name="b1056875172112554"></a>RdbPredicates</strong> to match a string that ends with the specified value.</p>
<a name="ul6905132213012"></a><a name="ul6905132213012"></a><ul id="ul6905132213012"><li><strong id="b46643820919"><a name="b46643820919"></a><a name="b46643820919"></a>field</strong>: column name in the database table.</li><li><strong id="b121239671216"><a name="b121239671216"></a><a name="b121239671216"></a>value</strong>: value to match the <strong id="b912317619121"><a name="b912317619121"></a><a name="b912317619121"></a>RdbPredicates</strong>.</li><li><strong id="b103211043131213"><a name="b103211043131213"></a><a name="b103211043131213"></a>RdbPredicates</strong>: <strong id="b20321104319124"><a name="b20321104319124"></a><a name="b20321104319124"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row58214297537"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p3822152917531"><a name="p3822152917531"></a><a name="p3822152917531"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p696112904411"><a name="p696112904411"></a><a name="p696112904411"></a>isNull(field: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p2822172913538"><a name="p2822172913538"></a><a name="p2822172913538"></a>Sets the <strong id="b1194045299112554"><a name="b1194045299112554"></a><a name="b1194045299112554"></a>RdbPredicates</strong> to match the field whose value is <strong id="b1890023078112554"><a name="b1890023078112554"></a><a name="b1890023078112554"></a>null</strong>.</p>
<a name="ul152823233592"></a><a name="ul152823233592"></a><ul id="ul152823233592"><li><strong id="b206641881994"><a name="b206641881994"></a><a name="b206641881994"></a>field</strong>: column name in the database table.</li><li><strong id="b1774115571093"><a name="b1774115571093"></a><a name="b1774115571093"></a>RdbPredicates</strong>: <strong id="b18741165710911"><a name="b18741165710911"></a><a name="b18741165710911"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row9134111680"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p1513421388"><a name="p1513421388"></a><a name="p1513421388"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p08046261449"><a name="p08046261449"></a><a name="p08046261449"></a>isNotNull(field: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p7520112182316"><a name="p7520112182316"></a><a name="p7520112182316"></a>Sets the <strong id="b1059930094112554"><a name="b1059930094112554"></a><a name="b1059930094112554"></a>RdbPredicates</strong> to match the field whose value is not <strong id="b172403177112554"><a name="b172403177112554"></a><a name="b172403177112554"></a>null</strong>.</p>
<a name="ul5646142816017"></a><a name="ul5646142816017"></a><ul id="ul5646142816017"><li><strong id="b1366598494"><a name="b1366598494"></a><a name="b1366598494"></a>field</strong>: column name in the database table.</li><li><strong id="b355418851019"><a name="b355418851019"></a><a name="b355418851019"></a>RdbPredicates</strong>: <strong id="b15541983103"><a name="b15541983103"></a><a name="b15541983103"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row1543514416811"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p643516419810"><a name="p643516419810"></a><a name="p643516419810"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p15758134720442"><a name="p15758134720442"></a><a name="p15758134720442"></a>like(field: string, value: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p753485217231"><a name="p753485217231"></a><a name="p753485217231"></a>Sets the <strong id="b964300928112554"><a name="b964300928112554"></a><a name="b964300928112554"></a>RdbPredicates</strong> to match a string that is similar to the specified value.</p>
<a name="ul15439141112"></a><a name="ul15439141112"></a><ul id="ul15439141112"><li><strong id="b1366618991"><a name="b1366618991"></a><a name="b1366618991"></a>field</strong>: column name in the database table.</li><li><strong id="b11277641210"><a name="b11277641210"></a><a name="b11277641210"></a>value</strong>: value to match the <strong id="b121272065124"><a name="b121272065124"></a><a name="b121272065124"></a>RdbPredicates</strong>.</li><li><strong id="b19556158101012"><a name="b19556158101012"></a><a name="b19556158101012"></a>RdbPredicates</strong>: <strong id="b1556484106"><a name="b1556484106"></a><a name="b1556484106"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row1596914712820"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p169691871785"><a name="p169691871785"></a><a name="p169691871785"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p372713974512"><a name="p372713974512"></a><a name="p372713974512"></a>glob(field: string, value: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p14252854172320"><a name="p14252854172320"></a><a name="p14252854172320"></a>Sets the <strong id="b644369182112554"><a name="b644369182112554"></a><a name="b644369182112554"></a>RdbPredicates</strong> to match the specified string.</p>
<a name="ul18503142413115"></a><a name="ul18503142413115"></a><ul id="ul18503142413115"><li><strong id="b5667581899"><a name="b5667581899"></a><a name="b5667581899"></a>field</strong>: column name in the database table.</li><li><strong id="b10131460122"><a name="b10131460122"></a><a name="b10131460122"></a>value</strong>: value to match the <strong id="b1313176191214"><a name="b1313176191214"></a><a name="b1313176191214"></a>RdbPredicates</strong>.</li><li><strong id="b125581984106"><a name="b125581984106"></a><a name="b125581984106"></a>RdbPredicates</strong>: <strong id="b955819810103"><a name="b955819810103"></a><a name="b955819810103"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row142751730101"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p192751938103"><a name="p192751938103"></a><a name="p192751938103"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p36191533114513"><a name="p36191533114513"></a><a name="p36191533114513"></a>between(field: string, low: ValueType, high: ValueType): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1827513201020"><a name="p1827513201020"></a><a name="p1827513201020"></a>Sets the <strong id="b625856712112554"><a name="b625856712112554"></a><a name="b625856712112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b489101076112554"><a name="b489101076112554"></a><a name="b489101076112554"></a>ValueType</strong> and value within the specified range.</p>
<a name="ul3448133612117"></a><a name="ul3448133612117"></a><ul id="ul3448133612117"><li><strong id="b46682814917"><a name="b46682814917"></a><a name="b46682814917"></a>field</strong>: column name in the database table.</li><li><strong id="b062216817256"><a name="b062216817256"></a><a name="b062216817256"></a>low</strong>: minimum value that matches the <strong id="b4408649182510"><a name="b4408649182510"></a><a name="b4408649182510"></a>RdbPredicates</strong>.</li><li><strong id="b1336881318253"><a name="b1336881318253"></a><a name="b1336881318253"></a>high</strong>: maximum value that matches the <strong id="b05634512611"><a name="b05634512611"></a><a name="b05634512611"></a>RdbPredicates</strong>.</li><li><strong id="b135596841010"><a name="b135596841010"></a><a name="b135596841010"></a>RdbPredicates</strong>: <strong id="b1555913891013"><a name="b1555913891013"></a><a name="b1555913891013"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row18738551100"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p57388541019"><a name="p57388541019"></a><a name="p57388541019"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p102541595465"><a name="p102541595465"></a><a name="p102541595465"></a>notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1073914511013"><a name="p1073914511013"></a><a name="p1073914511013"></a>Sets the <strong id="b480030174112554"><a name="b480030174112554"></a><a name="b480030174112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b591370903112554"><a name="b591370903112554"></a><a name="b591370903112554"></a>ValueType</strong> and value out of the specified range.</p>
<a name="ul697416399210"></a><a name="ul697416399210"></a><ul id="ul697416399210"><li><strong id="b136681086914"><a name="b136681086914"></a><a name="b136681086914"></a>field</strong>: column name in the database table.</li><li><strong id="b4395132016267"><a name="b4395132016267"></a><a name="b4395132016267"></a>low</strong>: minimum value that matches the <strong id="b0396182092615"><a name="b0396182092615"></a><a name="b0396182092615"></a>RdbPredicates</strong>.</li><li><strong id="b16568182820262"><a name="b16568182820262"></a><a name="b16568182820262"></a>high</strong>: maximum value that matches the <strong id="b12568128132611"><a name="b12568128132611"></a><a name="b12568128132611"></a>RdbPredicates</strong>.</li><li><strong id="b25607881011"><a name="b25607881011"></a><a name="b25607881011"></a>RdbPredicates</strong>: <strong id="b256013819104"><a name="b256013819104"></a><a name="b256013819104"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row2946551141115"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p17946195191118"><a name="p17946195191118"></a><a name="p17946195191118"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p86191537184610"><a name="p86191537184610"></a><a name="p86191537184610"></a>greaterThan(field: string, value: ValueType): RdbPredicatesgr</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p129461514117"><a name="p129461514117"></a><a name="p129461514117"></a>Sets the <strong id="b299934469112554"><a name="b299934469112554"></a><a name="b299934469112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b297820682112554"><a name="b297820682112554"></a><a name="b297820682112554"></a>ValueType</strong> and value greater than the specified value.</p>
<a name="ul11811341539"></a><a name="ul11811341539"></a><ul id="ul11811341539"><li><strong id="b116691285910"><a name="b116691285910"></a><a name="b116691285910"></a>field</strong>: column name in the database table.</li><li><strong id="b7135166141214"><a name="b7135166141214"></a><a name="b7135166141214"></a>value</strong>: value to match the <strong id="b71351460123"><a name="b71351460123"></a><a name="b71351460123"></a>RdbPredicates</strong>.</li><li><strong id="b9561138131015"><a name="b9561138131015"></a><a name="b9561138131015"></a>RdbPredicates</strong>: <strong id="b1561584103"><a name="b1561584103"></a><a name="b1561584103"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row4947195461118"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p149481654191110"><a name="p149481654191110"></a><a name="p149481654191110"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p3948205414117"><a name="p3948205414117"></a><a name="p3948205414117"></a>lessThan(field: string, value: ValueType): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1150510191493"><a name="p1150510191493"></a><a name="p1150510191493"></a>Sets the <strong id="b998950278112554"><a name="b998950278112554"></a><a name="b998950278112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b1745313530112554"><a name="b1745313530112554"></a><a name="b1745313530112554"></a>ValueType</strong> and value less than the specified value.</p>
<a name="ul1641512392313"></a><a name="ul1641512392313"></a><ul id="ul1641512392313"><li><strong id="b367014815919"><a name="b367014815919"></a><a name="b367014815919"></a>field</strong>: column name in the database table.</li><li><strong id="b213966181219"><a name="b213966181219"></a><a name="b213966181219"></a>value</strong>: value to match the <strong id="b161391269123"><a name="b161391269123"></a><a name="b161391269123"></a>RdbPredicates</strong>.</li><li><strong id="b17562183104"><a name="b17562183104"></a><a name="b17562183104"></a>RdbPredicates</strong>: <strong id="b156228141013"><a name="b156228141013"></a><a name="b156228141013"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row10618151417129"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p26189149128"><a name="p26189149128"></a><a name="p26189149128"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p16430131913473"><a name="p16430131913473"></a><a name="p16430131913473"></a>greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p1496111155113"><a name="p1496111155113"></a><a name="p1496111155113"></a>Sets the <strong id="b349869843112554"><a name="b349869843112554"></a><a name="b349869843112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b634300709112554"><a name="b634300709112554"></a><a name="b634300709112554"></a>ValueType</strong> and value greater than or equal to the specified value.</p>
<a name="ul1169911541738"></a><a name="ul1169911541738"></a><ul id="ul1169911541738"><li><strong id="b86711689917"><a name="b86711689917"></a><a name="b86711689917"></a>field</strong>: column name in the database table.</li><li><strong id="b71443641215"><a name="b71443641215"></a><a name="b71443641215"></a>value</strong>: value to match the <strong id="b414420621215"><a name="b414420621215"></a><a name="b414420621215"></a>RdbPredicates</strong>.</li><li><strong id="b3563189109"><a name="b3563189109"></a><a name="b3563189109"></a>RdbPredicates</strong>: <strong id="b6563168171010"><a name="b6563168171010"></a><a name="b6563168171010"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row7691627151211"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p1969427131213"><a name="p1969427131213"></a><a name="p1969427131213"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p34348284483"><a name="p34348284483"></a><a name="p34348284483"></a>lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p12181611535"><a name="p12181611535"></a><a name="p12181611535"></a>Sets the <strong id="b312137118112554"><a name="b312137118112554"></a><a name="b312137118112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b304585139112554"><a name="b304585139112554"></a><a name="b304585139112554"></a>ValueType</strong> and value less than or equal to the specified value.</p>
<a name="ul954651146"></a><a name="ul954651146"></a><ul id="ul954651146"><li><strong id="b3672785911"><a name="b3672785911"></a><a name="b3672785911"></a>field</strong>: column name in the database table.</li><li><strong id="b14148146141213"><a name="b14148146141213"></a><a name="b14148146141213"></a>value</strong>: value to match the <strong id="b21481362121"><a name="b21481362121"></a><a name="b21481362121"></a>RdbPredicates</strong>.</li><li><strong id="b1056414811010"><a name="b1056414811010"></a><a name="b1056414811010"></a>RdbPredicates</strong>: <strong id="b20564128141016"><a name="b20564128141016"></a><a name="b20564128141016"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row131173871211"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p15110384126"><a name="p15110384126"></a><a name="p15110384126"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p12573121712492"><a name="p12573121712492"></a><a name="p12573121712492"></a>orderByAsc(field: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p31119384125"><a name="p31119384125"></a><a name="p31119384125"></a>Sets the <strong id="b688515142112554"><a name="b688515142112554"></a><a name="b688515142112554"></a>RdbPredicates</strong> to match the column with values sorted in ascending order.</p>
<a name="ul12611201211416"></a><a name="ul12611201211416"></a><ul id="ul12611201211416"><li><strong id="b20672881395"><a name="b20672881395"></a><a name="b20672881395"></a>field</strong>: column name in the database table.</li><li><strong id="b4565481101"><a name="b4565481101"></a><a name="b4565481101"></a>RdbPredicates</strong>: <strong id="b1956515816107"><a name="b1956515816107"></a><a name="b1956515816107"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row112261741171218"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p422611417127"><a name="p422611417127"></a><a name="p422611417127"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p622664161218"><a name="p622664161218"></a><a name="p622664161218"></a>orderByDesc(field: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p152261741201214"><a name="p152261741201214"></a><a name="p152261741201214"></a>Sets the <strong id="b1784358755112554"><a name="b1784358755112554"></a><a name="b1784358755112554"></a>RdbPredicates</strong> to match the column with values sorted in descending order.</p>
<a name="ul17931024747"></a><a name="ul17931024747"></a><ul id="ul17931024747"><li><strong id="b106731081197"><a name="b106731081197"></a><a name="b106731081197"></a>field</strong>: column name in the database table.</li><li><strong id="b15661871013"><a name="b15661871013"></a><a name="b15661871013"></a>RdbPredicates</strong>: <strong id="b55664821014"><a name="b55664821014"></a><a name="b55664821014"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row9961113773315"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p29616370334"><a name="p29616370334"></a><a name="p29616370334"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p9260141911516"><a name="p9260141911516"></a><a name="p9260141911516"></a>distinct(): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p79613373335"><a name="p79613373335"></a><a name="p79613373335"></a>Sets the <strong id="b1849038781112554"><a name="b1849038781112554"></a><a name="b1849038781112554"></a>RdbPredicates</strong> to filter out duplicate records.</p>
<a name="ul9247643548"></a><a name="ul9247643548"></a><ul id="ul9247643548"><li><strong id="b8216555102712"><a name="b8216555102712"></a><a name="b8216555102712"></a>RdbPredicates</strong>: <strong id="b154056214288"><a name="b154056214288"></a><a name="b154056214288"></a>RdbPredicates</strong> that can filter out duplicate records.</li></ul>
</td>
</tr>
<tr id="row117447163520"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p167444123514"><a name="p167444123514"></a><a name="p167444123514"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p1744191163517"><a name="p1744191163517"></a><a name="p1744191163517"></a>limitAs(value: number): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p167441813355"><a name="p167441813355"></a><a name="p167441813355"></a>Sets the <strong id="b1852235509112554"><a name="b1852235509112554"></a><a name="b1852235509112554"></a>RdbPredicates</strong> to specify the maximum number of records to match in a column.</p>
<a name="ul99331016519"></a><a name="ul99331016519"></a><ul id="ul99331016519"><li><strong id="b1066132843113"><a name="b1066132843113"></a><a name="b1066132843113"></a>value</strong>: maximum number of records in a column.</li><li><strong id="b2596134933112"><a name="b2596134933112"></a><a name="b2596134933112"></a>RdbPredicates</strong>: <strong id="b17201911321"><a name="b17201911321"></a><a name="b17201911321"></a>RdbPredicates</strong> that can be used to set the maximum number of records to match in a column.</li></ul>
</td>
</tr>
<tr id="row13215105816343"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p192151858183419"><a name="p192151858183419"></a><a name="p192151858183419"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p9259827135217"><a name="p9259827135217"></a><a name="p9259827135217"></a>offsetAs(rowOffset: number): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p621595810347"><a name="p621595810347"></a><a name="p621595810347"></a>Sets the <strong id="b330697748112554"><a name="b330697748112554"></a><a name="b330697748112554"></a>RdbPredicates</strong> to specify the start position of the returned result.</p>
<a name="ul16890144017919"></a><a name="ul16890144017919"></a><ul id="ul16890144017919"><li><strong id="b4801398332"><a name="b4801398332"></a><a name="b4801398332"></a>rowOffset</strong>: start position of the returned result. The value is a positive integer.</li><li><strong id="b15974182419334"><a name="b15974182419334"></a><a name="b15974182419334"></a>RdbPredicates</strong>: <strong id="b117772378336"><a name="b117772378336"></a><a name="b117772378336"></a>RdbPredicates</strong> object that specifies the start position of the returned result.</li></ul>
</td>
</tr>
<tr id="row149737835713"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p119730835711"><a name="p119730835711"></a><a name="p119730835711"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p1132724295212"><a name="p1132724295212"></a><a name="p1132724295212"></a>groupBy(fields: Array&lt;string&gt;): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p315610216119"><a name="p315610216119"></a><a name="p315610216119"></a>Sets the <strong id="b922906078112554"><a name="b922906078112554"></a><a name="b922906078112554"></a>RdbPredicates</strong> to group rows that have the same value into summary rows.</p>
<a name="ul048292611102"></a><a name="ul048292611102"></a><ul id="ul048292611102"><li><strong id="b12152152614219"><a name="b12152152614219"></a><a name="b12152152614219"></a>fields</strong>: names of the columns grouped for querying data.</li><li><strong id="b107111444315"><a name="b107111444315"></a><a name="b107111444315"></a>RdbPredicates</strong>: <strong id="b1693008184315"><a name="b1693008184315"></a><a name="b1693008184315"></a>RdbPredicates</strong> that groups rows that have the same value.</li></ul>
</td>
</tr>
<tr id="row1938314155717"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p23836465712"><a name="p23836465712"></a><a name="p23836465712"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p14827457175217"><a name="p14827457175217"></a><a name="p14827457175217"></a>indexedBy(indexName: string): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p784844513588"><a name="p784844513588"></a><a name="p784844513588"></a>Sets the <strong id="b1547335609112554"><a name="b1547335609112554"></a><a name="b1547335609112554"></a>RdbPredicates</strong> object to specify the index column.</p>
<a name="ul14142173351011"></a><a name="ul14142173351011"></a><ul id="ul14142173351011"><li><strong id="b74784474315"><a name="b74784474315"></a><a name="b74784474315"></a>indexName</strong>: name of the index column.</li><li><strong id="b8808413154415"><a name="b8808413154415"></a><a name="b8808413154415"></a>RdbPredicates</strong>: <strong id="b3808141812449"><a name="b3808141812449"></a><a name="b3808141812449"></a>RdbPredicates</strong> object that specifies the index column.</li></ul>
</td>
</tr>
<tr id="row147916365529"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p157922036145218"><a name="p157922036145218"></a><a name="p157922036145218"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p17428713185312"><a name="p17428713185312"></a><a name="p17428713185312"></a>in(field: string, value: Array&lt;ValueType&gt;): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p12468144012181"><a name="p12468144012181"></a><a name="p12468144012181"></a>Sets the <strong id="b1089824940112554"><a name="b1089824940112554"></a><a name="b1089824940112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b1982339248112554"><a name="b1982339248112554"></a><a name="b1982339248112554"></a>Array&lt;ValueType&gt;</strong> and value within the specified range.</p>
<a name="ul1261343010160"></a><a name="ul1261343010160"></a><ul id="ul1261343010160"><li><strong id="b2674281693"><a name="b2674281693"></a><a name="b2674281693"></a>field</strong>: column name in the database table.</li></ul>
<a name="ul12498383105"></a><a name="ul12498383105"></a><ul id="ul12498383105"><li><strong id="b495499154512"><a name="b495499154512"></a><a name="b495499154512"></a>value</strong>: array of <strong id="b161531382454"><a name="b161531382454"></a><a name="b161531382454"></a>ValueType</strong> to match.</li><li><strong id="b145677817100"><a name="b145677817100"></a><a name="b145677817100"></a>RdbPredicates</strong>: <strong id="b8567178151019"><a name="b8567178151019"></a><a name="b8567178151019"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
<tr id="row16668112817533"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.2.4.1.1 "><p id="p146689283532"><a name="p146689283532"></a><a name="p146689283532"></a>RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.2.4.1.2 "><p id="p74983294532"><a name="p74983294532"></a><a name="p74983294532"></a>notIn(field: string, value: Array&lt;ValueType&gt;): RdbPredicates</p>
</td>
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.2.4.1.3 "><p id="p2066842875317"><a name="p2066842875317"></a><a name="p2066842875317"></a>Sets the <strong id="b2092907677112554"><a name="b2092907677112554"></a><a name="b2092907677112554"></a>RdbPredicates</strong> to match the field with data type <strong id="b30969258112554"><a name="b30969258112554"></a><a name="b30969258112554"></a>Array&lt;ValueType&gt;</strong> and value out of the specified range.</p>
<a name="ul2699143755811"></a><a name="ul2699143755811"></a><ul id="ul2699143755811"><li><strong id="b56756812910"><a name="b56756812910"></a><a name="b56756812910"></a>field</strong>: column name in the database table.</li></ul>
<a name="ul93771585122"></a><a name="ul93771585122"></a><ul id="ul93771585122"><li><strong id="b447917884619"><a name="b447917884619"></a><a name="b447917884619"></a>value</strong>: array of <strong id="b144791884611"><a name="b144791884611"></a><a name="b144791884611"></a>ValueType</strong> to match.</li><li><strong id="b155684813104"><a name="b155684813104"></a><a name="b155684813104"></a>RdbPredicates</strong>: <strong id="b115680813101"><a name="b115680813101"></a><a name="b115680813101"></a>RdbPredicates</strong> object that matches the specified field.</li></ul>
</td>
</tr>
</tbody>
</table>
**Using the Result Set**
A result set can be regarded as rows of data in the queried results. It allows you to traverse and access the data you have queried. The following table describes the external APIs of **ResultSet**.
>![](public_sys-resources/icon-notice.gif) **NOTICE:**
>After a result set is used, you must call the **close\(\)** method to close it explicitly.
**Table 7** APIs for using the result set
<a name="table20837141217325"></a>
<table><thead align="left"><tr id="row100121314329"><th class="cellrowborder" valign="top" width="10.24%" id="mcps1.2.4.1.1"><p id="p775412912565"><a name="p775412912565"></a><a name="p775412912565"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="43.46%" id="mcps1.2.4.1.2"><p id="p191913173219"><a name="p191913173219"></a><a name="p191913173219"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="46.300000000000004%" id="mcps1.2.4.1.3"><p id="p12171318326"><a name="p12171318326"></a><a name="p12171318326"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row520911313181"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p75383261001"><a name="p75383261001"></a><a name="p75383261001"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p19210173118180"><a name="p19210173118180"></a><a name="p19210173118180"></a>goTo(offset:number): boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p9210183113187"><a name="p9210183113187"></a><a name="p9210183113187"></a>Moves the result set forwards or backwards by an offset relative to its current position.</p>
</td>
</tr>
<tr id="row71141310323"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p175442935616"><a name="p175442935616"></a><a name="p175442935616"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p1233611818317"><a name="p1233611818317"></a><a name="p1233611818317"></a>goToRow(position: number): boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p141113153210"><a name="p141113153210"></a><a name="p141113153210"></a>Moves the result set to a specified row.</p>
</td>
</tr>
<tr id="row1923137323"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p1875442945615"><a name="p1875442945615"></a><a name="p1875442945615"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p19769183218312"><a name="p19769183218312"></a><a name="p19769183218312"></a>goToNextRow(): boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p627132327"><a name="p627132327"></a><a name="p627132327"></a>Moves the result set to the next row.</p>
</td>
</tr>
<tr id="row1281316329"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p275462918568"><a name="p275462918568"></a><a name="p275462918568"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p142131311326"><a name="p142131311326"></a><a name="p142131311326"></a>goToPreviousRow(): boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p1321813143210"><a name="p1321813143210"></a><a name="p1321813143210"></a>Moves the result set to the previous row.</p>
</td>
</tr>
<tr id="row1527137326"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p137542291560"><a name="p137542291560"></a><a name="p137542291560"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p191361958746"><a name="p191361958746"></a><a name="p191361958746"></a>getColumnIndex(columnName: string): number</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p0315135329"><a name="p0315135329"></a><a name="p0315135329"></a>Obtains the column index based on the specified column name.</p>
</td>
</tr>
<tr id="row53181383215"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p3754329125618"><a name="p3754329125618"></a><a name="p3754329125618"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p119675317520"><a name="p119675317520"></a><a name="p119675317520"></a>getColumnName(columnIndex: number): string</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p4341363212"><a name="p4341363212"></a><a name="p4341363212"></a>Obtains the column name based on the specified column index.</p>
</td>
</tr>
<tr id="row153013153216"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p19754172985613"><a name="p19754172985613"></a><a name="p19754172985613"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p14878197175"><a name="p14878197175"></a><a name="p14878197175"></a>goToFirstRow(): boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p153513123219"><a name="p153513123219"></a><a name="p153513123219"></a>Checks whether the result set is located in the first row.</p>
</td>
</tr>
<tr id="row153413123212"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p137544291567"><a name="p137544291567"></a><a name="p137544291567"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p73121318325"><a name="p73121318325"></a><a name="p73121318325"></a>goToLastRow(): boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p13381311321"><a name="p13381311321"></a><a name="p13381311321"></a>Checks whether the result set is located in the last row.</p>
</td>
</tr>
<tr id="row64313153214"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p14755629205616"><a name="p14755629205616"></a><a name="p14755629205616"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p6428451185"><a name="p6428451185"></a><a name="p6428451185"></a>getString(columnIndex: number): string</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p1651713173216"><a name="p1651713173216"></a><a name="p1651713173216"></a>Obtains the values in the specified column of the current row, in strings.</p>
</td>
</tr>
<tr id="row1052133323"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p77551529175612"><a name="p77551529175612"></a><a name="p77551529175612"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p95561131987"><a name="p95561131987"></a><a name="p95561131987"></a>getBlob(columnIndex: number): Uint8Array</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p1553134322"><a name="p1553134322"></a><a name="p1553134322"></a>Obtains the values in the specified column of the current row, in a byte array.</p>
</td>
</tr>
<tr id="row95113123215"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p5755112965619"><a name="p5755112965619"></a><a name="p5755112965619"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p1426859998"><a name="p1426859998"></a><a name="p1426859998"></a>getDouble(columnIndex: number): number</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p1854135329"><a name="p1854135329"></a><a name="p1854135329"></a>Obtains the values in the specified column of the current row, in double.</p>
</td>
</tr>
<tr id="row0297182413110"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p029811248111"><a name="p029811248111"></a><a name="p029811248111"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p529822420110"><a name="p529822420110"></a><a name="p529822420110"></a>isColumnNull(columnIndex: number): boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p929814244115"><a name="p929814244115"></a><a name="p929814244115"></a>Checks whether the values in the specified column of the current row are <strong id="b1342751713112554"><a name="b1342751713112554"></a><a name="b1342751713112554"></a>null</strong>.</p>
</td>
</tr>
<tr id="row142400459115"><td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.2.4.1.1 "><p id="p12401445191113"><a name="p12401445191113"></a><a name="p12401445191113"></a>ResultSet</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.2.4.1.2 "><p id="p132401145151118"><a name="p132401145151118"></a><a name="p132401145151118"></a>close(): void</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.2.4.1.3 "><p id="p16240104519118"><a name="p16240104519118"></a><a name="p16240104519118"></a>Closes the result set.</p>
</td>
</tr>
</tbody>
</table>
**Encrypting an RDB Store**
You can encrypt an RDB store.
When creating an RDB store, you can add a key for security purposes. After that, the RDB store can be accessed only with the correct key. You can change the key but cannot delete it.
Once an RDB store is created without a key, you cannot add a key any longer.
**Table 8** APIs for changing the key
<a name="table1162415825016"></a>
<table><thead align="left"><tr id="row1262417589509"><th class="cellrowborder" valign="top" width="12.11%" id="mcps1.2.4.1.1"><p id="p15624135816506"><a name="p15624135816506"></a><a name="p15624135816506"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="44.34%" id="mcps1.2.4.1.2"><p id="p1662465812509"><a name="p1662465812509"></a><a name="p1662465812509"></a>API</p>
</th>
<th class="cellrowborder" valign="top" width="43.55%" id="mcps1.2.4.1.3"><p id="p136246584502"><a name="p136246584502"></a><a name="p136246584502"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row96251058195012"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.2.4.1.1 "><p id="p062515819502"><a name="p062515819502"></a><a name="p062515819502"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="44.34%" headers="mcps1.2.4.1.2 "><p id="p99182034195712"><a name="p99182034195712"></a><a name="p99182034195712"></a>changeEncryptKey(newEncryptKey:Uint8Array, callback: AsyncCallback&lt;number&gt;):void;</p>
</td>
<td class="cellrowborder" valign="top" width="43.55%" headers="mcps1.2.4.1.3 "><p id="p4625115845012"><a name="p4625115845012"></a><a name="p4625115845012"></a>Changes the encryption key for an RDB store. This method uses a callback to return the result. If the key is changed, <strong id="b17911183611517"><a name="b17911183611517"></a><a name="b17911183611517"></a>0</strong> is returned. Otherwise, a non-zero value is returned.</p>
</td>
</tr>
<tr id="row1662575805017"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.2.4.1.1 "><p id="p76252058165015"><a name="p76252058165015"></a><a name="p76252058165015"></a>RdbStore</p>
</td>
<td class="cellrowborder" valign="top" width="44.34%" headers="mcps1.2.4.1.2 "><p id="p1025394519554"><a name="p1025394519554"></a><a name="p1025394519554"></a>changeEncryptKey(newEncryptKey:Uint8Array): Promise&lt;number&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="43.55%" headers="mcps1.2.4.1.3 "><p id="p186252058175012"><a name="p186252058175012"></a><a name="p186252058175012"></a>Changes the encryption key for an RDB store. This method uses a promise to return the result. If the key is changed, <strong id="b4886609720"><a name="b4886609720"></a><a name="b4886609720"></a>0</strong> is returned. Otherwise, a non-zero value is returned.</p>
</td>
</tr>
</tbody>
</table>
## How to Develop<a name="section116922712311"></a>
1. Create an RDB store.
1. Configure the RDB attributes, including the name and storage mode of the database and whether it is read-only.
2. Initialize the table structure and related data in the database.
3. Create an RDB store.
The sample code is as follows:
```
import dataRdb from '@ohos.data.rdb';
const CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "name TEXT NOT NULL, " + "age INTEGER, " + "salary REAL, " + "blobType BLOB)";
const STORE_CONFIG = {name: "rdbstore.db",}
let rdbStore = await dataRdb.getRdbStore(STORE_CONFIG, 1);
await rdbStore.executeSql(CREATE_TABLE_TEST);
```
2. Insert data.
1. Create a **ValuesBucket** object to store the data you need to insert.
2. Call the **insert\(\)** method to insert data into the RDB store.
The sample code is as follows:
```
var u8 = new Uint8Array([1, 2, 3])
const valueBucket = {"name": "Tom", "age": 18, "salary": 100.5, "blobType": u8,}
let insertPromise = rdbStore.insert("test", valueBucket)
```
3. Query data.
1. Create an **RdbPredicates** object to specify query conditions.
2. Call the **query \(\)** method to query data in the RDB store.
3. Call the **ResultSet\(\)** method to obtain the query result.
The sample code is as follows:
```
let predicates = new dataRdb.RdbPredicates("test");
predicates.equalTo("name", "Tom")
let resultSet = await rdbStore.query(predicates)
resultSet.goToFirstRow()
const id = await resultSet.getLong(resultSet.getColumnIndex("id"))
const name = await resultSet.getString(resultSet.getColumnIndex("name"))
const age = await resultSet.getLong(resultSet.getColumnIndex("age"))
const salary = await resultSet.getDouble(resultSet.getColumnIndex("salary"))
const blobType = await resultSet.getBlob(resultSet.getColumnIndex("blobType"))
resultSet.close()
```
en/application-dev/database/database-relational-overview.md 0 → 100644
浏览文件 @ 5b59ac7a
# RDB Overview<a name="EN-US_TOPIC_0000001231030607"></a>
The relational database \(RDB\) manages data based on relational models. With the underlying SQLite database, the RDB provides a complete mechanism for managing local databases. To satisfy different needs in complicated scenarios, the RDB offers a series of methods for performing operations such as adding, deleting, modifying, and querying data, and supports direct execution of SQL statements.
## Basic Concepts<a name="section1063573420813"></a>
- **RDB**
A type of database based on the relational model of data. The RDB stores data in rows and columns. An RDB is also called RDB store.
- **Predicate**
A representation of the property or feature of a data entity, or the relationship between data entities. It is mainly used to define operation conditions.
- **Result set**
A set of query results used to access the data. You can access the required data in a result set in flexible modes.
- **SQLite database**
A lightweight open-source relational database management system that complies with Atomicity, Consistency, Isolation, and Durability \(ACID\).
## Working Principles<a name="section4810552814"></a>
The RDB provides a common operation interface for external systems. It uses the SQLite as the underlying persistent storage engine, which supports all SQLite database features.
**Figure 1** How RDB works<a name="fig1826214361535"></a>
![](figures/how-rdb-works.png "how-rdb-works")
## Default Settings<a name="section176091243121218"></a>
- The default database logging mode is write-ahead logging \(WAL\).
- The default database flush mode is Full mode.
- The default shared memory used by the OpenHarmony database is 2 MB.
## Constraints<a name="section929813398308"></a>
- A maximum of four connection pools can be connected to an RDB to manage read and write operations.
- To ensure data accuracy, the RDB supports only one write operation at a time.
en/application-dev/database/lightweight-data-store-development.md 0 → 100644
浏览文件 @ 5b59ac7a
# Lightweight Data Store Development<a name="EN-US_TOPIC_0000001230830543"></a>
## When to Use<a name="section13841104521714"></a>
The lightweight data store is ideal for storing lightweight and frequently used data, but not for storing a large amount of data or data with frequent changes. The application data is persistently stored on a device in the form of files. Note that the instance accessed by an application contains all data of the file. The data is always loaded to the memory of the device until the application removes it from the memory. The application can perform data operations using the **Storage** APIs.
## Available APIs<a name="section15173156141712"></a>
The lightweight data store provides applications with data processing capability and allows applications to perform lightweight data storage and query. Data is stored in key-value pairs. Keys are of the string type, and values can be of the number, string, or Boolean type.
**Creating a Storage Instance**
Create a **Storage** instance for data operations. A **Storage** instance is created after data is read from a specified file and loaded to the instance.
**Table 1** API for creating a **Storage** instance
<a name="table17310132152415"></a>
<table><thead align="left"><tr id="row93118212413"><th class="cellrowborder" valign="top" width="17.69%" id="mcps1.2.4.1.1"><p id="p031118214242"><a name="p031118214242"></a><a name="p031118214242"></a>Package Name</p>
</th>
<th class="cellrowborder" valign="top" width="28.249999999999996%" id="mcps1.2.4.1.2"><p id="p19311326245"><a name="p19311326245"></a><a name="p19311326245"></a>Method</p>
</th>
<th class="cellrowborder" valign="top" width="54.059999999999995%" id="mcps1.2.4.1.3"><p id="p1131118252418"><a name="p1131118252418"></a><a name="p1131118252418"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row38631245202910"><td class="cellrowborder" valign="top" width="17.69%" headers="mcps1.2.4.1.1 "><p id="p8365103153013"><a name="p8365103153013"></a><a name="p8365103153013"></a>ohos.data.storage</p>
</td>
<td class="cellrowborder" valign="top" width="28.249999999999996%" headers="mcps1.2.4.1.2 "><p id="p1937481213019"><a name="p1937481213019"></a><a name="p1937481213019"></a>getStorage(path: string): Promise&lt;Storage&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="54.059999999999995%" headers="mcps1.2.4.1.3 "><p id="p4311132162417"><a name="p4311132162417"></a><a name="p4311132162417"></a>Obtains the <strong id="b193911821194211"><a name="b193911821194211"></a><a name="b193911821194211"></a>Storage</strong> singleton corresponding to a file for data operations.</p>
</td>
</tr>
</tbody>
</table>
**Writing Data**
Call the **put\(\)** method to add or modify data in a **Storage** instance.
**Table 2** API for writing data
<a name="table52021841142013"></a>
<table><thead align="left"><tr id="row2202741122013"><th class="cellrowborder" valign="top" width="19.79%" id="mcps1.2.4.1.1"><p id="p12161443377"><a name="p12161443377"></a><a name="p12161443377"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="37%" id="mcps1.2.4.1.2"><p id="p172028414205"><a name="p172028414205"></a><a name="p172028414205"></a>Method</p>
</th>
<th class="cellrowborder" valign="top" width="43.21%" id="mcps1.2.4.1.3"><p id="p162020415205"><a name="p162020415205"></a><a name="p162020415205"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8203194115202"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.2.4.1.1 "><p id="p31644311712"><a name="p31644311712"></a><a name="p31644311712"></a>Storage</p>
</td>
<td class="cellrowborder" valign="top" width="37%" headers="mcps1.2.4.1.2 "><p id="p105961650131617"><a name="p105961650131617"></a><a name="p105961650131617"></a>put(key: string, value: ValueType): Promise&lt;void&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="43.21%" headers="mcps1.2.4.1.3 "><p id="p127261044489"><a name="p127261044489"></a><a name="p127261044489"></a>Writes data of the number, string, and Boolean types.</p>
</td>
</tr>
</tbody>
</table>
**Reading Data**
Call the **get\(\)** method to read data from a **Storage** instance.
**Table 3** API for reading data
<a name="table182143189350"></a>
<table><thead align="left"><tr id="row173241118123511"><th class="cellrowborder" valign="top" width="18.04%" id="mcps1.2.4.1.1"><p id="p94819229584"><a name="p94819229584"></a><a name="p94819229584"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="37.830000000000005%" id="mcps1.2.4.1.2"><p id="p18324181853514"><a name="p18324181853514"></a><a name="p18324181853514"></a>Method</p>
</th>
<th class="cellrowborder" valign="top" width="44.13%" id="mcps1.2.4.1.3"><p id="p11324131814355"><a name="p11324131814355"></a><a name="p11324131814355"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row18325141813350"><td class="cellrowborder" valign="top" width="18.04%" headers="mcps1.2.4.1.1 "><p id="p1448113223583"><a name="p1448113223583"></a><a name="p1448113223583"></a>Storage</p>
</td>
<td class="cellrowborder" valign="top" width="37.830000000000005%" headers="mcps1.2.4.1.2 "><p id="p1335031410172"><a name="p1335031410172"></a><a name="p1335031410172"></a>get(key: string, defValue: ValueType): Promise&lt;ValueType&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="44.13%" headers="mcps1.2.4.1.3 "><p id="p11862123993920"><a name="p11862123993920"></a><a name="p11862123993920"></a>Reads data of the number, string, and Boolean types.</p>
</td>
</tr>
</tbody>
</table>
**Storing Data Persistently**
Call the **flush\(\)** method to write the cached data back to its text file for persistent storage.
**Table 4** API for data persistence
<a name="table1290414100219"></a>
<table><thead align="left"><tr id="row690412101627"><th class="cellrowborder" valign="top" width="18.04%" id="mcps1.2.4.1.1"><p id="p1390414101929"><a name="p1390414101929"></a><a name="p1390414101929"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="37.830000000000005%" id="mcps1.2.4.1.2"><p id="p59045104215"><a name="p59045104215"></a><a name="p59045104215"></a>Method</p>
</th>
<th class="cellrowborder" valign="top" width="44.13%" id="mcps1.2.4.1.3"><p id="p1190416106210"><a name="p1190416106210"></a><a name="p1190416106210"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row99041710923"><td class="cellrowborder" valign="top" width="18.04%" headers="mcps1.2.4.1.1 "><p id="p7904101018217"><a name="p7904101018217"></a><a name="p7904101018217"></a>Storage</p>
</td>
<td class="cellrowborder" valign="top" width="37.830000000000005%" headers="mcps1.2.4.1.2 "><p id="p1290418101218"><a name="p1290418101218"></a><a name="p1290418101218"></a>flush(): Promise&lt;void&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="44.13%" headers="mcps1.2.4.1.3 "><p id="p1234935810316"><a name="p1234935810316"></a><a name="p1234935810316"></a>Writes data in the <strong id="b263252724411"><a name="b263252724411"></a><a name="b263252724411"></a>Storage</strong> instance back to its file through an asynchronous thread.</p>
</td>
</tr>
</tbody>
</table>
**Observing Data Changes**
Specify **StorageObserver** as the callback to subscribe to data changes. When the value of the subscribed key is changed and the **flush\(\)** method is executed, **StorageObserver** will be invoked.
**Table 5** APIs for subscribing to data changes
<a name="table6483954112110"></a>
<table><thead align="left"><tr id="row124847540217"><th class="cellrowborder" valign="top" width="17.849999999999998%" id="mcps1.2.4.1.1"><p id="p1210134212816"><a name="p1210134212816"></a><a name="p1210134212816"></a>Class</p>
</th>
<th class="cellrowborder" valign="top" width="42.34%" id="mcps1.2.4.1.2"><p id="p1848445472111"><a name="p1848445472111"></a><a name="p1848445472111"></a>Method</p>
</th>
<th class="cellrowborder" valign="top" width="39.81%" id="mcps1.2.4.1.3"><p id="p1848475414213"><a name="p1848475414213"></a><a name="p1848475414213"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row2048513546212"><td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.2.4.1.1 "><p id="p17210342586"><a name="p17210342586"></a><a name="p17210342586"></a>Storage</p>
</td>
<td class="cellrowborder" valign="top" width="42.34%" headers="mcps1.2.4.1.2 "><p id="p124859540219"><a name="p124859540219"></a><a name="p124859540219"></a>on(type: 'change', callback: Callback&lt;StorageObserver&gt;): void;</p>
</td>
<td class="cellrowborder" valign="top" width="39.81%" headers="mcps1.2.4.1.3 "><p id="p1148505452114"><a name="p1148505452114"></a><a name="p1148505452114"></a>Subscribes to data changes.</p>
</td>
</tr>
<tr id="row24851554182111"><td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.2.4.1.1 "><p id="p914241031014"><a name="p914241031014"></a><a name="p914241031014"></a>Storage</p>
</td>
<td class="cellrowborder" valign="top" width="42.34%" headers="mcps1.2.4.1.2 "><p id="p9929202151011"><a name="p9929202151011"></a><a name="p9929202151011"></a>off(type: 'change', callback: Callback&lt;StorageObserver&gt;): void;</p>
</td>
<td class="cellrowborder" valign="top" width="39.81%" headers="mcps1.2.4.1.3 "><p id="p54853548219"><a name="p54853548219"></a><a name="p54853548219"></a>Unsubscribes from data changes.</p>
</td>
</tr>
</tbody>
</table>
**Deleting Data**
Use the following APIs to delete a **Storage** instance or data file.
**Table 6** APIs for deleting data
<a name="table2445155152418"></a>
<table><thead align="left"><tr id="row164451856244"><th class="cellrowborder" valign="top" width="17.72%" id="mcps1.2.4.1.1"><p id="p8182648181513"><a name="p8182648181513"></a><a name="p8182648181513"></a>Package Name</p>
</th>
<th class="cellrowborder" valign="top" width="43.980000000000004%" id="mcps1.2.4.1.2"><p id="p184461952245"><a name="p184461952245"></a><a name="p184461952245"></a>Method</p>
</th>
<th class="cellrowborder" valign="top" width="38.3%" id="mcps1.2.4.1.3"><p id="p11446652246"><a name="p11446652246"></a><a name="p11446652246"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1644616517249"><td class="cellrowborder" valign="top" width="17.72%" headers="mcps1.2.4.1.1 "><p id="p318244815153"><a name="p318244815153"></a><a name="p318244815153"></a>ohos.data.storage</p>
</td>
<td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.2.4.1.2 "><p id="p194461457246"><a name="p194461457246"></a><a name="p194461457246"></a>deleteStorage(path: string): Promise&lt;void&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="38.3%" headers="mcps1.2.4.1.3 "><p id="p19291149141220"><a name="p19291149141220"></a><a name="p19291149141220"></a>Deletes a <strong id="b16577722115210"><a name="b16577722115210"></a><a name="b16577722115210"></a>Storage</strong> instance from the cache and deletes its file from the device.</p>
</td>
</tr>
<tr id="row64461551242"><td class="cellrowborder" valign="top" width="17.72%" headers="mcps1.2.4.1.1 "><p id="p1918314488153"><a name="p1918314488153"></a><a name="p1918314488153"></a>ohos.data.storage</p>
</td>
<td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.2.4.1.2 "><p id="p134467513248"><a name="p134467513248"></a><a name="p134467513248"></a>removeStorageFromCache(path: string): Promise&lt;void&gt;;</p>
</td>
<td class="cellrowborder" valign="top" width="38.3%" headers="mcps1.2.4.1.3 "><p id="p164461159247"><a name="p164461159247"></a><a name="p164461159247"></a>Deletes a <strong id="b12971117115417"><a name="b12971117115417"></a><a name="b12971117115417"></a>Storage</strong> instance from the cache to release memory.</p>
</td>
</tr>
</tbody>
</table>
## How to Develop<a name="section146940394256"></a>
1. Import **@ohos.data.storage** and related modules to the development environment.
```
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility' // Used to obtain the file storage path.
```
2. Create a **Storage** instance.
Read the specified file and load its data to the **Storage** instance for data operations.
```
var context = featureAbility.getContext()
var path = await context.getFilesDir()
let promise = dataStorage.getStorage(path + '/mystore')
```
1. Write data.
Use the **put\(\)** method of the **Storage** class to write data to the cached **Storage** instance.
```
promise.then((storage) => {
let getPromise = storage.put('startup', 'auto') // Save data to the Storage instance.
getPromise.then(() => {
console.info("Put the value of startup successfully.")
}).catch((err) => {
console.info("Put the value of startup failed with err: " + err)
})
}).catch((err) => {
console.info("Get the storage failed")
})
```
1. Read data.
Use the **get\(\)** method of the **Storage** class to read data.
```
promise.then((storage) => {
let getPromise = storage.get('startup', 'default')
getPromise.then((value) => {
console.info("The value of startup is " + value)
}).catch((err) => {
console.info("Get the value of startup failed with err: " + err)
})
}).catch((err) => {
console.info("Get the storage failed")
})
```
1. Store data persistently.
Use the **flush** or **flushSync** method to flush data in the **Storage** instance to its file.
```
storage.flush();
```
2. Observe data changes.
Specify **StorageObserver** as the callback to subscribe to data changes for an application. When the value of the subscribed key is changed and the **flush\(\)** method is executed, **StorageObserver** will be invoked. Unregister the **StorageObserver** when it is no longer required.
```
promise.then((storage) => {
var observer = function (key) {
console.info("The key of " + key + " changed.")
}
storage.on('change', observer)
storage.putSync('startup', 'auto') // Modify data in the Storage instance.
storage.flushSync() // Trigger the StorageObserver callback.
storage.off(...change..., observer) // Unsubscribe from the data changes.
}).catch((err) => {
console.info("Get the storage failed")
})
```
1. Delete the specified file.
Use the **deleteStorage** method to delete the **Storage** singleton of the specified file from the memory, and delete the specified file, its backup file, and damaged files. After the specified files are deleted, the application cannot use that instance to perform any data operation. Otherwise, data inconsistency will occur. The deleted data and files cannot be restored.
```
let promise = dataStorage.deleteStorage(path + '/mystore')
promise.then(() => {
console.info("Deleted successfully.")
}).catch((err) => {
console.info("Deleted failed with err: " + err)
})
```
en/application-dev/database/lightweight-data-store-overview.md 0 → 100644
浏览文件 @ 5b59ac7a
# Lightweight Data Store Overview<a name="EN-US_TOPIC_0000001230752103"></a>
Lightweight data store is applicable to access and persistence operations on the data in key-value pairs. When an application accesses a lightweight **Storage** instance, data in the **Storage** instance will be cached in the memory for faster access. The cached data can also be written back to the text file for persistent storage. Since file read and write consume system resources, you are advised to minimize the frequency of reading and writing persistent files.
## Basic Concepts<a name="section1055404171115"></a>
- **Key-Value data structure**
A type of data structure. The key is the unique identifier for a piece of data, and the value is the specific data being identified.
- **Non-relational database**
A database not in compliance with the atomicity, consistency, isolation, and durability \(ACID\) database management properties of relational data transactions. The data in a non-relational database is independent.
## Working Principles<a name="section682631371115"></a>
1. When an application loads data from a specified **Storage** file to a **Storage** instance, the system stores the instance in the memory through a static container. Each file of an application or process has only one **Storage** instance in the memory, till the application removes the instance from the memory or deletes the **Storage** file.
2. When obtaining a **Storage** instance, the application can read data from or write data to the instance. The data in the **Storage** instance can be flushed to its **Storage** file by calling the **flush** or **flushSync** method.
**Figure 1** How lightweight data store works<a name="fig1657785713509"></a>
![](figures/en-us_image_0000001199139454.png)
## Constraints<a name="section17243172883219"></a>
- **Storage** instances are loaded to the memory. To minimize non-memory overhead, the number of data records stored in a **Storage** instance cannot exceed 10,000. Delete the instances that are no longer used in a timely manner.
- The key in the key-value pairs is of the string type. It cannot be empty or exceed 80 characters.
- If the value in the key-value pairs is of the string type, it can be empty or contain a maximum of 8192 characters.
en/application-dev/reference/apis/Readme-EN.md
浏览文件 @ 5b59ac7a
...@@ -9,6 +9,7 @@ ...@@ -9,6 +9,7 @@
- Event Notification - Event Notification
- [CommonEvent Module](js-apis-commonEvent.md) - [CommonEvent Module](js-apis-commonEvent.md)
- [Notification Module](js-apis-notification.md) - [Notification Module](js-apis-notification.md)
- [Reminder Agent](js-apis-reminderAgent.md)
- Resource Management - Resource Management
- [Resource Manager](js-apis-resource-manager.md) - [Resource Manager](js-apis-resource-manager.md)
- [Internationalization \(intl\) ](js-apis-intl.md) - [Internationalization \(intl\) ](js-apis-intl.md)
...@@ -63,6 +64,9 @@ ...@@ -63,6 +64,9 @@
- Language Base Class Library - Language Base Class Library
- [Obtaining Process Information](js-apis-process.md) - [Obtaining Process Information](js-apis-process.md)
- [URL String Parsing](js-apis-url.md) - [URL String Parsing](js-apis-url.md)
- [URI String Parsing](js-apis-uri.md)
- [Util](js-apis-util.md) - [Util](js-apis-util.md)
- [XML Parsing and Generation](js-apis-xml.md)
- [XML-to-JavaScript Conversion](js-apis-convertxml.md)
- [Worker Startup](js-apis-worker.md) - [Worker Startup](js-apis-worker.md)
en/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ 5b59ac7a
# Context Module # Context Module
## Applicable Devices
| API | Phone| Tablet| Smart TV| Wearable| Lite Wearable| SmartVision Device|
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| Context.getOrCreateLocalDir(callback: AsyncCallback\<string>) | Yes| Yes| Yes| Yes| No| No|
| Context.getOrCreateLocalDir() | Yes| Yes| Yes| Yes| No| No|
| Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>) | Yes| Yes| Yes| Yes| No| No|
| Context.verifyPermission(permission: string, callback: AsyncCallback\<number>) | Yes| Yes| Yes| Yes| No| No|
| Context.verifyPermission(permission: string, options?: PermissionOptions) | Yes| Yes| Yes| Yes| No| No|
| Context.requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback\<PermissionRequestResult>) | Yes| Yes| Yes| Yes| No| No|
| Context.getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>) | Yes| Yes| Yes| Yes| No| No|
| Context.getApplicationInfo() | Yes| Yes| Yes| Yes| No| No|
| Context.getBundleName(callback: AsyncCallback\<string>) | Yes| Yes| Yes| Yes| No| No|
| Context.getBundleName() | Yes| Yes| Yes| Yes| No| No|
| Context.getProcessInfo(callback: AsyncCallback\<ProcessInfo>) | Yes| Yes| Yes| Yes| No| No|
| Context.getProcessInfo() | Yes| Yes| Yes| Yes| No| No|
| Context.getElementName(callback: AsyncCallback\<ElementName>) | Yes| Yes| Yes| Yes| No| No|
| Context.getElementName() | Yes| Yes| Yes| Yes| No| No|
| Context.getProcessName(callback: AsyncCallback\<string>) | Yes| Yes| Yes| Yes| No| No|
| Context.getProcessName() | Yes| Yes| Yes| Yes| No| No|
| Context.getCallingBundle(callback: AsyncCallback\<string>) | Yes| Yes| Yes| Yes| No| No|
| Context.getCallingBundle() | Yes| Yes| Yes| Yes| No| No|
## Modules to Import ## Modules to Import
```js ```js
......
en/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ 5b59ac7a
...@@ -3,17 +3,6 @@ ...@@ -3,17 +3,6 @@
**Note:** **Note:**
The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Applicable Devices
| API | Phone| Tablet| Smart TV| Wearable| Lite Wearable|
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- |
| CommonEvent.publish(event: string, callback: AsyncCallback\<void>) | Yes| Yes| Yes| Yes| No|
| CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>) | Yes| Yes| Yes| Yes| No|
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>) | Yes| Yes| Yes| Yes| No|
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) | Yes| Yes| Yes| Yes| No|
| CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>) | Yes| Yes| Yes| Yes| No|
| CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>) | Yes| Yes| Yes| Yes| No|
## Required Permissions ## Required Permissions
| Common Event Macro| Common Event Name| Subscriber Permissions| | Common Event Macro| Common Event Name| Subscriber Permissions|
......
en/application-dev/reference/apis/js-apis-convertxml.md 0 → 100644
浏览文件 @ 5b59ac7a
# XML-to-JavaScript Conversion<a name="EN-US_TOPIC_0000001196742158"></a>
>![](public_sys-resources/icon-note.gif) **NOTE:**
>The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
```
import convertxml from '@ohos.convertxml';
```
## Required Permissions<a name="section11257113618419"></a>
None
## ConvertXML<a name="section143808167355"></a>
### convert<a name="section518224213325"></a>
convert\(xml: string, options?: ConvertOptions\) : Object
Converts an XML text into a JavaScript object.
- Parameters
<a name="table114831131512"></a>
<table><thead align="left"><tr id="row914851141517"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p214819113159"><a name="p214819113159"></a><a name="p214819113159"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p1214921121519"><a name="p1214921121519"></a><a name="p1214921121519"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p11491711141512"><a name="p11491711141512"></a><a name="p11491711141512"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p171491011171512"><a name="p171491011171512"></a><a name="p171491011171512"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row91491211131519"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p114158183811"><a name="p114158183811"></a><a name="p114158183811"></a>xml</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1114918116154"><a name="p1114918116154"></a><a name="p1114918116154"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p314916118154"><a name="p314916118154"></a><a name="p314916118154"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p814951171516"><a name="p814951171516"></a><a name="p814951171516"></a>XML text to convert.</p>
</td>
</tr>
<tr id="row5149511191511"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p161491511151511"><a name="p161491511151511"></a><a name="p161491511151511"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p15196201663916"><a name="p15196201663916"></a><a name="p15196201663916"></a><a href="#section843574515413">ConvertOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p61491811131518"><a name="p61491811131518"></a><a name="p61491811131518"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p17372181015412"><a name="p17372181015412"></a><a name="p17372181015412"></a>Settings of the convert operation.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table115061181517"></a>
<table><thead align="left"><tr id="row1150161121510"><th class="cellrowborder" valign="top" width="17.01%" id="mcps1.1.3.1.1"><p id="p1015015113159"><a name="p1015015113159"></a><a name="p1015015113159"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="82.99%" id="mcps1.1.3.1.2"><p id="p2150211201512"><a name="p2150211201512"></a><a name="p2150211201512"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row17150811131514"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p1150161110157"><a name="p1150161110157"></a><a name="p1150161110157"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p51501611141518"><a name="p51501611141518"></a><a name="p51501611141518"></a>JavaScript object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var xml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
' <title>Happy</title>' +
' <todo>Work</todo>' +
' <todo>Play</todo>' +
'</note>';
var conv = new convertxml.ConvertXML();
var result1 = conv.convert(xml, {trim: false, ignoreDeclaration: false});
console.log(result1)
```
## ConvertOptions<a name="section843574515413"></a>
<a name="table468420114018"></a>
<table><thead align="left"><tr id="row1768412134017"><th class="cellrowborder" valign="top" width="17.549999999999997%" id="mcps1.1.5.1.1"><p id="p86842124013"><a name="p86842124013"></a><a name="p86842124013"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="16.03%" id="mcps1.1.5.1.2"><p id="p16848194014"><a name="p16848194014"></a><a name="p16848194014"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="11.16%" id="mcps1.1.5.1.3"><p id="p146848118406"><a name="p146848118406"></a><a name="p146848118406"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="55.26%" id="mcps1.1.5.1.4"><p id="p66848113409"><a name="p66848113409"></a><a name="p66848113409"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row96841013407"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p1285031713269"><a name="p1285031713269"></a><a name="p1285031713269"></a>trim</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p368421104017"><a name="p368421104017"></a><a name="p368421104017"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p17684818404"><a name="p17684818404"></a><a name="p17684818404"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p9845227114216"><a name="p9845227114216"></a><a name="p9845227114216"></a>Whether to trim the whitespace characters before and after the text. The default value is <strong id="b6928115525311"><a name="b6928115525311"></a><a name="b6928115525311"></a>false</strong>.</p>
</td>
</tr>
<tr id="row13751843114014"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p11938165615400"><a name="p11938165615400"></a><a name="p11938165615400"></a>ignoreDeclaration</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p67614394017"><a name="p67614394017"></a><a name="p67614394017"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p1676154394020"><a name="p1676154394020"></a><a name="p1676154394020"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p4833610345"><a name="p4833610345"></a><a name="p4833610345"></a>Whether to ignore the XML declaration. The default value is <strong id="b1986182720517"><a name="b1986182720517"></a><a name="b1986182720517"></a>false</strong>.</p>
</td>
</tr>
<tr id="row7473642142619"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p134733429261"><a name="p134733429261"></a><a name="p134733429261"></a>ignoreInstruction</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p1922562513291"><a name="p1922562513291"></a><a name="p1922562513291"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p10671250142915"><a name="p10671250142915"></a><a name="p10671250142915"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p142083683419"><a name="p142083683419"></a><a name="p142083683419"></a>Whether to ignore the XML processing instruction. The default value is <strong id="b9507112714198"><a name="b9507112714198"></a><a name="b9507112714198"></a>false</strong>.</p>
</td>
</tr>
<tr id="row3747194620264"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p12748134611264"><a name="p12748134611264"></a><a name="p12748134611264"></a>ignoreAttributes</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p1624022512911"><a name="p1624022512911"></a><a name="p1624022512911"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p107925092913"><a name="p107925092913"></a><a name="p107925092913"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p15291036153412"><a name="p15291036153412"></a><a name="p15291036153412"></a>Whether to print attributes across multiple lines and indent attributes. The default value is <strong id="b214910972014"><a name="b214910972014"></a><a name="b214910972014"></a>false</strong>.</p>
</td>
</tr>
<tr id="row42161882710"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p42141812713"><a name="p42141812713"></a><a name="p42141812713"></a>ignoreComment</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p152529252294"><a name="p152529252294"></a><a name="p152529252294"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p209114502296"><a name="p209114502296"></a><a name="p209114502296"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p8391736163418"><a name="p8391736163418"></a><a name="p8391736163418"></a>Whether to ignore element comments. The default value is <strong id="b12921132182012"><a name="b12921132182012"></a><a name="b12921132182012"></a>false</strong>.</p>
</td>
</tr>
<tr id="row147582020279"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p12476720122715"><a name="p12476720122715"></a><a name="p12476720122715"></a>ignoreCDATA</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p11264112552918"><a name="p11264112552918"></a><a name="p11264112552918"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p11102115013297"><a name="p11102115013297"></a><a name="p11102115013297"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p28461623102316"><a name="p28461623102316"></a><a name="p28461623102316"></a>Whether to ignore the element's CDATA information. The default value is <strong id="b8400141332617"><a name="b8400141332617"></a><a name="b8400141332617"></a>false</strong>.</p>
</td>
</tr>
<tr id="row36451623142711"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p464642310271"><a name="p464642310271"></a><a name="p464642310271"></a>ignoreDoctype</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p19275172515291"><a name="p19275172515291"></a><a name="p19275172515291"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p811405092919"><a name="p811405092919"></a><a name="p811405092919"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p462436183414"><a name="p462436183414"></a><a name="p462436183414"></a>Whether to ignore the element's <strong id="b1644365410213"><a name="b1644365410213"></a><a name="b1644365410213"></a>Doctype</strong> information. The default value is <strong id="b38201991221"><a name="b38201991221"></a><a name="b38201991221"></a>false</strong>.</p>
</td>
</tr>
<tr id="row156014265276"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p760132618270"><a name="p760132618270"></a><a name="p760132618270"></a>ignoreText</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p12286925122914"><a name="p12286925122914"></a><a name="p12286925122914"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p812517503295"><a name="p812517503295"></a><a name="p812517503295"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p67643663417"><a name="p67643663417"></a><a name="p67643663417"></a>Whether to ignore the element's text information. The default value is <strong id="b21731940182214"><a name="b21731940182214"></a><a name="b21731940182214"></a>false</strong>.</p>
</td>
</tr>
<tr id="row19613162818273"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p1361314282278"><a name="p1361314282278"></a><a name="p1361314282278"></a>declarationKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p9757637182919"><a name="p9757637182919"></a><a name="p9757637182919"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p1414014508297"><a name="p1414014508297"></a><a name="p1414014508297"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p1461412852710"><a name="p1461412852710"></a><a name="p1461412852710"></a>Name of the attribute key for <strong id="b7197102842416"><a name="b7197102842416"></a><a name="b7197102842416"></a>declaration</strong> in the output object. The default value is <strong id="b92387720242"><a name="b92387720242"></a><a name="b92387720242"></a>_declaration</strong>.</p>
</td>
</tr>
<tr id="row14361103817276"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p1736123832715"><a name="p1736123832715"></a><a name="p1736123832715"></a>instructionKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p11770173719299"><a name="p11770173719299"></a><a name="p11770173719299"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p41521150152912"><a name="p41521150152912"></a><a name="p41521150152912"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p336283815279"><a name="p336283815279"></a><a name="p336283815279"></a>Name of the attribute key for <strong id="b978125313248"><a name="b978125313248"></a><a name="b978125313248"></a>instruction</strong> in the output object. The default value is <strong id="b2459142611"><a name="b2459142611"></a><a name="b2459142611"></a>_instruction</strong>.</p>
</td>
</tr>
<tr id="row154132912288"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p7414898284"><a name="p7414898284"></a><a name="p7414898284"></a>attributesKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p8780133711290"><a name="p8780133711290"></a><a name="p8780133711290"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p121661150172920"><a name="p121661150172920"></a><a name="p121661150172920"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p7608142813588"><a name="p7608142813588"></a><a name="p7608142813588"></a>Name of the attribute key for <strong id="b9204185112618"><a name="b9204185112618"></a><a name="b9204185112618"></a>attributes</strong> in the output object. The default value is <strong id="b392414585262"><a name="b392414585262"></a><a name="b392414585262"></a>_attributes</strong>.</p>
</td>
</tr>
<tr id="row376713618283"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p1676846172816"><a name="p1676846172816"></a><a name="p1676846172816"></a>textKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p117908373291"><a name="p117908373291"></a><a name="p117908373291"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p217819501294"><a name="p217819501294"></a><a name="p217819501294"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p0344122145814"><a name="p0344122145814"></a><a name="p0344122145814"></a>Name of the attribute key for <strong id="b851743532718"><a name="b851743532718"></a><a name="b851743532718"></a>text</strong> in the output object. The default value is <strong id="b350917477273"><a name="b350917477273"></a><a name="b350917477273"></a>_text</strong>.</p>
</td>
</tr>
<tr id="row15340164284"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p353512166284"><a name="p353512166284"></a><a name="p353512166284"></a>cdataKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p1879923716291"><a name="p1879923716291"></a><a name="p1879923716291"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p20192150122911"><a name="p20192150122911"></a><a name="p20192150122911"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p475618155581"><a name="p475618155581"></a><a name="p475618155581"></a>Name of the attribute key for <strong id="b26841859132720"><a name="b26841859132720"></a><a name="b26841859132720"></a>CDATA</strong> in the output object. The default value is <strong id="b1586013185285"><a name="b1586013185285"></a><a name="b1586013185285"></a>_cdata</strong>.</p>
</td>
</tr>
<tr id="row15657131913280"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p0657619172820"><a name="p0657619172820"></a><a name="p0657619172820"></a>doctypeKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p1981023772916"><a name="p1981023772916"></a><a name="p1981023772916"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p820416508292"><a name="p820416508292"></a><a name="p820416508292"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p0979042154918"><a name="p0979042154918"></a><a name="p0979042154918"></a>Name of the attribute key for <strong id="b34439596306"><a name="b34439596306"></a><a name="b34439596306"></a>Doctype</strong> in the output object. The default value is <strong id="b022043913329"><a name="b022043913329"></a><a name="b022043913329"></a>_doctype</strong>.</p>
</td>
</tr>
<tr id="row1537652212285"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p53761822172816"><a name="p53761822172816"></a><a name="p53761822172816"></a>commentKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p14821103792913"><a name="p14821103792913"></a><a name="p14821103792913"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p1621525019292"><a name="p1621525019292"></a><a name="p1621525019292"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p748535519570"><a name="p748535519570"></a><a name="p748535519570"></a>Name of the attribute key for <strong id="b12533205423211"><a name="b12533205423211"></a><a name="b12533205423211"></a>comment</strong> in the output object. The default value is <strong id="b105967633313"><a name="b105967633313"></a><a name="b105967633313"></a>_comment</strong>.</p>
</td>
</tr>
<tr id="row1477410253283"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p577414255288"><a name="p577414255288"></a><a name="p577414255288"></a>parentKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p188311537202915"><a name="p188311537202915"></a><a name="p188311537202915"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p22272050172916"><a name="p22272050172916"></a><a name="p22272050172916"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p1599716428492"><a name="p1599716428492"></a><a name="p1599716428492"></a>Name of the attribute key for <strong id="b18469936103317"><a name="b18469936103317"></a><a name="b18469936103317"></a>parent</strong> in the output object. The default value is <strong id="b5277443163312"><a name="b5277443163312"></a><a name="b5277443163312"></a>_parent</strong>.</p>
</td>
</tr>
<tr id="row149011555192811"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p49016556281"><a name="p49016556281"></a><a name="p49016556281"></a>typeKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p483913752918"><a name="p483913752918"></a><a name="p483913752918"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p1723965042916"><a name="p1723965042916"></a><a name="p1723965042916"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p1568738115715"><a name="p1568738115715"></a><a name="p1568738115715"></a>Name of the attribute key for <strong id="b562120374361"><a name="b562120374361"></a><a name="b562120374361"></a>type</strong> in the output object. The default value is <strong id="b1182815436368"><a name="b1182815436368"></a><a name="b1182815436368"></a>_type</strong>.</p>
</td>
</tr>
<tr id="row8724165922815"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p7724459112819"><a name="p7724459112819"></a><a name="p7724459112819"></a>nameKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p584703718296"><a name="p584703718296"></a><a name="p584703718296"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p3664145120292"><a name="p3664145120292"></a><a name="p3664145120292"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p159295216567"><a name="p159295216567"></a><a name="p159295216567"></a>Name of the attribute key for <strong id="b959742613717"><a name="b959742613717"></a><a name="b959742613717"></a>name</strong> in the output object. The default value is <strong id="b2605034203717"><a name="b2605034203717"></a><a name="b2605034203717"></a>_name</strong>.</p>
</td>
</tr>
<tr id="row939021212917"><td class="cellrowborder" valign="top" width="17.549999999999997%" headers="mcps1.1.5.1.1 "><p id="p17390161272918"><a name="p17390161272918"></a><a name="p17390161272918"></a>elementsKey</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.1.5.1.2 "><p id="p168568373295"><a name="p168568373295"></a><a name="p168568373295"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.1.5.1.3 "><p id="p36771451152914"><a name="p36771451152914"></a><a name="p36771451152914"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="55.26%" headers="mcps1.1.5.1.4 "><p id="p62794384910"><a name="p62794384910"></a><a name="p62794384910"></a>Name of the attribute key for <strong id="b116698498376"><a name="b116698498376"></a><a name="b116698498376"></a>elements</strong> in the output object. The default value is <strong id="b1054145814374"><a name="b1054145814374"></a><a name="b1054145814374"></a>_elements</strong>.</p>
</td>
</tr>
</tbody>
</table>
en/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @ 5b59ac7a
### DataAbilityHelper Module (JavaScript SDK APIs) # DataAbilityHelper Module (JavaScript SDK APIs)
#### Applicable Devices
| API | Phone| Tablet| Smart TV| Wearable| Lite Wearable| SmartVision Device|
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| DataAbilityHelper.openFile(uri: string, mode: string, callback: AsyncCallback\<number>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.openFile(uri: string, mode: string) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.getType(uri: string, callback: AsyncCallback\<string>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.getType(uri: string) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.normalizeUri(uri: string, callback: AsyncCallback\<string>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.normalizeUri(uri: string) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.denormalizeUri(uri: string, callback: AsyncCallback\<string>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.denormalizeUri(uri: string) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.notifyChange(uri: string, callback: AsyncCallback\<void>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.notifyChange(uri: string) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>) | Yes| Yes| Yes| Yes| No| No|
| DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates) | Yes| Yes| Yes| Yes| No| No|
#### Modules to Import #### Modules to Import
......
en/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @ 5b59ac7a
# FeatureAbility Module (JavaScript) # FeatureAbility Module (JavaScript)
#### Applicable Devices
| API | Phone| Tablet| Smart TV| Wearable| Lite Wearable| SmartVision Device|
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.startAbility(parameter: StartAbilityParameter): Promise\<number> | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult> | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.terminateSelfWithResult(parameter: AbilityResult): Promise\<void> | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>): void | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.hasWindowFocus(): Promise\<boolean> | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.getWant(callback: AsyncCallback\<Want>) | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.getWant(): void | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.getContext(): Context | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.terminateSelf(callback: AsyncCallback\<void>): void | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.terminateSelf(): Promise\<void> | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.connectAbility(request: Want, options:ConnectOptions): number | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void | Yes| Yes| Yes| Yes| No| No|
| FeatureAbility.disconnectAbility(connection: number): Promise\<void> | Yes| Yes| Yes| Yes| No| No|
#### Constraints #### Constraints
APIs of the **FeatureAbility** module can be called only by Page abilities. APIs of the **FeatureAbility** module can be called only by Page abilities.
......
en/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @ 5b59ac7a
# Internationalization \(i18n\) <a name="EN-US_TOPIC_0000001155058572"></a> # Internationalization (i18n)<a name="EN-US_TOPIC_0000001222383529"></a>
>![](../../public_sys-resources/icon-note.gif) **NOTE:** >![](../../public_sys-resources/icon-note.gif) **NOTE:**
>- The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. >- The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>- This module contains enhanced i18n APIs, which are not defined in ECMA 402. >- This module contains enhanced i18n APIs, which are not defined in ECMA 402.
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a> ## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
``` ```
...@@ -24,6 +24,7 @@ Obtains the localized script for the specified language. ...@@ -24,6 +24,7 @@ Obtains the localized script for the specified language.
- Parameters - Parameters
<a name="table8262171319013"></a> <a name="table8262171319013"></a>
<table><thead align="left"><tr id="row726281313010"><th class="cellrowborder" valign="top" width="14.92%" id="mcps1.1.5.1.1"><p id="p426217131016"><a name="p426217131016"></a><a name="p426217131016"></a>Name</p> <table><thead align="left"><tr id="row726281313010"><th class="cellrowborder" valign="top" width="14.92%" id="mcps1.1.5.1.1"><p id="p426217131016"><a name="p426217131016"></a><a name="p426217131016"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="11.5%" id="mcps1.1.5.1.2"><p id="p42622131804"><a name="p42622131804"></a><a name="p42622131804"></a>Type</p> <th class="cellrowborder" valign="top" width="11.5%" id="mcps1.1.5.1.2"><p id="p42622131804"><a name="p42622131804"></a><a name="p42622131804"></a>Type</p>
...@@ -163,6 +164,58 @@ Obtains the localized script for the specified country. ...@@ -163,6 +164,58 @@ Obtains the localized script for the specified country.
``` ```
## i18n.isRTL<sup>8+</sup><a name="section192634363279"></a>
isRTL\(locale: string\): boolean
Checks whether the localized script for the specified language is displayed from right to left.
- Parameters
<a name="table7263153692718"></a>
<table><thead align="left"><tr id="row1226353614278"><th class="cellrowborder" valign="top" width="16.13%" id="mcps1.1.4.1.1"><p id="p17263103682718"><a name="p17263103682718"></a><a name="p17263103682718"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="12.44%" id="mcps1.1.4.1.2"><p id="p13263153682713"><a name="p13263153682713"></a><a name="p13263153682713"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="71.43%" id="mcps1.1.4.1.3"><p id="p7263536162720"><a name="p7263536162720"></a><a name="p7263536162720"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8263136142717"><td class="cellrowborder" valign="top" width="16.13%" headers="mcps1.1.4.1.1 "><p id="p11263103682713"><a name="p11263103682713"></a><a name="p11263103682713"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="12.44%" headers="mcps1.1.4.1.2 "><p id="p626313692711"><a name="p626313692711"></a><a name="p626313692711"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="71.43%" headers="mcps1.1.4.1.3 "><p id="p82641036162710"><a name="p82641036162710"></a><a name="p82641036162710"></a>Locale ID.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table826516366273"></a>
<table><thead align="left"><tr id="row6265143616271"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p626533612715"><a name="p626533612715"></a><a name="p626533612715"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p1026563682714"><a name="p1026563682714"></a><a name="p1026563682714"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row22651136172714"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1326573610275"><a name="p1326573610275"></a><a name="p1326573610275"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p1426512364278"><a name="p1426512364278"></a><a name="p1426512364278"></a>The value <strong id="b19401141034713"><a name="b19401141034713"></a><a name="b19401141034713"></a>true</strong> indicates that the localized script is displayed from right to left, and value <strong id="b1140191054710"><a name="b1140191054710"></a><a name="b1140191054710"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
i18n.isRTL("zh-CN");// Since Chinese is not written from right to left, false is returned.
i18n.isRTL("ar-EG");// Since Arabic is written from right to left, true is returned.
```
## i18n.getSystemLanguage<a name="section25111622174311"></a> ## i18n.getSystemLanguage<a name="section25111622174311"></a>
getSystemLanguage\(\): string getSystemLanguage\(\): string
...@@ -253,3 +306,2086 @@ Obtains the system locale. ...@@ -253,3 +306,2086 @@ Obtains the system locale.
``` ```
## i18n.getCalendar<sup>8+</sup><a name="section735791310514"></a>
getCalendar\(locale: string, type? : string\): Calendar
Obtains a **Calendar** object.
- Parameters
<a name="table33577139517"></a>
<table><thead align="left"><tr id="row1835791317513"><th class="cellrowborder" valign="top" width="14.918508149185081%" id="mcps1.1.5.1.1"><p id="p17357913125116"><a name="p17357913125116"></a><a name="p17357913125116"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="11.498850114988501%" id="mcps1.1.5.1.2"><p id="p3357171316511"><a name="p3357171316511"></a><a name="p3357171316511"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.519248075192481%" id="mcps1.1.5.1.3"><p id="p1521711445145"><a name="p1521711445145"></a><a name="p1521711445145"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="66.06339366063393%" id="mcps1.1.5.1.4"><p id="p2357813165115"><a name="p2357813165115"></a><a name="p2357813165115"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row16358101325118"><td class="cellrowborder" valign="top" width="14.918508149185081%" headers="mcps1.1.5.1.1 "><p id="p173582131516"><a name="p173582131516"></a><a name="p173582131516"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="11.498850114988501%" headers="mcps1.1.5.1.2 "><p id="p335881385113"><a name="p335881385113"></a><a name="p335881385113"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="p4217144411145"><a name="p4217144411145"></a><a name="p4217144411145"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="66.06339366063393%" headers="mcps1.1.5.1.4 "><p id="p23582134513"><a name="p23582134513"></a><a name="p23582134513"></a>Valid locale value, for example, <strong id="b1219551917559"><a name="b1219551917559"></a><a name="b1219551917559"></a>zh-Hans-CN</strong>.</p>
</td>
</tr>
<tr id="row408511276"><td class="cellrowborder" valign="top" width="14.918508149185081%" headers="mcps1.1.5.1.1 "><p id="p1301251675"><a name="p1301251675"></a><a name="p1301251675"></a>type</p>
</td>
<td class="cellrowborder" valign="top" width="11.498850114988501%" headers="mcps1.1.5.1.2 "><p id="p20751571"><a name="p20751571"></a><a name="p20751571"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="p14217134441420"><a name="p14217134441420"></a><a name="p14217134441420"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="66.06339366063393%" headers="mcps1.1.5.1.4 "><p id="p17125116718"><a name="p17125116718"></a><a name="p17125116718"></a>Valid calendar type. Currently, the valid types are as follows: <strong id="b10639957185911"><a name="b10639957185911"></a><a name="b10639957185911"></a>buddhist</strong>, <strong id="b612865985915"><a name="b612865985915"></a><a name="b612865985915"></a>chinese</strong>, <strong id="b0224611007"><a name="b0224611007"></a><a name="b0224611007"></a>coptic</strong>, <strong id="b1967913709"><a name="b1967913709"></a><a name="b1967913709"></a>ethiopic</strong>, <strong id="b173801451015"><a name="b173801451015"></a><a name="b173801451015"></a>hebrew</strong>, <strong id="b97751671105"><a name="b97751671105"></a><a name="b97751671105"></a>gregory</strong>, <strong id="b112149908"><a name="b112149908"></a><a name="b112149908"></a>indian</strong>, <strong id="b136596125012"><a name="b136596125012"></a><a name="b136596125012"></a>islamic_civil</strong>, <strong id="b1074811513017"><a name="b1074811513017"></a><a name="b1074811513017"></a>islamic_tbla</strong>, <strong id="b1623221911014"><a name="b1623221911014"></a><a name="b1623221911014"></a>islamic_umalqura</strong>, <strong id="b49202205010"><a name="b49202205010"></a><a name="b49202205010"></a>japanese</strong>, and <strong id="b105731443996"><a name="b105731443996"></a><a name="b105731443996"></a>persian</strong>. If this parameter is left unspecified, the default calendar type of the specified locale is used.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table4358161315113"></a>
<table><thead align="left"><tr id="row935810136511"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p835814136514"><a name="p835814136514"></a><a name="p835814136514"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p19358013175114"><a name="p19358013175114"></a><a name="p19358013175114"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8358101314512"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p4521253399"><a name="p4521253399"></a><a name="p4521253399"></a><a href="#section734252215124">Calendar</a></p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p835801305116"><a name="p835801305116"></a><a name="p835801305116"></a><strong id="b198875285514"><a name="b198875285514"></a><a name="b198875285514"></a>Calendar</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
i18n.getCalendar("zh-Hans", "gregory");
```
## Calendar<sup>8+</sup><a name="section734252215124"></a>
### setTime<sup>8+</sup><a name="section15209181154511"></a>
setTime\(date: Date\): void
Sets the date for this **Calendar** object.
- Parameters
<a name="table142096113459"></a>
<table><thead align="left"><tr id="row920913134517"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p02091913452"><a name="p02091913452"></a><a name="p02091913452"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p0209015455"><a name="p0209015455"></a><a name="p0209015455"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p132092113453"><a name="p132092113453"></a><a name="p132092113453"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p520961194514"><a name="p520961194514"></a><a name="p520961194514"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row22096114512"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p7209111164514"><a name="p7209111164514"></a><a name="p7209111164514"></a>date</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p520910154516"><a name="p520910154516"></a><a name="p520910154516"></a>Date</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p172093194517"><a name="p172093194517"></a><a name="p172093194517"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p142092114452"><a name="p142092114452"></a><a name="p142092114452"></a>Date to be set for the <strong id="b1825112714818"><a name="b1825112714818"></a><a name="b1825112714818"></a>Calendar</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = I18n.getCalendar("en-US", "gregory");
var date = new Date(2021, 10, 7, 8, 0, 0, 0);
calendar.setTime(date);
```
### setTime<sup>8+</sup><a name="section52101815455"></a>
setTime\(time: number\): void
Sets the date and time for this **Calendar** object. The value is represented by the number of milliseconds that have elapsed since the Unix epoch \(00:00:00 UTC on January 1, 1970\).
- Parameters
<a name="table1952384532312"></a>
<table><thead align="left"><tr id="row175232458238"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p552324542310"><a name="p552324542310"></a><a name="p552324542310"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p8523174572318"><a name="p8523174572318"></a><a name="p8523174572318"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p7523144516230"><a name="p7523144516230"></a><a name="p7523144516230"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p25231545152312"><a name="p25231545152312"></a><a name="p25231545152312"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row15231745172312"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1952315452234"><a name="p1952315452234"></a><a name="p1952315452234"></a>time</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p45241458234"><a name="p45241458234"></a><a name="p45241458234"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p852411459231"><a name="p852411459231"></a><a name="p852411459231"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p9524104532320"><a name="p9524104532320"></a><a name="p9524104532320"></a>Number of milliseconds that have elapsed since the Unix epoch.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = I18n.getCalendar("en-US", "gregory");
calendar.setTime(10540800000);
```
### set<sup>8+</sup><a name="section1921014119450"></a>
set\(year: number, month: number, date:number, hour?: number, minute?: number, second?: number\): void
Sets the year, month, day, hour, minute, and second for this **Calendar** object.
- Parameters
<a name="table1121041124517"></a>
<table><thead align="left"><tr id="row72119111452"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p1721171154513"><a name="p1721171154513"></a><a name="p1721171154513"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p122112154518"><a name="p122112154518"></a><a name="p122112154518"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p12111164518"><a name="p12111164518"></a><a name="p12111164518"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p121119184515"><a name="p121119184515"></a><a name="p121119184515"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row0211161144516"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p72117118454"><a name="p72117118454"></a><a name="p72117118454"></a>year</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p82113120459"><a name="p82113120459"></a><a name="p82113120459"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p321115194518"><a name="p321115194518"></a><a name="p321115194518"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p221118118453"><a name="p221118118453"></a><a name="p221118118453"></a>Year to set.</p>
</td>
</tr>
<tr id="row8345101714272"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p11346191713274"><a name="p11346191713274"></a><a name="p11346191713274"></a>month</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p634616178276"><a name="p634616178276"></a><a name="p634616178276"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p1934681772714"><a name="p1934681772714"></a><a name="p1934681772714"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1434621732712"><a name="p1434621732712"></a><a name="p1434621732712"></a>Month to set.</p>
</td>
</tr>
<tr id="row8623420192713"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p15623920102711"><a name="p15623920102711"></a><a name="p15623920102711"></a>date</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p136231205271"><a name="p136231205271"></a><a name="p136231205271"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p176231420112714"><a name="p176231420112714"></a><a name="p176231420112714"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p76237206271"><a name="p76237206271"></a><a name="p76237206271"></a>Day to set.</p>
</td>
</tr>
<tr id="row8528633152712"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p6528933182719"><a name="p6528933182719"></a><a name="p6528933182719"></a>hour</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p352863315278"><a name="p352863315278"></a><a name="p352863315278"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p12528533182720"><a name="p12528533182720"></a><a name="p12528533182720"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p55281433192714"><a name="p55281433192714"></a><a name="p55281433192714"></a>Hour to set.</p>
</td>
</tr>
<tr id="row18534224162711"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p6534192412275"><a name="p6534192412275"></a><a name="p6534192412275"></a>minute</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1453402411277"><a name="p1453402411277"></a><a name="p1453402411277"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p853472412717"><a name="p853472412717"></a><a name="p853472412717"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p95343245272"><a name="p95343245272"></a><a name="p95343245272"></a>Minute to set.</p>
</td>
</tr>
<tr id="row5222529102715"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p182221291275"><a name="p182221291275"></a><a name="p182221291275"></a>second</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1522211290279"><a name="p1522211290279"></a><a name="p1522211290279"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p12222295277"><a name="p12222295277"></a><a name="p12222295277"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p18222229162710"><a name="p18222229162710"></a><a name="p18222229162710"></a>Second to set.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
```
### setTimeZone<sup>8+</sup><a name="section7560193714354"></a>
setTimeZone\(timezone: string\): void
Sets the time zone of this **Calendar** object.
- Parameters
<a name="table1956173763518"></a>
<table><thead align="left"><tr id="row205611637163512"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p12561113717355"><a name="p12561113717355"></a><a name="p12561113717355"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p18561237113513"><a name="p18561237113513"></a><a name="p18561237113513"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p25611637103514"><a name="p25611637103514"></a><a name="p25611637103514"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p45611237203517"><a name="p45611237203517"></a><a name="p45611237203517"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1561143743514"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1856173714353"><a name="p1856173714353"></a><a name="p1856173714353"></a>timezone</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1756117377352"><a name="p1756117377352"></a><a name="p1756117377352"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p0561133773516"><a name="p0561133773516"></a><a name="p0561133773516"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p11561103713359"><a name="p11561103713359"></a><a name="p11561103713359"></a>Time zone, for example, <strong id="b174087184476"><a name="b174087184476"></a><a name="b174087184476"></a>Asia/Shanghai</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
```
### getTimeZone<sup>8+</sup><a name="section132132174510"></a>
getTimeZone\(\): string
Obtains the time zone of this **Calendar** object.
- Return values
<a name="table1021321154511"></a>
<table><thead align="left"><tr id="row172132011454"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p182131119455"><a name="p182131119455"></a><a name="p182131119455"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p421314104515"><a name="p421314104515"></a><a name="p421314104515"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row5213171154518"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1621320113459"><a name="p1621320113459"></a><a name="p1621320113459"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p1021319117453"><a name="p1021319117453"></a><a name="p1021319117453"></a>Time zone of the <strong id="b141952612917"><a name="b141952612917"></a><a name="b141952612917"></a>Calendar</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
calendar.getTimeZone(); // Asia/Shanghai"
```
### getFirstDayOfWeek<sup>8+</sup><a name="section17342422101214"></a>
getFirstDayOfWeek\(\): number
Obtains the start day of a week for this **Calendar** object.
- Return values
<a name="table2356104116435"></a>
<table><thead align="left"><tr id="row1135614115437"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p173565418432"><a name="p173565418432"></a><a name="p173565418432"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p235615418434"><a name="p235615418434"></a><a name="p235615418434"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row17356441174317"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p113564413432"><a name="p113564413432"></a><a name="p113564413432"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p1235634134317"><a name="p1235634134317"></a><a name="p1235634134317"></a>Start day of a week. The value <strong id="b1142754320316"><a name="b1142754320316"></a><a name="b1142754320316"></a>1</strong> indicates Sunday, and value <strong id="b343334343113"><a name="b343334343113"></a><a name="b343334343113"></a>7</strong> indicates Saturday.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = I18n.getCalendar("en-US", "gregory");
calendar.getFirstDayOfWeek();
```
### setFirstDayOfWeek<sup>8+</sup><a name="section63421322151217"></a>
setFirstDayOfWeek\(value: number\): void
Sets the start day of a week for this **Calendar** object.
- Parameters
<a name="table14342222151217"></a>
<table><thead align="left"><tr id="row1834218229121"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p18343322171211"><a name="p18343322171211"></a><a name="p18343322171211"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p1343122121215"><a name="p1343122121215"></a><a name="p1343122121215"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p7343122217127"><a name="p7343122217127"></a><a name="p7343122217127"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1334342211213"><a name="p1334342211213"></a><a name="p1334342211213"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1934316225127"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1434392241210"><a name="p1434392241210"></a><a name="p1434392241210"></a>value</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p634314227129"><a name="p634314227129"></a><a name="p634314227129"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p1834342221216"><a name="p1834342221216"></a><a name="p1834342221216"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p73431922121210"><a name="p73431922121210"></a><a name="p73431922121210"></a>Start day of a week. The value <strong id="b166613239283"><a name="b166613239283"></a><a name="b166613239283"></a>1</strong> indicates Sunday, and value <strong id="b10661923142819"><a name="b10661923142819"></a><a name="b10661923142819"></a>7</strong> indicates Saturday.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setFirstDayOfWeek(0);
```
### getMinimalDaysInFirstWeek<sup>8+</sup><a name="section756814562910"></a>
getMinimalDaysInFirstWeek\(\): number
Obtains the minimum number of days in the first week of a year.
- Return values
<a name="table1756817512291"></a>
<table><thead align="left"><tr id="row1856814572913"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p125685592919"><a name="p125685592919"></a><a name="p125685592919"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p656813532920"><a name="p656813532920"></a><a name="p656813532920"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row65686518298"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1956813516294"><a name="p1956813516294"></a><a name="p1956813516294"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p195721334308"><a name="p195721334308"></a><a name="p195721334308"></a>Minimum number of days in the first week of a year.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.getMinimalDaysInFirstWeek();
```
### setMinimalDaysInFirstWeek<sup>8+</sup><a name="section65683572912"></a>
setMinimalDaysInFirstWeek\(value: number\): void
Sets the minimum number of days in the first week of a year.
- Parameters
<a name="table14569155102912"></a>
<table><thead align="left"><tr id="row5569125162916"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p45691357297"><a name="p45691357297"></a><a name="p45691357297"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p20569359294"><a name="p20569359294"></a><a name="p20569359294"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p105698542916"><a name="p105698542916"></a><a name="p105698542916"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1056919517296"><a name="p1056919517296"></a><a name="p1056919517296"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row195699552910"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p2569125162919"><a name="p2569125162919"></a><a name="p2569125162919"></a>value</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1156916517296"><a name="p1156916517296"></a><a name="p1156916517296"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p6569153294"><a name="p6569153294"></a><a name="p6569153294"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p756935102918"><a name="p756935102918"></a><a name="p756935102918"></a>Minimum number of days in the first week of a year.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setMinimalDaysInFirstWeek(3);
```
### get<sup>8+</sup><a name="section590202354711"></a>
get\(field: string\): number
Obtains the value of the specified field in the **Calendar** object.
- Parameters
<a name="table11902323154711"></a>
<table><thead align="left"><tr id="row3902112315470"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p59021223114717"><a name="p59021223114717"></a><a name="p59021223114717"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p890217233478"><a name="p890217233478"></a><a name="p890217233478"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p14903823184720"><a name="p14903823184720"></a><a name="p14903823184720"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p189033232474"><a name="p189033232474"></a><a name="p189033232474"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1690312334712"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p99032233476"><a name="p99032233476"></a><a name="p99032233476"></a>field</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p29031023134711"><a name="p29031023134711"></a><a name="p29031023134711"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p17903192354719"><a name="p17903192354719"></a><a name="p17903192354719"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p10903182317472"><a name="p10903182317472"></a><a name="p10903182317472"></a>Value of the specified field in the <strong id="b973814135911"><a name="b973814135911"></a><a name="b973814135911"></a>Calendar</strong> object. Currently, the valid fields are as follows: <strong id="b54517313373"><a name="b54517313373"></a><a name="b54517313373"></a>era</strong>, <strong id="b4603113353718"><a name="b4603113353718"></a><a name="b4603113353718"></a>year</strong>, <strong id="b139045344374"><a name="b139045344374"></a><a name="b139045344374"></a>month</strong>, <strong id="b1779363917373"><a name="b1779363917373"></a><a name="b1779363917373"></a>week_of_year</strong>, <strong id="b111284843711"><a name="b111284843711"></a><a name="b111284843711"></a>week_of_month</strong>, <strong id="b6644550123711"><a name="b6644550123711"></a><a name="b6644550123711"></a>date</strong>, <strong id="b2082310568374"><a name="b2082310568374"></a><a name="b2082310568374"></a>day_of_year</strong>, <strong id="b1755416033813"><a name="b1755416033813"></a><a name="b1755416033813"></a>day_of_week</strong>, <strong id="b79272383819"><a name="b79272383819"></a><a name="b79272383819"></a>day_of_week_in_month</strong>, <strong id="b446018516385"><a name="b446018516385"></a><a name="b446018516385"></a>hour</strong>, <strong id="b642312811386"><a name="b642312811386"></a><a name="b642312811386"></a>hour_of_day</strong>, <strong id="b1677913911383"><a name="b1677913911383"></a><a name="b1677913911383"></a>minute</strong>, <strong id="b590131115381"><a name="b590131115381"></a><a name="b590131115381"></a>second</strong>, <strong id="b17195201218383"><a name="b17195201218383"></a><a name="b17195201218383"></a>millisecond</strong>, <strong id="b18720161403816"><a name="b18720161403816"></a><a name="b18720161403816"></a>zone_offset</strong>, <strong id="b11319317173815"><a name="b11319317173815"></a><a name="b11319317173815"></a>dst_offset</strong>, <strong id="b7836920153817"><a name="b7836920153817"></a><a name="b7836920153817"></a>year_woy</strong>, <strong id="b5994125153817"><a name="b5994125153817"></a><a name="b5994125153817"></a>dow_local</strong>, <strong id="b14359193012387"><a name="b14359193012387"></a><a name="b14359193012387"></a>extended_year</strong>, <strong id="b1995813216385"><a name="b1995813216385"></a><a name="b1995813216385"></a>julian_day</strong>, <strong id="b13343204014389"><a name="b13343204014389"></a><a name="b13343204014389"></a>milliseconds_in_day</strong>, and <strong id="b208981843193819"><a name="b208981843193819"></a><a name="b208981843193819"></a>is_leap_month</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table1574210103588"></a>
<table><thead align="left"><tr id="row57436102582"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p17743210135814"><a name="p17743210135814"></a><a name="p17743210135814"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p117433101587"><a name="p117433101587"></a><a name="p117433101587"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row174316101582"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1974361035815"><a name="p1974361035815"></a><a name="p1974361035815"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p197430101589"><a name="p197430101589"></a><a name="p197430101589"></a>Value of the specified field. For example, if the year in the internal date of this <strong id="b713617105454"><a name="b713617105454"></a><a name="b713617105454"></a>Calendar</strong> object is <strong id="b4545113104514"><a name="b4545113104514"></a><a name="b4545113104514"></a>1990</strong>, the <strong id="b1780019104518"><a name="b1780019104518"></a><a name="b1780019104518"></a>get("year")</strong> function will return <strong id="b857122216453"><a name="b857122216453"></a><a name="b857122216453"></a>1990</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
calendar.get("hour_of_day"); // 8
```
### getDisplayName<sup>8+</sup><a name="section1443644124714"></a>
getDisplayName\(locale: string\): string
Obtains the name of the **Calendar** object displayed for the specified locale.
- Parameters
<a name="table1043717444710"></a>
<table><thead align="left"><tr id="row164371442478"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p1043719484720"><a name="p1043719484720"></a><a name="p1043719484720"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p134376417476"><a name="p134376417476"></a><a name="p134376417476"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p164373419474"><a name="p164373419474"></a><a name="p164373419474"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p443717418472"><a name="p443717418472"></a><a name="p443717418472"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1943710444712"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p14437645479"><a name="p14437645479"></a><a name="p14437645479"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p74374417474"><a name="p74374417474"></a><a name="p74374417474"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p1643734134715"><a name="p1643734134715"></a><a name="p1643734134715"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1943754204711"><a name="p1943754204711"></a><a name="p1943754204711"></a>Locale for which the name of the <strong id="b153411615135514"><a name="b153411615135514"></a><a name="b153411615135514"></a>Calendar</strong> object is displayed. For example, if <strong id="b15956959165512"><a name="b15956959165512"></a><a name="b15956959165512"></a>locale</strong> is <strong id="b3135193195616"><a name="b3135193195616"></a><a name="b3135193195616"></a>en-US</strong>, the name of the Buddhist calendar will be <strong id="b1136103015554"><a name="b1136103015554"></a><a name="b1136103015554"></a>Buddhist Calendar</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table829311451878"></a>
<table><thead align="left"><tr id="row6293745570"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p629314454719"><a name="p629314454719"></a><a name="p629314454719"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p162934451773"><a name="p162934451773"></a><a name="p162934451773"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row62930457717"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1429419456710"><a name="p1429419456710"></a><a name="p1429419456710"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p1329434513717"><a name="p1329434513717"></a><a name="p1329434513717"></a>Name of the <strong id="b11296192614204"><a name="b11296192614204"></a><a name="b11296192614204"></a>Calendar</strong> object displayed for the specified locale.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("en-US", "buddhist");
calendar.getDisplayName("zh"); // Obtain the name of the Buddhist calendar in zh.
```
### isWeekend<sup>8+</sup><a name="section10596150144719"></a>
isWeekend\(date?: Date\): boolean
Checks whether the specified date in this **Calendar** object is a weekend.
- Parameters
<a name="table1259640194712"></a>
<table><thead align="left"><tr id="row459680124710"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p1859716094719"><a name="p1859716094719"></a><a name="p1859716094719"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p1159711064717"><a name="p1159711064717"></a><a name="p1159711064717"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p165971309473"><a name="p165971309473"></a><a name="p165971309473"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1959713024719"><a name="p1959713024719"></a><a name="p1959713024719"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row259710064714"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p05978019477"><a name="p05978019477"></a><a name="p05978019477"></a>date</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p195976014711"><a name="p195976014711"></a><a name="p195976014711"></a>Date</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p059710012474"><a name="p059710012474"></a><a name="p059710012474"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p759790184716"><a name="p759790184716"></a><a name="p759790184716"></a>Specified date in this <strong id="b12909151184614"><a name="b12909151184614"></a><a name="b12909151184614"></a>Calendar</strong> object. If this parameter is left unspecified, the system checks whether the current date in the <strong id="b5327113114916"><a name="b5327113114916"></a><a name="b5327113114916"></a>Calendar</strong> object is a weekend.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table446781310810"></a>
<table><thead align="left"><tr id="row194677130812"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p144671131983"><a name="p144671131983"></a><a name="p144671131983"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p104672138812"><a name="p104672138812"></a><a name="p104672138812"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row13467181313813"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p17467141313814"><a name="p17467141313814"></a><a name="p17467141313814"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p134689131085"><a name="p134689131085"></a><a name="p134689131085"></a>The value true indicates that the date is a weekend, and value <strong id="b1878515462424"><a name="b1878515462424"></a><a name="b1878515462424"></a>false</strong> indicates a weekday.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 11, 11, 8, 0, 0); // Set the time to 2021.11.11 08:00:00.
calendar.isWeekend(); // false
var date = new Date(2011, 11, 6, 9, 0, 0);
calendar.isWeekend(date); // true
```
## PhoneNumberFormat<sup>8+</sup><a name="section1693273262315"></a>
### constructor<sup>8+</sup><a name="section186273446118"></a>
constructor\(country: string, options?: PhoneNumberFormatOptions\)
Creates a **PhoneNumberFormat** object.
Parameters
<a name="table6627244111119"></a>
<table><thead align="left"><tr id="row562834412111"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p1462854451114"><a name="p1462854451114"></a><a name="p1462854451114"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1762819446119"><a name="p1762819446119"></a><a name="p1762819446119"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p15628044141119"><a name="p15628044141119"></a><a name="p15628044141119"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p76286443111"><a name="p76286443111"></a><a name="p76286443111"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row7628164419115"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p8628124414113"><a name="p8628124414113"></a><a name="p8628124414113"></a>country</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p862864421112"><a name="p862864421112"></a><a name="p862864421112"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p2062864441119"><a name="p2062864441119"></a><a name="p2062864441119"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p0628344161114"><a name="p0628344161114"></a><a name="p0628344161114"></a>Country or region to which the phone number to be formatted belongs.</p>
</td>
</tr>
<tr id="row1628344191118"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p7628114421115"><a name="p7628114421115"></a><a name="p7628114421115"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p19629144491117"><a name="p19629144491117"></a><a name="p19629144491117"></a><a href="#section208137352082">PhoneNumberFormatOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p11629134471115"><a name="p11629134471115"></a><a name="p11629134471115"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p2629134411115"><a name="p2629134411115"></a><a name="p2629134411115"></a>Options of the <strong id="b133271441355"><a name="b133271441355"></a><a name="b133271441355"></a>PhoneNumberFormat</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"});
```
### isValidNumber<sup>8+</sup><a name="section179323320232"></a>
isValidNumber\(number: string\): boolean
Checks whether the format of the specified phone number is valid.
- Parameters
<a name="table18932123242316"></a>
<table><thead align="left"><tr id="row1193323214232"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p293317321234"><a name="p293317321234"></a><a name="p293317321234"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p6933163262311"><a name="p6933163262311"></a><a name="p6933163262311"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p19933732112317"><a name="p19933732112317"></a><a name="p19933732112317"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p10933193232316"><a name="p10933193232316"></a><a name="p10933193232316"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8933932172315"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p9933193262319"><a name="p9933193262319"></a><a name="p9933193262319"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p149331632172311"><a name="p149331632172311"></a><a name="p149331632172311"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p293315321233"><a name="p293315321233"></a><a name="p293315321233"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p1993323202316"><a name="p1993323202316"></a><a name="p1993323202316"></a>Phone number to be checked.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table10933163210234"></a>
<table><thead align="left"><tr id="row3933193282318"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p0934032132314"><a name="p0934032132314"></a><a name="p0934032132314"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p8934103272315"><a name="p8934103272315"></a><a name="p8934103272315"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row189342326238"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p1293423232314"><a name="p1293423232314"></a><a name="p1293423232314"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p159346329238"><a name="p159346329238"></a><a name="p159346329238"></a>The value <strong id="b655418371355"><a name="b655418371355"></a><a name="b655418371355"></a>true</strong> indicates the phone number format is valid, and value <strong id="b551063319513"><a name="b551063319513"></a><a name="b551063319513"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.isValidNumber("15812312312");
```
### format<sup>8+</sup><a name="section34181141163218"></a>
format\(number: string\): string
Formats a phone number.
- Parameters
<a name="table154195418327"></a>
<table><thead align="left"><tr id="row16419184103211"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p14199413321"><a name="p14199413321"></a><a name="p14199413321"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p34191041183213"><a name="p34191041183213"></a><a name="p34191041183213"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p5419741103214"><a name="p5419741103214"></a><a name="p5419741103214"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p44195415320"><a name="p44195415320"></a><a name="p44195415320"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row144194414329"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p04191341163218"><a name="p04191341163218"></a><a name="p04191341163218"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p11420141173218"><a name="p11420141173218"></a><a name="p11420141173218"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p20420114112327"><a name="p20420114112327"></a><a name="p20420114112327"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p8420204113328"><a name="p8420204113328"></a><a name="p8420204113328"></a>Phone number to be formatted.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table6420104123215"></a>
<table><thead align="left"><tr id="row134201641123218"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p1642054113213"><a name="p1642054113213"></a><a name="p1642054113213"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p184201041113219"><a name="p184201041113219"></a><a name="p184201041113219"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1142014118324"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p194201741193214"><a name="p194201741193214"></a><a name="p194201741193214"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p9420241203211"><a name="p9420241203211"></a><a name="p9420241203211"></a>Formatted phone number.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.format("15812312312");
```
## PhoneNumberFormatOptions<sup>8+</sup><a name="section208137352082"></a>
Defines the options for this **PhoneNumberFormat** object.
<a name="table581363516811"></a>
<table><thead align="left"><tr id="row581393517817"><th class="cellrowborder" valign="top" width="19.15%" id="mcps1.1.6.1.1"><p id="p881312351783"><a name="p881312351783"></a><a name="p881312351783"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.8%" id="mcps1.1.6.1.2"><p id="p138134351288"><a name="p138134351288"></a><a name="p138134351288"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.12%" id="mcps1.1.6.1.3"><p id="p1481313351381"><a name="p1481313351381"></a><a name="p1481313351381"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.48%" id="mcps1.1.6.1.4"><p id="p28132351689"><a name="p28132351689"></a><a name="p28132351689"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.449999999999996%" id="mcps1.1.6.1.5"><p id="p7813635689"><a name="p7813635689"></a><a name="p7813635689"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row158131835687"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1181443520810"><a name="p1181443520810"></a><a name="p1181443520810"></a>type</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1581416352086"><a name="p1581416352086"></a><a name="p1581416352086"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p9814133515816"><a name="p9814133515816"></a><a name="p9814133515816"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p12814435287"><a name="p12814435287"></a><a name="p12814435287"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p781453518814"><a name="p781453518814"></a><a name="p781453518814"></a>Format type of a phone number. The available options are as follows: <strong id="b2090653219128"><a name="b2090653219128"></a><a name="b2090653219128"></a>E164</strong>, <strong id="b8729133516126"><a name="b8729133516126"></a><a name="b8729133516126"></a>INTERNATIONAL</strong>, <strong id="b78591736171217"><a name="b78591736171217"></a><a name="b78591736171217"></a>NATIONAL</strong>, and <strong id="b427354020121"><a name="b427354020121"></a><a name="b427354020121"></a>RFC3966</strong>.</p>
</td>
</tr>
</tbody>
</table>
## UnitInfo<sup>8+</sup><a name="section2018814515186"></a>
Defines the measurement unit information.
<a name="table581614110198"></a>
<table><thead align="left"><tr id="row168171119196"><th class="cellrowborder" valign="top" width="19.15%" id="mcps1.1.6.1.1"><p id="p17817311151914"><a name="p17817311151914"></a><a name="p17817311151914"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.8%" id="mcps1.1.6.1.2"><p id="p128170116192"><a name="p128170116192"></a><a name="p128170116192"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.12%" id="mcps1.1.6.1.3"><p id="p128171511141916"><a name="p128171511141916"></a><a name="p128171511141916"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.48%" id="mcps1.1.6.1.4"><p id="p38171011121920"><a name="p38171011121920"></a><a name="p38171011121920"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.449999999999996%" id="mcps1.1.6.1.5"><p id="p2817161118191"><a name="p2817161118191"></a><a name="p2817161118191"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1181719115198"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1181751111919"><a name="p1181751111919"></a><a name="p1181751111919"></a>unit</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p48171711131920"><a name="p48171711131920"></a><a name="p48171711131920"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p11817151114194"><a name="p11817151114194"></a><a name="p11817151114194"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p6817711191916"><a name="p6817711191916"></a><a name="p6817711191916"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p28171511181914"><a name="p28171511181914"></a><a name="p28171511181914"></a>Name of the measurement unit, for example, <strong id="b01831838118"><a name="b01831838118"></a><a name="b01831838118"></a>meter</strong>, <strong id="b16720174116"><a name="b16720174116"></a><a name="b16720174116"></a>inch</strong>, or <strong id="b8771567115"><a name="b8771567115"></a><a name="b8771567115"></a>cup</strong>.</p>
</td>
</tr>
<tr id="row472203019193"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p6721930191916"><a name="p6721930191916"></a><a name="p6721930191916"></a>measureSystem</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p15821738101917"><a name="p15821738101917"></a><a name="p15821738101917"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p16821638171911"><a name="p16821638171911"></a><a name="p16821638171911"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p682103851920"><a name="p682103851920"></a><a name="p682103851920"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p167223061914"><a name="p167223061914"></a><a name="p167223061914"></a>Measurement system. The value can be <strong id="b94239164313"><a name="b94239164313"></a><a name="b94239164313"></a>SI</strong>, <strong id="b9791317137"><a name="b9791317137"></a><a name="b9791317137"></a>US</strong>, or <strong id="b81571719033"><a name="b81571719033"></a><a name="b81571719033"></a>UK</strong>.</p>
</td>
</tr>
</tbody>
</table>
## Util<sup>8+</sup><a name="section1183183813415"></a>
### unitConvert<sup>8+</sup><a name="section721519102512"></a>
unitConvert\(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string\): string
Converts one measurement unit into another and formats the unit based on the specified locale and style.
- Parameters
<a name="table132514517137"></a>
<table><thead align="left"><tr id="row5325745111320"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p8325945151311"><a name="p8325945151311"></a><a name="p8325945151311"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p7325184514133"><a name="p7325184514133"></a><a name="p7325184514133"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p93255453132"><a name="p93255453132"></a><a name="p93255453132"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p18326184518133"><a name="p18326184518133"></a><a name="p18326184518133"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row13261045181313"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p832694591312"><a name="p832694591312"></a><a name="p832694591312"></a>fromUnit</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p11326144521314"><a name="p11326144521314"></a><a name="p11326144521314"></a><a href="#section2018814515186">UnitInfo</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p143261045161312"><a name="p143261045161312"></a><a name="p143261045161312"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p3326154515136"><a name="p3326154515136"></a><a name="p3326154515136"></a>Measurement unit to be converted.</p>
</td>
</tr>
<tr id="row125831117146"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p35831819144"><a name="p35831819144"></a><a name="p35831819144"></a>toUnit</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p1969491915145"><a name="p1969491915145"></a><a name="p1969491915145"></a><a href="#section2018814515186">UnitInfo</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p105834161412"><a name="p105834161412"></a><a name="p105834161412"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p185841414140"><a name="p185841414140"></a><a name="p185841414140"></a>Measurement unit to be converted to.</p>
</td>
</tr>
<tr id="row7950196111410"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p1950176111419"><a name="p1950176111419"></a><a name="p1950176111419"></a>value</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p18950196191417"><a name="p18950196191417"></a><a name="p18950196191417"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1095012671415"><a name="p1095012671415"></a><a name="p1095012671415"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p59502617146"><a name="p59502617146"></a><a name="p59502617146"></a>Value of the measurement unit to be converted.</p>
</td>
</tr>
<tr id="row1749198149"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p107507971418"><a name="p107507971418"></a><a name="p107507971418"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p2075011916143"><a name="p2075011916143"></a><a name="p2075011916143"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p11750396148"><a name="p11750396148"></a><a name="p11750396148"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p575069171414"><a name="p575069171414"></a><a name="p575069171414"></a>Locale used for formatting, for example, <strong id="b8984198172911"><a name="b8984198172911"></a><a name="b8984198172911"></a>zh-Hans-CN</strong>.</p>
</td>
</tr>
<tr id="row5452141241414"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p124521512111412"><a name="p124521512111412"></a><a name="p124521512111412"></a>style</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p1945211121146"><a name="p1945211121146"></a><a name="p1945211121146"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1845214126144"><a name="p1845214126144"></a><a name="p1845214126144"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p12452181271416"><a name="p12452181271416"></a><a name="p12452181271416"></a>Style used for formatting. The value can be <strong id="b13885195303818"><a name="b13885195303818"></a><a name="b13885195303818"></a>long</strong>, <strong id="b965955523812"><a name="b965955523812"></a><a name="b965955523812"></a>short</strong>, or <strong id="b15861057203811"><a name="b15861057203811"></a><a name="b15861057203811"></a>medium</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table23265456133"></a>
<table><thead align="left"><tr id="row53268458135"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p19326174512130"><a name="p19326174512130"></a><a name="p19326174512130"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p163261445131318"><a name="p163261445131318"></a><a name="p163261445131318"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row332704514139"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p43271245131313"><a name="p43271245131313"></a><a name="p43271245131313"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p20327845141310"><a name="p20327845141310"></a><a name="p20327845141310"></a>Character string obtained after formatting based on the measurement unit specified by <strong id="b14371143487"><a name="b14371143487"></a><a name="b14371143487"></a>toUnit</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
I18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
```
## i18n.getInstance<sup>8+</sup><a name="section465715244426"></a>
getInstance\(locale?: string\): IndexUtil
Creates an **IndexUtil** object.
- Parameters
<a name="table6988825184613"></a>
<table><thead align="left"><tr id="row129881025134618"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p149882025184617"><a name="p149882025184617"></a><a name="p149882025184617"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p898932584613"><a name="p898932584613"></a><a name="p898932584613"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p598942516461"><a name="p598942516461"></a><a name="p598942516461"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p20989925134610"><a name="p20989925134610"></a><a name="p20989925134610"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row13989112512465"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p1655813392467"><a name="p1655813392467"></a><a name="p1655813392467"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p355816397461"><a name="p355816397461"></a><a name="p355816397461"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p19558163916466"><a name="p19558163916466"></a><a name="p19558163916466"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p75581739194613"><a name="p75581739194613"></a><a name="p75581739194613"></a>A string containing locale information, including the language, optional script, and region.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table899112516464"></a>
<table><thead align="left"><tr id="row139911125124619"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p1999122514464"><a name="p1999122514464"></a><a name="p1999122514464"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p89918251469"><a name="p89918251469"></a><a name="p89918251469"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row4991192544611"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p944444554613"><a name="p944444554613"></a><a name="p944444554613"></a><a href="#section6846195915243">IndexUtil</a></p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p94441945144614"><a name="p94441945144614"></a><a name="p94441945144614"></a><strong id="b2054265864916"><a name="b2054265864916"></a><a name="b2054265864916"></a>IndexUtil</strong> object mapping to the specified locale.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var indexUtil= i18n.getInstance("zh-CN");
```
## IndexUtil<sup>8+</sup><a name="section6846195915243"></a>
### getIndexList<sup>8+</sup><a name="section108481959142414"></a>
getIndexList\(\): Array<string\>
Obtains the index list for this **locale** object.
- Return values
<a name="table4850759112412"></a>
<table><thead align="left"><tr id="row485055942414"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p14850115918248"><a name="p14850115918248"></a><a name="p14850115918248"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p68501459192413"><a name="p68501459192413"></a><a name="p68501459192413"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row28505594244"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p118501359122419"><a name="p118501359122419"></a><a name="p118501359122419"></a>Array&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p1085095982419"><a name="p1085095982419"></a><a name="p1085095982419"></a>Index list for this locale.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var indexUtil = i18n.getInstance("zh-CN");
var indexList = indexUtil.getIndexList();
```
### addLocale<sup>8+</sup><a name="section1085195918241"></a>
addLocale\(locale: string\)
Adds the index of the new **locale** object to the index list.
- Parameters
<a name="table12851175917249"></a>
<table><thead align="left"><tr id="row1185165919241"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p4851115915244"><a name="p4851115915244"></a><a name="p4851115915244"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p885285982419"><a name="p885285982419"></a><a name="p885285982419"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p485215596245"><a name="p485215596245"></a><a name="p485215596245"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p1885255962411"><a name="p1885255962411"></a><a name="p1885255962411"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row4852559102416"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p16852185915248"><a name="p16852185915248"></a><a name="p16852185915248"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p18521259122418"><a name="p18521259122418"></a><a name="p18521259122418"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p13852155972413"><a name="p13852155972413"></a><a name="p13852155972413"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p085255914241"><a name="p085255914241"></a><a name="p085255914241"></a>A string containing locale information, including the language, optional script, and region.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var indexUtil = i18n.getInstance("zh-CN");
indexUtil.addLocale("en-US");
```
### getIndex<sup>8+</sup><a name="section477585175017"></a>
getIndex\(text: string\): string
Obtains the index of a **text** object.
- Parameters
<a name="table16538977518"></a>
<table><thead align="left"><tr id="row115381871512"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p20539974512"><a name="p20539974512"></a><a name="p20539974512"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1253911785116"><a name="p1253911785116"></a><a name="p1253911785116"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p205392720518"><a name="p205392720518"></a><a name="p205392720518"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p105396725118"><a name="p105396725118"></a><a name="p105396725118"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row135399755112"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p105392725114"><a name="p105392725114"></a><a name="p105392725114"></a>text</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p9539175516"><a name="p9539175516"></a><a name="p9539175516"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p8539176511"><a name="p8539176511"></a><a name="p8539176511"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p17539177165113"><a name="p17539177165113"></a><a name="p17539177165113"></a><strong id="b345663119182"><a name="b345663119182"></a><a name="b345663119182"></a>text</strong> object whose index is to be obtained.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table145391373515"></a>
<table><thead align="left"><tr id="row9540107185113"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p854016795113"><a name="p854016795113"></a><a name="p854016795113"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p65406795110"><a name="p65406795110"></a><a name="p65406795110"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row85401875512"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p1454037125110"><a name="p1454037125110"></a><a name="p1454037125110"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p135409717510"><a name="p135409717510"></a><a name="p135409717510"></a>Index of the <strong id="b42196822416"><a name="b42196822416"></a><a name="b42196822416"></a>text</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var indexUtil= i18n.getInstance("zh-CN");
indexUtil.getIndex("hi"); // Return h.
```
## Character<sup>8+</sup><a name="section12707113365210"></a>
### isDigit<sup>8+</sup><a name="section191618218539"></a>
isDigit\(char: string\): boolean
Checks whether the input character string is comprised of digits.
- Parameters
<a name="table16162132110538"></a>
<table><thead align="left"><tr id="row1916362175315"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p616382117532"><a name="p616382117532"></a><a name="p616382117532"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1163021125320"><a name="p1163021125320"></a><a name="p1163021125320"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p1216372145317"><a name="p1216372145317"></a><a name="p1216372145317"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p1016342125317"><a name="p1016342125317"></a><a name="p1016342125317"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row2016392120530"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p16163521175310"><a name="p16163521175310"></a><a name="p16163521175310"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p21631421155317"><a name="p21631421155317"></a><a name="p21631421155317"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p131635217531"><a name="p131635217531"></a><a name="p131635217531"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p201632021145314"><a name="p201632021145314"></a><a name="p201632021145314"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table916418215531"></a>
<table><thead align="left"><tr id="row20164192195319"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p121641021195311"><a name="p121641021195311"></a><a name="p121641021195311"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p1316492135311"><a name="p1316492135311"></a><a name="p1316492135311"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1416410211538"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p1816419213534"><a name="p1816419213534"></a><a name="p1816419213534"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p4164142145313"><a name="p4164142145313"></a><a name="p4164142145313"></a>The value <strong id="b3814161419326"><a name="b3814161419326"></a><a name="b3814161419326"></a>true</strong> indicates that the input character is a digit, and value <strong id="b06351730113213"><a name="b06351730113213"></a><a name="b06351730113213"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var isdigit = Character.isDigit("1"); // Return true.
```
### isSpaceChar<sup>8+</sup><a name="section410075273413"></a>
isSpaceChar\(char: string\): boolean
Checks whether the input character is comprised of space.
- Parameters
<a name="table1010015283414"></a>
<table><thead align="left"><tr id="row15100145273412"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p111001352163415"><a name="p111001352163415"></a><a name="p111001352163415"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1010116528342"><a name="p1010116528342"></a><a name="p1010116528342"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p13101145273412"><a name="p13101145273412"></a><a name="p13101145273412"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p11011952183415"><a name="p11011952183415"></a><a name="p11011952183415"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1310135220340"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p1310175210349"><a name="p1310175210349"></a><a name="p1310175210349"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p1010115214341"><a name="p1010115214341"></a><a name="p1010115214341"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p61011752113413"><a name="p61011752113413"></a><a name="p61011752113413"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p4101052143417"><a name="p4101052143417"></a><a name="p4101052143417"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table1310105283419"></a>
<table><thead align="left"><tr id="row12102105223420"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p31022052143418"><a name="p31022052143418"></a><a name="p31022052143418"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p2102125219349"><a name="p2102125219349"></a><a name="p2102125219349"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row9102185211341"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p81025527347"><a name="p81025527347"></a><a name="p81025527347"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p1210245243410"><a name="p1210245243410"></a><a name="p1210245243410"></a>The value <strong id="b42481754183718"><a name="b42481754183718"></a><a name="b42481754183718"></a>true</strong> indicates that the input character is a space, and value <strong id="b2248165443715"><a name="b2248165443715"></a><a name="b2248165443715"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var isspacechar = Character.isSpaceChar("a"); // Return false.
```
### isWhitespace<sup>8+</sup><a name="section330415260418"></a>
isWhitespace\(char: string\): boolean
Checks whether the input character is comprised of white space.
- Parameters
<a name="table1930542674113"></a>
<table><thead align="left"><tr id="row103051626114116"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p153051226124110"><a name="p153051226124110"></a><a name="p153051226124110"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1230512674118"><a name="p1230512674118"></a><a name="p1230512674118"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p430532654118"><a name="p430532654118"></a><a name="p430532654118"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p18306132617413"><a name="p18306132617413"></a><a name="p18306132617413"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row73061026154119"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p11306326184113"><a name="p11306326184113"></a><a name="p11306326184113"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p230642664120"><a name="p230642664120"></a><a name="p230642664120"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p6306202613417"><a name="p6306202613417"></a><a name="p6306202613417"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p6306132694115"><a name="p6306132694115"></a><a name="p6306132694115"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table1230602619416"></a>
<table><thead align="left"><tr id="row530652615419"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p93073265414"><a name="p93073265414"></a><a name="p93073265414"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p030717261415"><a name="p030717261415"></a><a name="p030717261415"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row430742619412"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p18307152634115"><a name="p18307152634115"></a><a name="p18307152634115"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p330710269413"><a name="p330710269413"></a><a name="p330710269413"></a>The value <strong id="b6934348153810"><a name="b6934348153810"></a><a name="b6934348153810"></a>true</strong> indicates that the input character is a white space, and value <strong id="b1794094873813"><a name="b1794094873813"></a><a name="b1794094873813"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var iswhitespace = Character.isWhitespace("a"); // Return false.
```
### isRTL<sup>8+</sup><a name="section1129311984317"></a>
isRTL\(char: string\): boolean
Checks whether the input character string is of the right to left \(RTL\) language.
- Parameters
<a name="table729361964318"></a>
<table><thead align="left"><tr id="row4294171912436"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p3294119124316"><a name="p3294119124316"></a><a name="p3294119124316"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p929414198432"><a name="p929414198432"></a><a name="p929414198432"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p7294151910437"><a name="p7294151910437"></a><a name="p7294151910437"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p129431912431"><a name="p129431912431"></a><a name="p129431912431"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row52945197432"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p192941192436"><a name="p192941192436"></a><a name="p192941192436"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p1529418195437"><a name="p1529418195437"></a><a name="p1529418195437"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1295119104311"><a name="p1295119104311"></a><a name="p1295119104311"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p429571912437"><a name="p429571912437"></a><a name="p429571912437"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table92951219114318"></a>
<table><thead align="left"><tr id="row829531924320"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p10295519144315"><a name="p10295519144315"></a><a name="p10295519144315"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p122951019164311"><a name="p122951019164311"></a><a name="p122951019164311"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row192954190433"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p829681914435"><a name="p829681914435"></a><a name="p829681914435"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p11296131944316"><a name="p11296131944316"></a><a name="p11296131944316"></a>The value <strong id="b336183710499"><a name="b336183710499"></a><a name="b336183710499"></a>true</strong> indicates that the input character is of the RTL language, and value <strong id="b93673764913"><a name="b93673764913"></a><a name="b93673764913"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var isrtl = Character.isRTL("a"); // Return false.
```
### isIdeograph<sup>8+</sup><a name="section15378192818476"></a>
isIdeograph\(char: string\): boolean
Checks whether the input character string is comprised of ideographic characters.
- Parameters
<a name="table9379122818476"></a>
<table><thead align="left"><tr id="row937952816471"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p13379728104718"><a name="p13379728104718"></a><a name="p13379728104718"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1837982844719"><a name="p1837982844719"></a><a name="p1837982844719"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p1379028104717"><a name="p1379028104717"></a><a name="p1379028104717"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p537918285478"><a name="p537918285478"></a><a name="p537918285478"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1638015286474"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p1438014285478"><a name="p1438014285478"></a><a name="p1438014285478"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p1638011288479"><a name="p1638011288479"></a><a name="p1638011288479"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p338062814712"><a name="p338062814712"></a><a name="p338062814712"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p1938002834713"><a name="p1938002834713"></a><a name="p1938002834713"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table1238042815470"></a>
<table><thead align="left"><tr id="row13380328134717"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p1638072854718"><a name="p1638072854718"></a><a name="p1638072854718"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p538152820479"><a name="p538152820479"></a><a name="p538152820479"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1638142818473"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p133813289478"><a name="p133813289478"></a><a name="p133813289478"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p1238110284470"><a name="p1238110284470"></a><a name="p1238110284470"></a>The value <strong id="b16492153345214"><a name="b16492153345214"></a><a name="b16492153345214"></a>true</strong> indicates that the input character is an ideographic character, and value <strong id="b44924338527"><a name="b44924338527"></a><a name="b44924338527"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var isideograph = Character.isIdeograph("a"); // Return false.
```
### isLetter<sup>8+</sup><a name="section9130836184917"></a>
isLetter\(char: string\): boolean
Checks whether the input character string is comprised of letters.
- Parameters
<a name="table10130123619492"></a>
<table><thead align="left"><tr id="row013153614917"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p18131153612491"><a name="p18131153612491"></a><a name="p18131153612491"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p7131336134917"><a name="p7131336134917"></a><a name="p7131336134917"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p3131236134915"><a name="p3131236134915"></a><a name="p3131236134915"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p513153610499"><a name="p513153610499"></a><a name="p513153610499"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row11131133654918"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p813143654911"><a name="p813143654911"></a><a name="p813143654911"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p31311436194916"><a name="p31311436194916"></a><a name="p31311436194916"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p20131103694910"><a name="p20131103694910"></a><a name="p20131103694910"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p18132163620493"><a name="p18132163620493"></a><a name="p18132163620493"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table313253620492"></a>
<table><thead align="left"><tr id="row17132133694915"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p4132193619496"><a name="p4132193619496"></a><a name="p4132193619496"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p131322036164912"><a name="p131322036164912"></a><a name="p131322036164912"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row15132536124910"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p213213368493"><a name="p213213368493"></a><a name="p213213368493"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p813353654910"><a name="p813353654910"></a><a name="p813353654910"></a>The value <strong id="b1364011716543"><a name="b1364011716543"></a><a name="b1364011716543"></a>true</strong> indicates that the input character is a letter, and value <strong id="b1564013745415"><a name="b1564013745415"></a><a name="b1564013745415"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var isletter = Character.isLetter("a"); // Return true.
```
### isLowerCase<sup>8+</sup><a name="section75441848115112"></a>
isLowerCase\(char: string\): boolean
Checks whether the input character is comprised of lowercase letters.
- Parameters
<a name="table11544174819511"></a>
<table><thead align="left"><tr id="row155451948135119"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p5545104835117"><a name="p5545104835117"></a><a name="p5545104835117"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p5545164855117"><a name="p5545164855117"></a><a name="p5545164855117"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p25458486511"><a name="p25458486511"></a><a name="p25458486511"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p1554554895116"><a name="p1554554895116"></a><a name="p1554554895116"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1054515485511"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p18545144819512"><a name="p18545144819512"></a><a name="p18545144819512"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p05451048105112"><a name="p05451048105112"></a><a name="p05451048105112"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p054514487515"><a name="p054514487515"></a><a name="p054514487515"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p554644817513"><a name="p554644817513"></a><a name="p554644817513"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table1354674885115"></a>
<table><thead align="left"><tr id="row1546148155111"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p9546164810510"><a name="p9546164810510"></a><a name="p9546164810510"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p19546184812515"><a name="p19546184812515"></a><a name="p19546184812515"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row17546448135118"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p155461483515"><a name="p155461483515"></a><a name="p155461483515"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p19546124855120"><a name="p19546124855120"></a><a name="p19546124855120"></a>The value <strong id="b1611413487548"><a name="b1611413487548"></a><a name="b1611413487548"></a>true</strong> indicates that the input character is a lowercase letter, and value <strong id="b411484895417"><a name="b411484895417"></a><a name="b411484895417"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var islowercase = Character.isLowerCase("a"); // Return true.
```
### isUpperCase<sup>8+</sup><a name="section175252051125212"></a>
isUpperCase\(char: string\): boolean
Checks whether the input character is comprised of uppercase letters.
- Parameters
<a name="table1552555110523"></a>
<table><thead align="left"><tr id="row14526135145210"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p7526351145213"><a name="p7526351145213"></a><a name="p7526351145213"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p3526165119524"><a name="p3526165119524"></a><a name="p3526165119524"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p15526195195210"><a name="p15526195195210"></a><a name="p15526195195210"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p25261951155214"><a name="p25261951155214"></a><a name="p25261951155214"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row205269518525"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p052675185219"><a name="p052675185219"></a><a name="p052675185219"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p195266516523"><a name="p195266516523"></a><a name="p195266516523"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p5527125135218"><a name="p5527125135218"></a><a name="p5527125135218"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p1552705119525"><a name="p1552705119525"></a><a name="p1552705119525"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table95276511520"></a>
<table><thead align="left"><tr id="row205271519525"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p75271651105212"><a name="p75271651105212"></a><a name="p75271651105212"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p1527165155215"><a name="p1527165155215"></a><a name="p1527165155215"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row85271851105216"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p35281051185212"><a name="p35281051185212"></a><a name="p35281051185212"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p1552813513525"><a name="p1552813513525"></a><a name="p1552813513525"></a>The value <strong id="b17483125210558"><a name="b17483125210558"></a><a name="b17483125210558"></a>true</strong> indicates that the input character is an uppercase letter, and value <strong id="b1448915285516"><a name="b1448915285516"></a><a name="b1448915285516"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var isuppercase = Character.isUpperCase("a"); // Return false.
```
### getType<sup>8+</sup><a name="section1390854618533"></a>
getType\(char: string\): string
Obtains the type of the input character string.
- Parameters
<a name="table18908184685315"></a>
<table><thead align="left"><tr id="row990810467535"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p18909154665318"><a name="p18909154665318"></a><a name="p18909154665318"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p590914463534"><a name="p590914463534"></a><a name="p590914463534"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p7909146115311"><a name="p7909146115311"></a><a name="p7909146115311"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p14909114618539"><a name="p14909114618539"></a><a name="p14909114618539"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row14909114612532"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p8909104685312"><a name="p8909104685312"></a><a name="p8909104685312"></a>char</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p0909114635312"><a name="p0909114635312"></a><a name="p0909114635312"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1890911461533"><a name="p1890911461533"></a><a name="p1890911461533"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p1890910468535"><a name="p1890910468535"></a><a name="p1890910468535"></a>Input character.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table4910146195313"></a>
<table><thead align="left"><tr id="row20910194635320"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p13910204645311"><a name="p13910204645311"></a><a name="p13910204645311"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p991014465534"><a name="p991014465534"></a><a name="p991014465534"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row99101046155318"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p1091024614533"><a name="p1091024614533"></a><a name="p1091024614533"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p12910104619531"><a name="p12910104619531"></a><a name="p12910104619531"></a>Type of the input character.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var type = Character.getType("a");
```
## i18n.getLineInstance<sup>8+</sup><a name="section8120192671613"></a>
getLineInstance\(locale: string\): BreakIterator
Obtains a [BreakIterator](#section1312302611613) object for text segmentation.
- Parameters
<a name="table612111269169"></a>
<table><thead align="left"><tr id="row1912111269163"><th class="cellrowborder" valign="top" width="14.918508149185081%" id="mcps1.1.5.1.1"><p id="p312115260160"><a name="p312115260160"></a><a name="p312115260160"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="11.498850114988501%" id="mcps1.1.5.1.2"><p id="p1712102641613"><a name="p1712102641613"></a><a name="p1712102641613"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.519248075192481%" id="mcps1.1.5.1.3"><p id="p6121182651610"><a name="p6121182651610"></a><a name="p6121182651610"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="66.06339366063393%" id="mcps1.1.5.1.4"><p id="p2121142612162"><a name="p2121142612162"></a><a name="p2121142612162"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row9122172631618"><td class="cellrowborder" valign="top" width="14.918508149185081%" headers="mcps1.1.5.1.1 "><p id="p1912262614167"><a name="p1912262614167"></a><a name="p1912262614167"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="11.498850114988501%" headers="mcps1.1.5.1.2 "><p id="p18122192651620"><a name="p18122192651620"></a><a name="p18122192651620"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="p612272611169"><a name="p612272611169"></a><a name="p612272611169"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="66.06339366063393%" headers="mcps1.1.5.1.4 "><p id="p16122192612166"><a name="p16122192612166"></a><a name="p16122192612166"></a>Valid locale value, for example, <strong id="b1619069580"><a name="b1619069580"></a><a name="b1619069580"></a>zh-Hans-CN</strong>. The <a href="#section1312302611613">BreakIterator</a> object segments text according to the rules of the specified locale.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table16122132610166"></a>
<table><thead align="left"><tr id="row17122152671613"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p81223269169"><a name="p81223269169"></a><a name="p81223269169"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p712282612164"><a name="p712282612164"></a><a name="p712282612164"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row212332614167"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p3123626201611"><a name="p3123626201611"></a><a name="p3123626201611"></a><a href="#section1312302611613">BreakIterator</a></p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p41231726101615"><a name="p41231726101615"></a><a name="p41231726101615"></a>Break iterator used for text segmentation.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
i18n.getLineInstance("en");
```
## BreakIterator<sup>8+</sup><a name="section1312302611613"></a>
### setLineBreakText<sup>8+</sup><a name="section14135918111319"></a>
setLineBreakText\(text: string\): void
Sets the text to be processed by the [BreakIterator](#section1312302611613) object.
- Parameters
<a name="table975084719224"></a>
<table><thead align="left"><tr id="row1275024792220"><th class="cellrowborder" valign="top" width="14.918508149185081%" id="mcps1.1.5.1.1"><p id="p875074702214"><a name="p875074702214"></a><a name="p875074702214"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="11.498850114988501%" id="mcps1.1.5.1.2"><p id="p157501747182218"><a name="p157501747182218"></a><a name="p157501747182218"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.519248075192481%" id="mcps1.1.5.1.3"><p id="p11750204713227"><a name="p11750204713227"></a><a name="p11750204713227"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="66.06339366063393%" id="mcps1.1.5.1.4"><p id="p675120477220"><a name="p675120477220"></a><a name="p675120477220"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row187511847112216"><td class="cellrowborder" valign="top" width="14.918508149185081%" headers="mcps1.1.5.1.1 "><p id="p6751104742216"><a name="p6751104742216"></a><a name="p6751104742216"></a>text</p>
</td>
<td class="cellrowborder" valign="top" width="11.498850114988501%" headers="mcps1.1.5.1.2 "><p id="p375116474227"><a name="p375116474227"></a><a name="p375116474227"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="p27511476228"><a name="p27511476228"></a><a name="p27511476228"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="66.06339366063393%" headers="mcps1.1.5.1.4 "><p id="p10751194713229"><a name="p10751194713229"></a><a name="p10751194713229"></a>Text to be processed by the <a href="#section1312302611613">BreakIterator</a> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
```
### getLineBreakText<sup>8+</sup><a name="section1671125315251"></a>
getLineBreakText\(\): string
Obtains the text being processed by the [BreakIterator](#section1312302611613) object.
- Return values
<a name="table1961174210267"></a>
<table><thead align="left"><tr id="row1611742122611"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p461217424264"><a name="p461217424264"></a><a name="p461217424264"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p96121342102616"><a name="p96121342102616"></a><a name="p96121342102616"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row7612164218269"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1061218424266"><a name="p1061218424266"></a><a name="p1061218424266"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p5612842162613"><a name="p5612842162613"></a><a name="p5612842162613"></a>Text being processed by the <a href="#section1312302611613">BreakIterator</a> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.getLineBreakText(); // Apple is my favorite fruit.
```
### current<sup>8+</sup><a name="section7123172618164"></a>
current\(\): number
Obtains the position of the [BreakIterator](#section1312302611613) object in the text being processed.
- Return values
<a name="table1784864163519"></a>
<table><thead align="left"><tr id="row4849204123517"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p484904103518"><a name="p484904103518"></a><a name="p484904103518"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p684984153516"><a name="p684984153516"></a><a name="p684984153516"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row7849104114350"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p178491441153520"><a name="p178491441153520"></a><a name="p178491441153520"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p184954143512"><a name="p184954143512"></a><a name="p184954143512"></a>Position of the <a href="#section1312302611613">BreakIterator</a> object in the text being processed.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
breakIter.current(); // 0
```
### first<sup>8+</sup><a name="section1456982120391"></a>
first\(\): number
Puts the [BreakIterator](#section1312302611613) object to the first text boundary, which is always at the beginning of the processed text.
- Return values
<a name="table4569162114397"></a>
<table><thead align="left"><tr id="row2569202143920"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p1569172120392"><a name="p1569172120392"></a><a name="p1569172120392"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p1357072119393"><a name="p1357072119393"></a><a name="p1357072119393"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row257018219397"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1957072113918"><a name="p1957072113918"></a><a name="p1957072113918"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p5570132112394"><a name="p5570132112394"></a><a name="p5570132112394"></a>Offset to the first text boundary of the processed text.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
breakIter.first(); // 0
```
### last<sup>8+</sup><a name="section5296105618422"></a>
last\(\): number
Puts the [BreakIterator](#section1312302611613) object to the last text boundary, which is always the next position after the end of the processed text.
- Return values
<a name="table1029725654211"></a>
<table><thead align="left"><tr id="row1429713561420"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p529745614212"><a name="p529745614212"></a><a name="p529745614212"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p142971656164214"><a name="p142971656164214"></a><a name="p142971656164214"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row729717564429"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p52977566423"><a name="p52977566423"></a><a name="p52977566423"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p142981556104212"><a name="p142981556104212"></a><a name="p142981556104212"></a>Offset of the last text boundary of the processed text.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.last(); // 27
```
### next<sup>8+</sup><a name="section121321618141318"></a>
next\(index?: number\): number
Moves the [BreakIterator](#section1312302611613) object backward by the specified number of text boundaries if the specified index is a positive number. If the index is a negative number, the [BreakIterator](#section1312302611613) object will be moved forward by the corresponding number of text boundaries. If no index is specified, the index will be treated as **1**.
- Parameters
<a name="table1269107161611"></a>
<table><thead align="left"><tr id="row117016713169"><th class="cellrowborder" valign="top" width="14.918508149185081%" id="mcps1.1.5.1.1"><p id="p87013771612"><a name="p87013771612"></a><a name="p87013771612"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="11.498850114988501%" id="mcps1.1.5.1.2"><p id="p14700710164"><a name="p14700710164"></a><a name="p14700710164"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.519248075192481%" id="mcps1.1.5.1.3"><p id="p570187151617"><a name="p570187151617"></a><a name="p570187151617"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="66.06339366063393%" id="mcps1.1.5.1.4"><p id="p18703751612"><a name="p18703751612"></a><a name="p18703751612"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row10701670162"><td class="cellrowborder" valign="top" width="14.918508149185081%" headers="mcps1.1.5.1.1 "><p id="p137087111612"><a name="p137087111612"></a><a name="p137087111612"></a>index</p>
</td>
<td class="cellrowborder" valign="top" width="11.498850114988501%" headers="mcps1.1.5.1.2 "><p id="p157015791613"><a name="p157015791613"></a><a name="p157015791613"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="p14705712167"><a name="p14705712167"></a><a name="p14705712167"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="66.06339366063393%" headers="mcps1.1.5.1.4 "><p id="p157113716161"><a name="p157113716161"></a><a name="p157113716161"></a>Number of text boundaries by which the <a href="#section1312302611613">BreakIterator</a> object is moved. A positive value indicates that the text boundary is moved backward, and a negative value indicates the opposite. If no index is specified, the index will be treated as <strong id="b195933232918"><a name="b195933232918"></a><a name="b195933232918"></a>1</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table4132111812136"></a>
<table><thead align="left"><tr id="row1613271811319"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p1713371815135"><a name="p1713371815135"></a><a name="p1713371815135"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p12133318161320"><a name="p12133318161320"></a><a name="p12133318161320"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1913314184133"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1613310185131"><a name="p1613310185131"></a><a name="p1613310185131"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p13133111851319"><a name="p13133111851319"></a><a name="p13133111851319"></a>Position of the <a href="#section1312302611613">BreakIterator</a> object in the text after it is moved by the specified number of text boundaries. The value <strong id="b4493281401"><a name="b4493281401"></a><a name="b4493281401"></a>-1</strong> is returned if the position of the <a href="#section1312302611613">BreakIterator</a> object is outside of the processed text after it is moved by the specified number of text boundaries.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0
iterator.next(); // 6
iterator.next(10); // -1
```
### previous<sup>8+</sup><a name="section61331018121314"></a>
previous\(\): number
Moves the [BreakIterator](#section1312302611613) object to the previous text boundary.
- Return values
<a name="table71342183138"></a>
<table><thead align="left"><tr id="row6134918201320"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p113461861318"><a name="p113461861318"></a><a name="p113461861318"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p15134201818139"><a name="p15134201818139"></a><a name="p15134201818139"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row41341218181315"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p19135918121317"><a name="p19135918121317"></a><a name="p19135918121317"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p313510183133"><a name="p313510183133"></a><a name="p313510183133"></a>Position of the <a href="#section1312302611613">BreakIterator</a> object in the text after it is moved to the previous text boundary. The value <strong id="b152571690117"><a name="b152571690117"></a><a name="b152571690117"></a>-1</strong> is returned if the position of the <a href="#section1312302611613">BreakIterator</a> object is outside of the processed text after it is moved by the specified number of text boundaries.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0
iterator.next(3); // 12
iterator.previous(); // 9
```
### following<sup>8+</sup><a name="section1743155314301"></a>
following\(offset: number\): number
Moves the [BreakIterator](#section1312302611613) object to the text boundary after the position specified by the offset.
- Parameters
<a name="table18744453173010"></a>
<table><thead align="left"><tr id="row10744125373013"><th class="cellrowborder" valign="top" width="14.918508149185081%" id="mcps1.1.5.1.1"><p id="p117441453113020"><a name="p117441453113020"></a><a name="p117441453113020"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="11.498850114988501%" id="mcps1.1.5.1.2"><p id="p77441853133020"><a name="p77441853133020"></a><a name="p77441853133020"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.519248075192481%" id="mcps1.1.5.1.3"><p id="p18745153183012"><a name="p18745153183012"></a><a name="p18745153183012"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="66.06339366063393%" id="mcps1.1.5.1.4"><p id="p19745145318303"><a name="p19745145318303"></a><a name="p19745145318303"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row197451753113015"><td class="cellrowborder" valign="top" width="14.918508149185081%" headers="mcps1.1.5.1.1 "><p id="p674595333013"><a name="p674595333013"></a><a name="p674595333013"></a>offset</p>
</td>
<td class="cellrowborder" valign="top" width="11.498850114988501%" headers="mcps1.1.5.1.2 "><p id="p1974510534304"><a name="p1974510534304"></a><a name="p1974510534304"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="p107459535303"><a name="p107459535303"></a><a name="p107459535303"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="66.06339366063393%" headers="mcps1.1.5.1.4 "><p id="p1274585312307"><a name="p1274585312307"></a><a name="p1274585312307"></a>Offset to the position before the text boundary to which the <a href="#section1312302611613">BreakIterator</a> object is moved.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table4746853183018"></a>
<table><thead align="left"><tr id="row7746135323019"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p774605393016"><a name="p774605393016"></a><a name="p774605393016"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p137461853163019"><a name="p137461853163019"></a><a name="p137461853163019"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row9746653143017"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p174675316301"><a name="p174675316301"></a><a name="p174675316301"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p1374625317301"><a name="p1374625317301"></a><a name="p1374625317301"></a>The value <strong id="b1066631131915"><a name="b1066631131915"></a><a name="b1066631131915"></a>-1</strong> is returned if the text boundary to which the <a href="#section1312302611613">BreakIterator</a> object is moved is outside of the processed text.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.following(0); // 6
iterator.following(100); // -1
iterator.current(); // 27
```
### isBoundary<sup>8+</sup><a name="section1908145612303"></a>
isBoundary\(offset: number\): boolean
Checks whether the position specified by the offset is a text boundary. If **true** is returned, the [BreakIterator](#section1312302611613) object is moved to the position specified by the offset. If **false** is returned, the [BreakIterator](#section1312302611613) object is moved to the text boundary after the position specified by the offset, which is equivalent to calling [following\(offset\)](#section1743155314301).
- Parameters
<a name="table4909956103010"></a>
<table><thead align="left"><tr id="row19909155673019"><th class="cellrowborder" valign="top" width="14.918508149185081%" id="mcps1.1.5.1.1"><p id="p17909155613016"><a name="p17909155613016"></a><a name="p17909155613016"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="11.498850114988501%" id="mcps1.1.5.1.2"><p id="p1190919562303"><a name="p1190919562303"></a><a name="p1190919562303"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.519248075192481%" id="mcps1.1.5.1.3"><p id="p11909195673012"><a name="p11909195673012"></a><a name="p11909195673012"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="66.06339366063393%" id="mcps1.1.5.1.4"><p id="p2909115633012"><a name="p2909115633012"></a><a name="p2909115633012"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row12909195617305"><td class="cellrowborder" valign="top" width="14.918508149185081%" headers="mcps1.1.5.1.1 "><p id="p139091856193015"><a name="p139091856193015"></a><a name="p139091856193015"></a>offset</p>
</td>
<td class="cellrowborder" valign="top" width="11.498850114988501%" headers="mcps1.1.5.1.2 "><p id="p1991016565305"><a name="p1991016565305"></a><a name="p1991016565305"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="p9910195619306"><a name="p9910195619306"></a><a name="p9910195619306"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="66.06339366063393%" headers="mcps1.1.5.1.4 "><p id="p1491005643015"><a name="p1491005643015"></a><a name="p1491005643015"></a>Position to check.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table169103564306"></a>
<table><thead align="left"><tr id="row1910756133018"><th class="cellrowborder" valign="top" width="22.759999999999998%" id="mcps1.1.3.1.1"><p id="p691015615307"><a name="p691015615307"></a><a name="p691015615307"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="77.24%" id="mcps1.1.3.1.2"><p id="p991135673015"><a name="p991135673015"></a><a name="p991135673015"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row109111456103010"><td class="cellrowborder" valign="top" width="22.759999999999998%" headers="mcps1.1.3.1.1 "><p id="p1091175683014"><a name="p1091175683014"></a><a name="p1091175683014"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="77.24%" headers="mcps1.1.3.1.2 "><p id="p291165623012"><a name="p291165623012"></a><a name="p291165623012"></a>The value <strong id="b910010472195"><a name="b910010472195"></a><a name="b910010472195"></a>true</strong> indicates that the position specified by the offset is a text boundary, and value <strong id="b4301203582014"><a name="b4301203582014"></a><a name="b4301203582014"></a>false</strong> indicates the opposite.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.isBoundary(0); // true;
iterator.isBoundary(5); // false;
```
en/application-dev/reference/apis/js-apis-intl.md
浏览文件 @ 5b59ac7a
# Internationalization \(intl\) <a name="EN-US_TOPIC_0000001200978209"></a> # Internationalization (intl)<a name="EN-US_TOPIC_0000001176823690"></a>
>![](../../public_sys-resources/icon-note.gif) **NOTE:** >![](../../public_sys-resources/icon-note.gif) **NOTE:**
>- The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. >- The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>- This module contains standard i18n APIs, which are defined in ECMA 402. >- This module contains standard i18n APIs, which are defined in ECMA 402.
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a> ## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
``` ```
...@@ -17,7 +16,7 @@ None ...@@ -17,7 +16,7 @@ None
## Locale<a name="section422715643011"></a> ## Locale<a name="section422715643011"></a>
### Attributes<a name="section1778221585513"></a> ### Attributes<a name="section6235445191017"></a>
<a name="table1378271515552"></a> <a name="table1378271515552"></a>
<table><thead align="left"><tr id="row1078291525514"><th class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.1.6.1.1"><p id="p17821115155511"><a name="p17821115155511"></a><a name="p17821115155511"></a>Name</p> <table><thead align="left"><tr id="row1078291525514"><th class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.1.6.1.1"><p id="p17821115155511"><a name="p17821115155511"></a><a name="p17821115155511"></a>Name</p>
...@@ -40,7 +39,7 @@ None ...@@ -40,7 +39,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p17831515175518"><a name="p17831515175518"></a><a name="p17831515175518"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p17831515175518"><a name="p17831515175518"></a><a name="p17831515175518"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p12783115145518"><a name="p12783115145518"></a><a name="p12783115145518"></a>Language associated with the locale.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p12783115145518"><a name="p12783115145518"></a><a name="p12783115145518"></a>Language associated with the locale, for example, <strong id="b6789165520289"><a name="b6789165520289"></a><a name="b6789165520289"></a>zh</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row18783101512558"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p197832015125519"><a name="p197832015125519"></a><a name="p197832015125519"></a>script</p> <tr id="row18783101512558"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p197832015125519"><a name="p197832015125519"></a><a name="p197832015125519"></a>script</p>
...@@ -51,7 +50,7 @@ None ...@@ -51,7 +50,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p207831615115519"><a name="p207831615115519"></a><a name="p207831615115519"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p207831615115519"><a name="p207831615115519"></a><a name="p207831615115519"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p1878311155553"><a name="p1878311155553"></a><a name="p1878311155553"></a>Script type of the language.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p1878311155553"><a name="p1878311155553"></a><a name="p1878311155553"></a>Script type of the language, for example, <strong id="b14643185102915"><a name="b14643185102915"></a><a name="b14643185102915"></a>Hans</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row11401739287"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p131413393816"><a name="p131413393816"></a><a name="p131413393816"></a>region</p> <tr id="row11401739287"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p131413393816"><a name="p131413393816"></a><a name="p131413393816"></a>region</p>
...@@ -62,7 +61,7 @@ None ...@@ -62,7 +61,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p16936114313107"><a name="p16936114313107"></a><a name="p16936114313107"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p16936114313107"><a name="p16936114313107"></a><a name="p16936114313107"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p16141183916818"><a name="p16141183916818"></a><a name="p16141183916818"></a>Region associated with the locale.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p16141183916818"><a name="p16141183916818"></a><a name="p16141183916818"></a>Region associated with the locale, for example, <strong id="b4307013162914"><a name="b4307013162914"></a><a name="b4307013162914"></a>CN</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row324144214819"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p5245421082"><a name="p5245421082"></a><a name="p5245421082"></a>baseName</p> <tr id="row324144214819"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p5245421082"><a name="p5245421082"></a><a name="p5245421082"></a>baseName</p>
...@@ -73,7 +72,7 @@ None ...@@ -73,7 +72,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p055911448108"><a name="p055911448108"></a><a name="p055911448108"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p055911448108"><a name="p055911448108"></a><a name="p055911448108"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p4246421818"><a name="p4246421818"></a><a name="p4246421818"></a>Basic information about the locale.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p4246421818"><a name="p4246421818"></a><a name="p4246421818"></a>Basic key information about the locale, which consists of the language, script, and region, for example, <strong id="b13800919142819"><a name="b13800919142819"></a><a name="b13800919142819"></a>zh-Hans-CN</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row2182164417817"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1318214441889"><a name="p1318214441889"></a><a name="p1318214441889"></a>caseFirst</p> <tr id="row2182164417817"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1318214441889"><a name="p1318214441889"></a><a name="p1318214441889"></a>caseFirst</p>
...@@ -84,7 +83,7 @@ None ...@@ -84,7 +83,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p119084591015"><a name="p119084591015"></a><a name="p119084591015"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p119084591015"><a name="p119084591015"></a><a name="p119084591015"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p111822441087"><a name="p111822441087"></a><a name="p111822441087"></a>Whether case is taken into account for the locale's collation rules.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p111822441087"><a name="p111822441087"></a><a name="p111822441087"></a>Whether case is taken into account for the locale's collation rules. The value can be <strong id="b1072474043720"><a name="b1072474043720"></a><a name="b1072474043720"></a>upper</strong>, <strong id="b590544419371"><a name="b590544419371"></a><a name="b590544419371"></a>lower</strong>, or <strong id="b51211246193710"><a name="b51211246193710"></a><a name="b51211246193710"></a>false</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row616319461180"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1416310461486"><a name="p1416310461486"></a><a name="p1416310461486"></a>calendar</p> <tr id="row616319461180"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1416310461486"><a name="p1416310461486"></a><a name="p1416310461486"></a>calendar</p>
...@@ -95,7 +94,7 @@ None ...@@ -95,7 +94,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p667234511012"><a name="p667234511012"></a><a name="p667234511012"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p667234511012"><a name="p667234511012"></a><a name="p667234511012"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p1916315466811"><a name="p1916315466811"></a><a name="p1916315466811"></a>Calendar for the locale.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p1916315466811"><a name="p1916315466811"></a><a name="p1916315466811"></a>Calendar for the locale. The value can be <strong id="b1435117148383"><a name="b1435117148383"></a><a name="b1435117148383"></a>buddhist</strong>, <strong id="b20559101743815"><a name="b20559101743815"></a><a name="b20559101743815"></a>chinese</strong>, <strong id="b2697922173810"><a name="b2697922173810"></a><a name="b2697922173810"></a>coptic</strong>, <strong id="b09517154394"><a name="b09517154394"></a><a name="b09517154394"></a>dangi</strong>, <strong id="b197531733919"><a name="b197531733919"></a><a name="b197531733919"></a>ethioaa</strong>, <strong id="b426418182397"><a name="b426418182397"></a><a name="b426418182397"></a>ethiopic</strong>, <strong id="b4451219143915"><a name="b4451219143915"></a><a name="b4451219143915"></a>gregory</strong>, <strong id="b18925112220399"><a name="b18925112220399"></a><a name="b18925112220399"></a>hebrew</strong>, <strong id="b17677122563910"><a name="b17677122563910"></a><a name="b17677122563910"></a>indian</strong>, <strong id="b10905152663910"><a name="b10905152663910"></a><a name="b10905152663910"></a>islamic</strong>, <strong id="b1290583113396"><a name="b1290583113396"></a><a name="b1290583113396"></a>islamic-umalqura</strong>, <strong id="b132143519397"><a name="b132143519397"></a><a name="b132143519397"></a>islamic-tbla</strong>, <strong id="b332533923910"><a name="b332533923910"></a><a name="b332533923910"></a>islamic-civil</strong>, <strong id="b7453174273915"><a name="b7453174273915"></a><a name="b7453174273915"></a>islamic-rgsa</strong>, <strong id="b111815446396"><a name="b111815446396"></a><a name="b111815446396"></a>iso8601</strong>, <strong id="b2040316458398"><a name="b2040316458398"></a><a name="b2040316458398"></a>japanese</strong>, <strong id="b18626194623920"><a name="b18626194623920"></a><a name="b18626194623920"></a>persian</strong>, <strong id="b6918205033912"><a name="b6918205033912"></a><a name="b6918205033912"></a>roc</strong>, or <strong id="b10416214400"><a name="b10416214400"></a><a name="b10416214400"></a>islamicc</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row97016482083"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p570124810815"><a name="p570124810815"></a><a name="p570124810815"></a>collation</p> <tr id="row97016482083"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p570124810815"><a name="p570124810815"></a><a name="p570124810815"></a>collation</p>
...@@ -106,7 +105,7 @@ None ...@@ -106,7 +105,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1327834619106"><a name="p1327834619106"></a><a name="p1327834619106"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1327834619106"><a name="p1327834619106"></a><a name="p1327834619106"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p117094811816"><a name="p117094811816"></a><a name="p117094811816"></a>Collation rules for the locale.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p117094811816"><a name="p117094811816"></a><a name="p117094811816"></a>Collation rules for the locale. The value can be any of the following: <strong id="b141438489413"><a name="b141438489413"></a><a name="b141438489413"></a>big5han</strong>, <strong id="b8428849194115"><a name="b8428849194115"></a><a name="b8428849194115"></a>compat</strong>, <strong id="b189492504419"><a name="b189492504419"></a><a name="b189492504419"></a>dict</strong>, <strong id="b1351145204116"><a name="b1351145204116"></a><a name="b1351145204116"></a>direct</strong>, <strong id="b2670453204120"><a name="b2670453204120"></a><a name="b2670453204120"></a>ducet</strong>, <strong id="b94632552410"><a name="b94632552410"></a><a name="b94632552410"></a>eor</strong>, <strong id="b14468145984112"><a name="b14468145984112"></a><a name="b14468145984112"></a>gb2312</strong>, <strong id="b83801058144120"><a name="b83801058144120"></a><a name="b83801058144120"></a>phonebk</strong>, <strong id="b16471119427"><a name="b16471119427"></a><a name="b16471119427"></a>phonetic</strong>, <strong id="b2317627421"><a name="b2317627421"></a><a name="b2317627421"></a>pinyin</strong>, <strong id="b8457734421"><a name="b8457734421"></a><a name="b8457734421"></a>reformed</strong>, <strong id="b117796417427"><a name="b117796417427"></a><a name="b117796417427"></a>searchjl</strong>, <strong id="b188476512427"><a name="b188476512427"></a><a name="b188476512427"></a>stroke</strong>, <strong id="b1054516714426"><a name="b1054516714426"></a><a name="b1054516714426"></a>trad</strong>, <strong id="b9689924217"><a name="b9689924217"></a><a name="b9689924217"></a>unihan</strong>, and <strong id="b9511191018422"><a name="b9511191018422"></a><a name="b9511191018422"></a>zhuyin</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row22661650989"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p826710501284"><a name="p826710501284"></a><a name="p826710501284"></a>hourCycle</p> <tr id="row22661650989"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p826710501284"><a name="p826710501284"></a><a name="p826710501284"></a>hourCycle</p>
...@@ -117,7 +116,7 @@ None ...@@ -117,7 +116,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p692464614109"><a name="p692464614109"></a><a name="p692464614109"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p692464614109"><a name="p692464614109"></a><a name="p692464614109"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p19267155017816"><a name="p19267155017816"></a><a name="p19267155017816"></a>Time system for the locale.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p19267155017816"><a name="p19267155017816"></a><a name="p19267155017816"></a>Time system for the locale. The value can be <strong id="b5426114354519"><a name="b5426114354519"></a><a name="b5426114354519"></a>h11</strong>, <strong id="b1042634354518"><a name="b1042634354518"></a><a name="b1042634354518"></a>h12</strong>, <strong id="b144261943124515"><a name="b144261943124515"></a><a name="b144261943124515"></a>h23</strong>, or <strong id="b1442694354510"><a name="b1442694354510"></a><a name="b1442694354510"></a>h24</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row738595216815"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p133851452181"><a name="p133851452181"></a><a name="p133851452181"></a>numberingSystem</p> <tr id="row738595216815"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p133851452181"><a name="p133851452181"></a><a name="p133851452181"></a>numberingSystem</p>
...@@ -128,7 +127,7 @@ None ...@@ -128,7 +127,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p9827647161017"><a name="p9827647161017"></a><a name="p9827647161017"></a>No</p> <td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p9827647161017"><a name="p9827647161017"></a><a name="p9827647161017"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p63855529817"><a name="p63855529817"></a><a name="p63855529817"></a>Numbering system for the locale.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p63855529817"><a name="p63855529817"></a><a name="p63855529817"></a>Numbering system for the locale. The value can be any of the following: <strong id="b17496243124313"><a name="b17496243124313"></a><a name="b17496243124313"></a>adlm</strong>, <strong id="b54211451436"><a name="b54211451436"></a><a name="b54211451436"></a>ahom</strong>, <strong id="b9186246134312"><a name="b9186246134312"></a><a name="b9186246134312"></a>arab</strong>, <strong id="b1945411476434"><a name="b1945411476434"></a><a name="b1945411476434"></a>arabext</strong>, <strong id="b38241448174312"><a name="b38241448174312"></a><a name="b38241448174312"></a>bali</strong>, <strong id="b41541750174316"><a name="b41541750174316"></a><a name="b41541750174316"></a>beng</strong>, <strong id="b1502105213432"><a name="b1502105213432"></a><a name="b1502105213432"></a>bhks</strong>, <strong id="b298325424310"><a name="b298325424310"></a><a name="b298325424310"></a>brah</strong>, <strong id="b95351956164310"><a name="b95351956164310"></a><a name="b95351956164310"></a>cakm</strong>, <strong id="b181752584438"><a name="b181752584438"></a><a name="b181752584438"></a>cham</strong>, <strong id="b3394703448"><a name="b3394703448"></a><a name="b3394703448"></a>deva</strong>, <strong id="b59441912441"><a name="b59441912441"></a><a name="b59441912441"></a>diak</strong>, <strong id="b42983384419"><a name="b42983384419"></a><a name="b42983384419"></a>fullwide</strong>, <strong id="b129375144418"><a name="b129375144418"></a><a name="b129375144418"></a>gong</strong>, <strong id="b636815644413"><a name="b636815644413"></a><a name="b636815644413"></a>gonm</strong>, <strong id="b18617157104414"><a name="b18617157104414"></a><a name="b18617157104414"></a>gujr</strong>, <strong id="b1255559174419"><a name="b1255559174419"></a><a name="b1255559174419"></a>guru</strong>, <strong id="b19727910144415"><a name="b19727910144415"></a><a name="b19727910144415"></a>hanidec</strong>, <strong id="b178511411124419"><a name="b178511411124419"></a><a name="b178511411124419"></a>hmng</strong>, <strong id="b6174414124413"><a name="b6174414124413"></a><a name="b6174414124413"></a>hmnp</strong>, <strong id="b7736141514412"><a name="b7736141514412"></a><a name="b7736141514412"></a>java</strong>, <strong id="b392101784418"><a name="b392101784418"></a><a name="b392101784418"></a>kali</strong>, <strong id="b74001118144416"><a name="b74001118144416"></a><a name="b74001118144416"></a>khmr</strong>, <strong id="b468001944420"><a name="b468001944420"></a><a name="b468001944420"></a>knda</strong>, <strong id="b139511420164416"><a name="b139511420164416"></a><a name="b139511420164416"></a>lana</strong>, <strong id="b464220229445"><a name="b464220229445"></a><a name="b464220229445"></a>lanatham</strong>, <strong id="b72835619451"><a name="b72835619451"></a><a name="b72835619451"></a>laoo</strong>, <strong id="b12408158124513"><a name="b12408158124513"></a><a name="b12408158124513"></a>latn</strong>, <strong id="b20157410114519"><a name="b20157410114519"></a><a name="b20157410114519"></a>lepc</strong>, <strong id="b127911811134516"><a name="b127911811134516"></a><a name="b127911811134516"></a>limb</strong>, <strong id="b652314131451"><a name="b652314131451"></a><a name="b652314131451"></a>mathbold</strong>, <strong id="b16795216164519"><a name="b16795216164519"></a><a name="b16795216164519"></a>mathdbl</strong>, <strong id="b1762515150457"><a name="b1762515150457"></a><a name="b1762515150457"></a>mathmono</strong>, <strong id="b18181418154517"><a name="b18181418154517"></a><a name="b18181418154517"></a>mathsanb</strong>, <strong id="b984962414449"><a name="b984962414449"></a><a name="b984962414449"></a>mathsans</strong>, <strong id="b58395114518"><a name="b58395114518"></a><a name="b58395114518"></a>mlym</strong>, <strong id="b892713104513"><a name="b892713104513"></a><a name="b892713104513"></a>modi</strong>, <strong id="b16707823459"><a name="b16707823459"></a><a name="b16707823459"></a>mong</strong>, <strong id="b3484101194520"><a name="b3484101194520"></a><a name="b3484101194520"></a>mroo</strong>, <strong id="b154461204452"><a name="b154461204452"></a><a name="b154461204452"></a>mtei</strong>, <strong id="b18172759154417"><a name="b18172759154417"></a><a name="b18172759154417"></a>mymr</strong>, <strong id="b82845814443"><a name="b82845814443"></a><a name="b82845814443"></a>mymrshan</strong>, <strong id="b164205718442"><a name="b164205718442"></a><a name="b164205718442"></a>mymrtlng</strong>, <strong id="b8663122534418"><a name="b8663122534418"></a><a name="b8663122534418"></a>newa</strong>, <strong id="b111391041144417"><a name="b111391041144417"></a><a name="b111391041144417"></a>nkoo</strong>, <strong id="b124843426444"><a name="b124843426444"></a><a name="b124843426444"></a>olck</strong>, <strong id="b77851143114411"><a name="b77851143114411"></a><a name="b77851143114411"></a>orya</strong>, <strong id="b12972144164415"><a name="b12972144164415"></a><a name="b12972144164415"></a>osma</strong>, <strong id="b146814468446"><a name="b146814468446"></a><a name="b146814468446"></a>rohg</strong>, <strong id="b161990488444"><a name="b161990488444"></a><a name="b161990488444"></a>saur</strong>, <strong id="b55887516448"><a name="b55887516448"></a><a name="b55887516448"></a>segment</strong>, <strong id="b146836503443"><a name="b146836503443"></a><a name="b146836503443"></a>shrd</strong>, <strong id="b15477849144416"><a name="b15477849144416"></a><a name="b15477849144416"></a>sind</strong>, <strong id="b3155115310448"><a name="b3155115310448"></a><a name="b3155115310448"></a>sinh</strong>, <strong id="b1643055416448"><a name="b1643055416448"></a><a name="b1643055416448"></a>sora</strong>, <strong id="b1282095512444"><a name="b1282095512444"></a><a name="b1282095512444"></a>sund</strong>, <strong id="b965592694415"><a name="b965592694415"></a><a name="b965592694415"></a>takr</strong>, <strong id="b33171228114416"><a name="b33171228114416"></a><a name="b33171228114416"></a>talu</strong>, <strong id="b58803064419"><a name="b58803064419"></a><a name="b58803064419"></a>tamldec</strong>, <strong id="b8752631134414"><a name="b8752631134414"></a><a name="b8752631134414"></a>telu</strong>, <strong id="b333123394417"><a name="b333123394417"></a><a name="b333123394417"></a>thai</strong>, <strong id="b20611334144414"><a name="b20611334144414"></a><a name="b20611334144414"></a>tibt</strong>, <strong id="b20948335184415"><a name="b20948335184415"></a><a name="b20948335184415"></a>tirh</strong>, <strong id="b18452193716447"><a name="b18452193716447"></a><a name="b18452193716447"></a>vaii</strong>, <strong id="b5681238174410"><a name="b5681238174410"></a><a name="b5681238174410"></a>wara</strong>, and <strong id="b995703944412"><a name="b995703944412"></a><a name="b995703944412"></a>wcho</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row1471125410817"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1571120541820"><a name="p1571120541820"></a><a name="p1571120541820"></a>numeric</p> <tr id="row1471125410817"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1571120541820"><a name="p1571120541820"></a><a name="p1571120541820"></a>numeric</p>
...@@ -145,9 +144,9 @@ None ...@@ -145,9 +144,9 @@ None
</tbody> </tbody>
</table> </table>
### constructor<a name="section32282618302"></a> ### constructor<a name="section1128371911114"></a>
constructor\(locale: string, options?:options\) constructor\(locale: string, options?: options\)
Creates a **Locale** object. Creates a **Locale** object.
...@@ -173,15 +172,6 @@ Creates a **Locale** object. ...@@ -173,15 +172,6 @@ Creates a **Locale** object.
<td class="cellrowborder" valign="top" width="57.37%" headers="mcps1.1.5.1.4 "><p id="p69671631796"><a name="p69671631796"></a><a name="p69671631796"></a>A string containing locale information, including the language, optional script, and locale.</p> <td class="cellrowborder" valign="top" width="57.37%" headers="mcps1.1.5.1.4 "><p id="p69671631796"><a name="p69671631796"></a><a name="p69671631796"></a>A string containing locale information, including the language, optional script, and locale.</p>
</td> </td>
</tr> </tr>
<tr id="row14743191495712"><td class="cellrowborder" valign="top" width="8.81%" headers="mcps1.1.5.1.1 "><p id="p11743111475719"><a name="p11743111475719"></a><a name="p11743111475719"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="27.11%" headers="mcps1.1.5.1.2 "><p id="p1274415142572"><a name="p1274415142572"></a><a name="p1274415142572"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="6.710000000000001%" headers="mcps1.1.5.1.3 "><p id="p6744181425719"><a name="p6744181425719"></a><a name="p6744181425719"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="57.37%" headers="mcps1.1.5.1.4 "><p id="p1974414145576"><a name="p1974414145576"></a><a name="p1974414145576"></a>Options for creating the <strong id="b182446451078"><a name="b182446451078"></a><a name="b182446451078"></a>Locale</strong> object.</p>
</td>
</tr>
</tbody> </tbody>
</table> </table>
...@@ -193,7 +183,7 @@ Creates a **Locale** object. ...@@ -193,7 +183,7 @@ Creates a **Locale** object.
``` ```
### toString<a name="section6361163518520"></a> ### toString<a name="section67805581415"></a>
toString\(\): string toString\(\): string
...@@ -225,7 +215,7 @@ Converts locale information to a string. ...@@ -225,7 +215,7 @@ Converts locale information to a string.
``` ```
### maximize<a name="section16459237152"></a> ### maximize<a name="section7383202531417"></a>
maximize\(\): Locale maximize\(\): Locale
...@@ -240,7 +230,7 @@ Maximizes information of the **Locale** object. If the script and locale infor ...@@ -240,7 +230,7 @@ Maximizes information of the **Locale** object. If the script and locale infor
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="row941112231572"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p341102317718"><a name="p341102317718"></a><a name="p341102317718"></a>Locale</p> <tbody><tr id="row941112231572"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p341102317718"><a name="p341102317718"></a><a name="p341102317718"></a><a href="#section422715643011">Locale</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p1341122314711"><a name="p1341122314711"></a><a name="p1341122314711"></a><strong id="b20993192011115"><a name="b20993192011115"></a><a name="b20993192011115"></a>Locale</strong> object with the maximized information.</p> <td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p1341122314711"><a name="p1341122314711"></a><a name="p1341122314711"></a><strong id="b20993192011115"><a name="b20993192011115"></a><a name="b20993192011115"></a>Locale</strong> object with the maximized information.</p>
</td> </td>
...@@ -257,7 +247,7 @@ Maximizes information of the **Locale** object. If the script and locale infor ...@@ -257,7 +247,7 @@ Maximizes information of the **Locale** object. If the script and locale infor
``` ```
### minimize<a name="section8112183915517"></a> ### minimize<a name="section1712717486146"></a>
minimize\(\): Locale minimize\(\): Locale
...@@ -272,7 +262,7 @@ Minimizes information of the **Locale** object. If the script and locale infor ...@@ -272,7 +262,7 @@ Minimizes information of the **Locale** object. If the script and locale infor
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="row1183218227818"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p483210226819"><a name="p483210226819"></a><a name="p483210226819"></a>Locale</p> <tbody><tr id="row1183218227818"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p483210226819"><a name="p483210226819"></a><a name="p483210226819"></a><a href="#section422715643011">Locale</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p17832222781"><a name="p17832222781"></a><a name="p17832222781"></a><strong id="b1847413194717"><a name="b1847413194717"></a><a name="b1847413194717"></a>Locale</strong> object with the minimized information.</p> <td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p17832222781"><a name="p17832222781"></a><a name="p17832222781"></a><strong id="b1847413194717"><a name="b1847413194717"></a><a name="b1847413194717"></a>Locale</strong> object with the minimized information.</p>
</td> </td>
...@@ -291,9 +281,9 @@ Minimizes information of the **Locale** object. If the script and locale infor ...@@ -291,9 +281,9 @@ Minimizes information of the **Locale** object. If the script and locale infor
## DateTimeFormat<a name="section164003264319"></a> ## DateTimeFormat<a name="section164003264319"></a>
### constructor<a name="section740052693112"></a> ### constructor<a name="section8176222111510"></a>
constructor\(locale: string, options?:DateTimeOptions\) constructor\(locale: string, options?: DateTimeOptions\)
Creates a **DateTimeOptions** object for the specified locale. Creates a **DateTimeOptions** object for the specified locale.
...@@ -321,11 +311,11 @@ Creates a **DateTimeOptions** object for the specified locale. ...@@ -321,11 +311,11 @@ Creates a **DateTimeOptions** object for the specified locale.
</tr> </tr>
<tr id="row056902210325"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p145697223321"><a name="p145697223321"></a><a name="p145697223321"></a>options</p> <tr id="row056902210325"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p145697223321"><a name="p145697223321"></a><a name="p145697223321"></a>options</p>
</td> </td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p956962219323"><a name="p956962219323"></a><a name="p956962219323"></a><a href="#section12882825611">DateTimeOptions</a></p> <td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p956962219323"><a name="p956962219323"></a><a name="p956962219323"></a><a href="#section1193171023919">DateTimeOptions</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p195695222325"><a name="p195695222325"></a><a name="p195695222325"></a>No</p> <td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p195695222325"><a name="p195695222325"></a><a name="p195695222325"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p8569922103214"><a name="p8569922103214"></a><a name="p8569922103214"></a>Options of the <strong id="b791972343913"><a name="b791972343913"></a><a name="b791972343913"></a>DateTimeFormat</strong> object.</p> <td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p8569922103214"><a name="p8569922103214"></a><a name="p8569922103214"></a>Options for creating a <strong id="b578411480289"><a name="b578411480289"></a><a name="b578411480289"></a>DateTimeFormat</strong> object.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -339,9 +329,9 @@ Creates a **DateTimeOptions** object for the specified locale. ...@@ -339,9 +329,9 @@ Creates a **DateTimeOptions** object for the specified locale.
``` ```
### constructor<a name="section1400182613114"></a> ### constructor<a name="section1974813464158"></a>
constructor\(locales: Array<string\>, options?:DateTimeOptions\) constructor\(locales: Array<string\>, options?: DateTimeOptions\)
Creates a **DateTimeOptions** object for the specified array of locales. Creates a **DateTimeOptions** object for the specified array of locales.
...@@ -369,11 +359,11 @@ Creates a **DateTimeOptions** object for the specified array of locales. ...@@ -369,11 +359,11 @@ Creates a **DateTimeOptions** object for the specified array of locales.
</tr> </tr>
<tr id="row23000715337"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p133007743315"><a name="p133007743315"></a><a name="p133007743315"></a>options</p> <tr id="row23000715337"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p133007743315"><a name="p133007743315"></a><a name="p133007743315"></a>options</p>
</td> </td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p83001783320"><a name="p83001783320"></a><a name="p83001783320"></a><a href="#section12882825611">DateTimeOptions</a></p> <td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p83001783320"><a name="p83001783320"></a><a name="p83001783320"></a><a href="#section1193171023919">DateTimeOptions</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p230013713339"><a name="p230013713339"></a><a name="p230013713339"></a>No</p> <td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p230013713339"><a name="p230013713339"></a><a name="p230013713339"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p20300374333"><a name="p20300374333"></a><a name="p20300374333"></a>Options of the <strong id="b1251125411394"><a name="b1251125411394"></a><a name="b1251125411394"></a>DateTimeFormat</strong> object.</p> <td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p20300374333"><a name="p20300374333"></a><a name="p20300374333"></a>Options for creating a <strong id="b12484834152817"><a name="b12484834152817"></a><a name="b12484834152817"></a>DateTimeFormat</strong> object.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -387,9 +377,9 @@ Creates a **DateTimeOptions** object for the specified array of locales. ...@@ -387,9 +377,9 @@ Creates a **DateTimeOptions** object for the specified array of locales.
``` ```
### format<a name="section1840262614313"></a> ### format<a name="section86991113167"></a>
format\(date: Date\): string; format\(date: Date\): string
Formats the specified date and time. Formats the specified date and time.
...@@ -445,9 +435,9 @@ Formats the specified date and time. ...@@ -445,9 +435,9 @@ Formats the specified date and time.
``` ```
### formatRange<a name="section4402132614312"></a> ### formatRange<a name="section134812186167"></a>
formatRange\(fromDate: Date, toDate: Date\): string; formatRange\(fromDate: Date, toDate: Date\): string
Formats the specified date range. Formats the specified date range.
...@@ -513,11 +503,11 @@ Formats the specified date range. ...@@ -513,11 +503,11 @@ Formats the specified date range.
``` ```
### resolvedOptions<a name="section1093513817123"></a> ### resolvedOptions<a name="section95181531161610"></a>
resolvedOptions\(\): DateTimeOptions resolvedOptions\(\): DateTimeOptions
Obtains the options of the **DateTimeFormat** object. Obtains the formatting options for **DateTimeFormat** object.
- Return values - Return values
...@@ -528,9 +518,9 @@ Obtains the options of the **DateTimeFormat** object. ...@@ -528,9 +518,9 @@ Obtains the options of the **DateTimeFormat** object.
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="row393643871210"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p9936163816125"><a name="p9936163816125"></a><a name="p9936163816125"></a><a href="#section12882825611">DateTimeOptions</a></p> <tbody><tr id="row393643871210"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p9936163816125"><a name="p9936163816125"></a><a name="p9936163816125"></a><a href="#section1193171023919">DateTimeOptions</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p13936143812129"><a name="p13936143812129"></a><a name="p13936143812129"></a>Options of the <strong id="b18434201619431"><a name="b18434201619431"></a><a name="b18434201619431"></a>DateTimeFormat</strong> object.</p> <td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p13936143812129"><a name="p13936143812129"></a><a name="p13936143812129"></a>Formatting options for <strong id="b18434201619431"><a name="b18434201619431"></a><a name="b18434201619431"></a>DateTimeFormat</strong> objects.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -545,193 +535,7 @@ Obtains the options of the **DateTimeFormat** object. ...@@ -545,193 +535,7 @@ Obtains the options of the **DateTimeFormat** object.
``` ```
## NumberFormat<a name="section10453336123119"></a> ## DateTimeOptions<a name="section1193171023919"></a>
### constructor<a name="section14453163693117"></a>
constructor\(locale: string, options?:NumberOptions\)
Creates a **NumberFormat** object for the specified locale.
Parameters
<a name="table830832401619"></a>
<table><thead align="left"><tr id="row23081824181616"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p1930892416168"><a name="p1930892416168"></a><a name="p1930892416168"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p14308112431619"><a name="p14308112431619"></a><a name="p14308112431619"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p173081324151614"><a name="p173081324151614"></a><a name="p173081324151614"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p123092024101615"><a name="p123092024101615"></a><a name="p123092024101615"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row14309192401619"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p03096245167"><a name="p03096245167"></a><a name="p03096245167"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p73094243167"><a name="p73094243167"></a><a name="p73094243167"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p5309192461611"><a name="p5309192461611"></a><a name="p5309192461611"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p133091924181620"><a name="p133091924181620"></a><a name="p133091924181620"></a>A string containing locale information, including the language, optional script, and locale.</p>
</td>
</tr>
<tr id="row133091924171615"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p53091824181619"><a name="p53091824181619"></a><a name="p53091824181619"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p7309424171618"><a name="p7309424171618"></a><a name="p7309424171618"></a><a href="#section7200123494410">NumberOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p3309202414168"><a name="p3309202414168"></a><a name="p3309202414168"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p6309202413162"><a name="p6309202413162"></a><a name="p6309202413162"></a>Options of the <strong id="b1971631024419"><a name="b1971631024419"></a><a name="b1971631024419"></a>NumberFormat</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
```
### constructor<a name="section54533363319"></a>
constructor\(locales: Array<string\>, options?:NumberOptions\)
Creates a **NumberFormat** object for the specified array of locales.
- Parameters
<a name="table1886184401618"></a>
<table><thead align="left"><tr id="row68615446163"><th class="cellrowborder" valign="top" width="10.73326248671626%" id="mcps1.1.5.1.1"><p id="p88611446168"><a name="p88611446168"></a><a name="p88611446168"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="23.29243551347696%" id="mcps1.1.5.1.2"><p id="p12861644191616"><a name="p12861644191616"></a><a name="p12861644191616"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p7861174419169"><a name="p7861174419169"></a><a name="p7861174419169"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p14862744191618"><a name="p14862744191618"></a><a name="p14862744191618"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row20862544191620"><td class="cellrowborder" valign="top" width="10.73326248671626%" headers="mcps1.1.5.1.1 "><p id="p3862344191619"><a name="p3862344191619"></a><a name="p3862344191619"></a>locales</p>
</td>
<td class="cellrowborder" valign="top" width="23.29243551347696%" headers="mcps1.1.5.1.2 "><p id="p28621044131614"><a name="p28621044131614"></a><a name="p28621044131614"></a>Array&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1086211440167"><a name="p1086211440167"></a><a name="p1086211440167"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p386234417161"><a name="p386234417161"></a><a name="p386234417161"></a>An array of strings containing locale information.</p>
</td>
</tr>
<tr id="row986254461614"><td class="cellrowborder" valign="top" width="10.73326248671626%" headers="mcps1.1.5.1.1 "><p id="p88621344181616"><a name="p88621344181616"></a><a name="p88621344181616"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="23.29243551347696%" headers="mcps1.1.5.1.2 "><p id="p486284417168"><a name="p486284417168"></a><a name="p486284417168"></a><a href="#section7200123494410">NumberOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1986216442160"><a name="p1986216442160"></a><a name="p1986216442160"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p4862104421615"><a name="p4862104421615"></a><a name="p4862104421615"></a>Options of the <strong id="b269374612509"><a name="b269374612509"></a><a name="b269374612509"></a>NumberFormat</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
```
### format<a name="section94551936203114"></a>
format\(number: number\): string;
Formats a number.
- Parameters
<a name="table1459775620188"></a>
<table><thead align="left"><tr id="row059755610184"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p19597205631810"><a name="p19597205631810"></a><a name="p19597205631810"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p18597856161815"><a name="p18597856161815"></a><a name="p18597856161815"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p1859735614180"><a name="p1859735614180"></a><a name="p1859735614180"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p145971656101812"><a name="p145971656101812"></a><a name="p145971656101812"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row11597195617186"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p1959755631818"><a name="p1959755631818"></a><a name="p1959755631818"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p12597155613186"><a name="p12597155613186"></a><a name="p12597155613186"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1559865612186"><a name="p1559865612186"></a><a name="p1559865612186"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p95981556161816"><a name="p95981556161816"></a><a name="p95981556161816"></a>Number to be formatted.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table114558369317"></a>
<table><thead align="left"><tr id="row12455133613312"><th class="cellrowborder" valign="top" width="17.01%" id="mcps1.1.3.1.1"><p id="p545515361318"><a name="p545515361318"></a><a name="p545515361318"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="82.99%" id="mcps1.1.3.1.2"><p id="p145512362311"><a name="p145512362311"></a><a name="p145512362311"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row3455193617316"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p745523619314"><a name="p745523619314"></a><a name="p745523619314"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p1745519363315"><a name="p1745519363315"></a><a name="p1745519363315"></a>Formatted number.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.format(1223);
```
### resolvedOptions<a name="section13178203919219"></a>
resolvedOptions\(\): NumberOptions
Obtains the options of the **NumberFormat** object.
- Return values
<a name="table917813992117"></a>
<table><thead align="left"><tr id="row1717883992116"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p91781539202115"><a name="p91781539202115"></a><a name="p91781539202115"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p151783399216"><a name="p151783399216"></a><a name="p151783399216"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1217814392214"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p317903912212"><a name="p317903912212"></a><a name="p317903912212"></a><a href="#section7200123494410">NumberOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p111794399212"><a name="p111794399212"></a><a name="p111794399212"></a>Options of the <strong id="b520810418585"><a name="b520810418585"></a><a name="b520810418585"></a>NumberFormat</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.resolvedOptions();
```
## DateTimeOptions<a name="section12882825611"></a>
Provides the options for the **DateTimeFormat** object. Provides the options for the **DateTimeFormat** object.
...@@ -756,7 +560,7 @@ Provides the options for the **DateTimeFormat** object. ...@@ -756,7 +560,7 @@ Provides the options for the **DateTimeFormat** object.
</td> </td>
<td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.1.6.1.4 "><p id="p659715430317"><a name="p659715430317"></a><a name="p659715430317"></a>No</p> <td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.1.6.1.4 "><p id="p659715430317"><a name="p659715430317"></a><a name="p659715430317"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p12781024121115"><a name="p12781024121115"></a><a name="p12781024121115"></a>Locale information.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p12781024121115"><a name="p12781024121115"></a><a name="p12781024121115"></a>Locale, for example, <strong id="b102881715194619"><a name="b102881715194619"></a><a name="b102881715194619"></a>zh-Hans-CN</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row185973435316"><td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.1.6.1.1 "><p id="p1559710432310"><a name="p1559710432310"></a><a name="p1559710432310"></a>dateStyle</p> <tr id="row185973435316"><td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.1.6.1.1 "><p id="p1559710432310"><a name="p1559710432310"></a><a name="p1559710432310"></a>dateStyle</p>
...@@ -789,7 +593,7 @@ Provides the options for the **DateTimeFormat** object. ...@@ -789,7 +593,7 @@ Provides the options for the **DateTimeFormat** object.
</td> </td>
<td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.1.6.1.4 "><p id="p799415812103"><a name="p799415812103"></a><a name="p799415812103"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.1.6.1.4 "><p id="p799415812103"><a name="p799415812103"></a><a name="p799415812103"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p4532135152710"><a name="p4532135152710"></a><a name="p4532135152710"></a>Hour cycle. The value can be <strong id="b74813597718"><a name="b74813597718"></a><a name="b74813597718"></a>h11</strong>, <strong id="b816924486"><a name="b816924486"></a><a name="b816924486"></a>h12</strong>, <strong id="b18410665814"><a name="b18410665814"></a><a name="b18410665814"></a>h23</strong>, or <strong id="b65635131782"><a name="b65635131782"></a><a name="b65635131782"></a>h24</strong>.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p4532135152710"><a name="p4532135152710"></a><a name="p4532135152710"></a>Time system for the locale. The value can be <strong id="b74813597718"><a name="b74813597718"></a><a name="b74813597718"></a>h11</strong>, <strong id="b816924486"><a name="b816924486"></a><a name="b816924486"></a>h12</strong>, <strong id="b18410665814"><a name="b18410665814"></a><a name="b18410665814"></a>h23</strong>, or <strong id="b65635131782"><a name="b65635131782"></a><a name="b65635131782"></a>h24</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row46421838277"><td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.1.6.1.1 "><p id="p136422030277"><a name="p136422030277"></a><a name="p136422030277"></a>timeZone</p> <tr id="row46421838277"><td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.1.6.1.1 "><p id="p136422030277"><a name="p136422030277"></a><a name="p136422030277"></a>timeZone</p>
...@@ -811,7 +615,7 @@ Provides the options for the **DateTimeFormat** object. ...@@ -811,7 +615,7 @@ Provides the options for the **DateTimeFormat** object.
</td> </td>
<td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.1.6.1.4 "><p id="p95865961017"><a name="p95865961017"></a><a name="p95865961017"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.1.6.1.4 "><p id="p95865961017"><a name="p95865961017"></a><a name="p95865961017"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p16897111192718"><a name="p16897111192718"></a><a name="p16897111192718"></a>Numbering system.</p> <td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p16897111192718"><a name="p16897111192718"></a><a name="p16897111192718"></a>Numbering system for the locale. The value can be any of the following: <strong id="b175687166469"><a name="b175687166469"></a><a name="b175687166469"></a>adlm</strong>, <strong id="b956821654620"><a name="b956821654620"></a><a name="b956821654620"></a>ahom</strong>, <strong id="b656911613465"><a name="b656911613465"></a><a name="b656911613465"></a>arab</strong>, <strong id="b19569161654616"><a name="b19569161654616"></a><a name="b19569161654616"></a>arabext</strong>, <strong id="b135708168467"><a name="b135708168467"></a><a name="b135708168467"></a>bali</strong>, <strong id="b20570101613464"><a name="b20570101613464"></a><a name="b20570101613464"></a>beng</strong>, <strong id="b2570121620462"><a name="b2570121620462"></a><a name="b2570121620462"></a>bhks</strong>, <strong id="b15711616124610"><a name="b15711616124610"></a><a name="b15711616124610"></a>brah</strong>, <strong id="b7571416194620"><a name="b7571416194620"></a><a name="b7571416194620"></a>cakm</strong>, <strong id="b257214165462"><a name="b257214165462"></a><a name="b257214165462"></a>cham</strong>, <strong id="b157313166467"><a name="b157313166467"></a><a name="b157313166467"></a>deva</strong>, <strong id="b5573121619465"><a name="b5573121619465"></a><a name="b5573121619465"></a>diak</strong>, <strong id="b18574191644619"><a name="b18574191644619"></a><a name="b18574191644619"></a>fullwide</strong>, <strong id="b257401614612"><a name="b257401614612"></a><a name="b257401614612"></a>gong</strong>, <strong id="b757521624618"><a name="b757521624618"></a><a name="b757521624618"></a>gonm</strong>, <strong id="b6575151617462"><a name="b6575151617462"></a><a name="b6575151617462"></a>gujr</strong>, <strong id="b155765168461"><a name="b155765168461"></a><a name="b155765168461"></a>guru</strong>, <strong id="b18576316194617"><a name="b18576316194617"></a><a name="b18576316194617"></a>hanidec</strong>, <strong id="b857711161463"><a name="b857711161463"></a><a name="b857711161463"></a>hmng</strong>, <strong id="b1157718162463"><a name="b1157718162463"></a><a name="b1157718162463"></a>hmnp</strong>, <strong id="b1957718169461"><a name="b1957718169461"></a><a name="b1957718169461"></a>java</strong>, <strong id="b9578416184611"><a name="b9578416184611"></a><a name="b9578416184611"></a>kali</strong>, <strong id="b11578171612462"><a name="b11578171612462"></a><a name="b11578171612462"></a>khmr</strong>, <strong id="b35788162468"><a name="b35788162468"></a><a name="b35788162468"></a>knda</strong>, <strong id="b1357931614469"><a name="b1357931614469"></a><a name="b1357931614469"></a>lana</strong>, <strong id="b12579181616468"><a name="b12579181616468"></a><a name="b12579181616468"></a>lanatham</strong>, <strong id="b15580516194612"><a name="b15580516194612"></a><a name="b15580516194612"></a>laoo</strong>, <strong id="b1058013163462"><a name="b1058013163462"></a><a name="b1058013163462"></a>latn</strong>, <strong id="b155802161464"><a name="b155802161464"></a><a name="b155802161464"></a>lepc</strong>, <strong id="b458121624620"><a name="b458121624620"></a><a name="b458121624620"></a>limb</strong>, <strong id="b758171613467"><a name="b758171613467"></a><a name="b758171613467"></a>mathbold</strong>, <strong id="b135817163466"><a name="b135817163466"></a><a name="b135817163466"></a>mathdbl</strong>, <strong id="b158251611463"><a name="b158251611463"></a><a name="b158251611463"></a>mathmono</strong>, <strong id="b14582191618461"><a name="b14582191618461"></a><a name="b14582191618461"></a>mathsanb</strong>, <strong id="b55834163464"><a name="b55834163464"></a><a name="b55834163464"></a>mathsans</strong>, <strong id="b85832169466"><a name="b85832169466"></a><a name="b85832169466"></a>mlym</strong>, <strong id="b185831016124614"><a name="b185831016124614"></a><a name="b185831016124614"></a>modi</strong>, <strong id="b858415166464"><a name="b858415166464"></a><a name="b858415166464"></a>mong</strong>, <strong id="b2058420161469"><a name="b2058420161469"></a><a name="b2058420161469"></a>mroo</strong>, <strong id="b1658531619463"><a name="b1658531619463"></a><a name="b1658531619463"></a>mtei</strong>, <strong id="b25851163464"><a name="b25851163464"></a><a name="b25851163464"></a>mymr</strong>, <strong id="b3585181644615"><a name="b3585181644615"></a><a name="b3585181644615"></a>mymrshan</strong>, <strong id="b15862163465"><a name="b15862163465"></a><a name="b15862163465"></a>mymrtlng</strong>, <strong id="b158621614610"><a name="b158621614610"></a><a name="b158621614610"></a>newa</strong>, <strong id="b16586116204611"><a name="b16586116204611"></a><a name="b16586116204611"></a>nkoo</strong>, <strong id="b1058791674610"><a name="b1058791674610"></a><a name="b1058791674610"></a>olck</strong>, <strong id="b55872166462"><a name="b55872166462"></a><a name="b55872166462"></a>orya</strong>, <strong id="b95885169461"><a name="b95885169461"></a><a name="b95885169461"></a>osma</strong>, <strong id="b10588131654614"><a name="b10588131654614"></a><a name="b10588131654614"></a>rohg</strong>, <strong id="b65889160466"><a name="b65889160466"></a><a name="b65889160466"></a>saur</strong>, <strong id="b16589141634616"><a name="b16589141634616"></a><a name="b16589141634616"></a>segment</strong>, <strong id="b12589116174614"><a name="b12589116174614"></a><a name="b12589116174614"></a>shrd</strong>, <strong id="b75901916174616"><a name="b75901916174616"></a><a name="b75901916174616"></a>sind</strong>, <strong id="b2590131674612"><a name="b2590131674612"></a><a name="b2590131674612"></a>sinh</strong>, <strong id="b459011165465"><a name="b459011165465"></a><a name="b459011165465"></a>sora</strong>, <strong id="b9591516144615"><a name="b9591516144615"></a><a name="b9591516144615"></a>sund</strong>, <strong id="b1059151604611"><a name="b1059151604611"></a><a name="b1059151604611"></a>takr</strong>, <strong id="b10592816184612"><a name="b10592816184612"></a><a name="b10592816184612"></a>talu</strong>, <strong id="b145921316144612"><a name="b145921316144612"></a><a name="b145921316144612"></a>tamldec</strong>, <strong id="b7592316134616"><a name="b7592316134616"></a><a name="b7592316134616"></a>telu</strong>, <strong id="b165932016114614"><a name="b165932016114614"></a><a name="b165932016114614"></a>thai</strong>, <strong id="b185931716134613"><a name="b185931716134613"></a><a name="b185931716134613"></a>tibt</strong>, <strong id="b959351614462"><a name="b959351614462"></a><a name="b959351614462"></a>tirh</strong>, <strong id="b13594016154615"><a name="b13594016154615"></a><a name="b13594016154615"></a>vaii</strong>, <strong id="b12594141619462"><a name="b12594141619462"></a><a name="b12594141619462"></a>wara</strong>, and <strong id="b1159518167462"><a name="b1159518167462"></a><a name="b1159518167462"></a>wcho</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row1190575820265"><td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.1.6.1.1 "><p id="p1590585832620"><a name="p1590585832620"></a><a name="p1590585832620"></a>hour12</p> <tr id="row1190575820265"><td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.1.6.1.1 "><p id="p1590585832620"><a name="p1590585832620"></a><a name="p1590585832620"></a>hour12</p>
...@@ -960,94 +764,291 @@ Provides the options for the **DateTimeFormat** object. ...@@ -960,94 +764,291 @@ Provides the options for the **DateTimeFormat** object.
</tbody> </tbody>
</table> </table>
## NumberOptions<a name="section7200123494410"></a> ## NumberFormat<a name="section10453336123119"></a>
Provides the device capability. ### constructor<a name="section14453163693117"></a>
<a name="table16201103444414"></a> constructor\(locale: string, options?: NumberOptions\)
<table><thead align="left"><tr id="row620123444415"><th class="cellrowborder" valign="top" width="19.15%" id="mcps1.1.6.1.1"><p id="p1620163494418"><a name="p1620163494418"></a><a name="p1620163494418"></a>Name</p>
</th> Creates a **NumberFormat** object for the specified locale.
<th class="cellrowborder" valign="top" width="10.8%" id="mcps1.1.6.1.2"><p id="p15201434124418"><a name="p15201434124418"></a><a name="p15201434124418"></a>Parameter Type</p>
</th> - Parameters
<th class="cellrowborder" valign="top" width="6.12%" id="mcps1.1.6.1.3"><p id="p13201123484412"><a name="p13201123484412"></a><a name="p13201123484412"></a>Readable</p>
</th> <a name="table830832401619"></a>
<th class="cellrowborder" valign="top" width="11.48%" id="mcps1.1.6.1.4"><p id="p1320123412448"><a name="p1320123412448"></a><a name="p1320123412448"></a>Writable</p> <table><thead align="left"><tr id="row23081824181616"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p1930892416168"><a name="p1930892416168"></a><a name="p1930892416168"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="52.449999999999996%" id="mcps1.1.6.1.5"><p id="p9201934134419"><a name="p9201934134419"></a><a name="p9201934134419"></a>Description</p> <th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p14308112431619"><a name="p14308112431619"></a><a name="p14308112431619"></a>Type</p>
</th> </th>
</tr> <th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p173081324151614"><a name="p173081324151614"></a><a name="p173081324151614"></a>Mandatory</p>
</thead> </th>
<tbody><tr id="row3201103494415"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p20826502499"><a name="p20826502499"></a><a name="p20826502499"></a>locale</p> <th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p123092024101615"><a name="p123092024101615"></a><a name="p123092024101615"></a>Description</p>
</td> </th>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p120143413448"><a name="p120143413448"></a><a name="p120143413448"></a>string</p> </tr>
</td> </thead>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p18201334114417"><a name="p18201334114417"></a><a name="p18201334114417"></a>Yes</p> <tbody><tr id="row14309192401619"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p03096245167"><a name="p03096245167"></a><a name="p03096245167"></a>locale</p>
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p420113347441"><a name="p420113347441"></a><a name="p420113347441"></a>No</p> <td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p73094243167"><a name="p73094243167"></a><a name="p73094243167"></a>string</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p8689133923516"><a name="p8689133923516"></a><a name="p8689133923516"></a>Locale information.</p> <td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p5309192461611"><a name="p5309192461611"></a><a name="p5309192461611"></a>Yes</p>
</td> </td>
</tr> <td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p133091924181620"><a name="p133091924181620"></a><a name="p133091924181620"></a>A string containing locale information, including the language, optional script, and locale.</p>
<tr id="row19202113413445"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p82028341442"><a name="p82028341442"></a><a name="p82028341442"></a>currency</p> </td>
</td> </tr>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p20653010153513"><a name="p20653010153513"></a><a name="p20653010153513"></a>string</p> <tr id="row133091924171615"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p53091824181619"><a name="p53091824181619"></a><a name="p53091824181619"></a>options</p>
</td> </td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p142021134164413"><a name="p142021134164413"></a><a name="p142021134164413"></a>Yes</p> <td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p7309424171618"><a name="p7309424171618"></a><a name="p7309424171618"></a><a href="#section1359213512417">NumberOptions</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p163525312356"><a name="p163525312356"></a><a name="p163525312356"></a>Yes</p> <td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p3309202414168"><a name="p3309202414168"></a><a name="p3309202414168"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p112021341446"><a name="p112021341446"></a><a name="p112021341446"></a>Currency for the specified locale.</p> <td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p6309202413162"><a name="p6309202413162"></a><a name="p6309202413162"></a>Options for creating a <strong id="b1971631024419"><a name="b1971631024419"></a><a name="b1971631024419"></a>NumberFormat</strong> object.</p>
</td> </td>
</tr> </tr>
<tr id="row181651537153112"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p6165137193115"><a name="p6165137193115"></a><a name="p6165137193115"></a>currencySign</p> </tbody>
</td> </table>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p26712105353"><a name="p26712105353"></a><a name="p26712105353"></a>string</p>
</td> - Example
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p20320102716353"><a name="p20320102716353"></a><a name="p20320102716353"></a>Yes</p>
</td> ```
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p53383279356"><a name="p53383279356"></a><a name="p53383279356"></a>Yes</p> var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
</td> ```
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p416563763115"><a name="p416563763115"></a><a name="p416563763115"></a>Currency symbol.</p>
</td>
</tr> ### constructor<a name="section54533363319"></a>
<tr id="row02243913313"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p922173963114"><a name="p922173963114"></a><a name="p922173963114"></a>currencyDisplay</p>
</td> constructor\(locales: Array<string\>, options?: NumberOptions\)
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p146881510173515"><a name="p146881510173515"></a><a name="p146881510173515"></a>string</p>
</td> Creates a **NumberFormat** object for the specified array of locales.
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p18355122710359"><a name="p18355122710359"></a><a name="p18355122710359"></a>Yes</p>
</td> - Parameters
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p237211277353"><a name="p237211277353"></a><a name="p237211277353"></a>Yes</p>
</td> <a name="table1886184401618"></a>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p15225393313"><a name="p15225393313"></a><a name="p15225393313"></a>Currency display mode. The value can be <strong id="b166165019292"><a name="b166165019292"></a><a name="b166165019292"></a>symbol</strong>, <strong id="b86561052142914"><a name="b86561052142914"></a><a name="b86561052142914"></a>narrowSymbol</strong>, <strong id="b35020562295"><a name="b35020562295"></a><a name="b35020562295"></a>code</strong>, or <strong id="b19851200143017"><a name="b19851200143017"></a><a name="b19851200143017"></a>name</strong>.</p> <table><thead align="left"><tr id="row68615446163"><th class="cellrowborder" valign="top" width="10.73326248671626%" id="mcps1.1.5.1.1"><p id="p88611446168"><a name="p88611446168"></a><a name="p88611446168"></a>Name</p>
</td> </th>
</tr> <th class="cellrowborder" valign="top" width="23.29243551347696%" id="mcps1.1.5.1.2"><p id="p12861644191616"><a name="p12861644191616"></a><a name="p12861644191616"></a>Type</p>
<tr id="row04912413319"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p349204110313"><a name="p349204110313"></a><a name="p349204110313"></a>unit</p> </th>
</td> <th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p7861174419169"><a name="p7861174419169"></a><a name="p7861174419169"></a>Mandatory</p>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p4705161018358"><a name="p4705161018358"></a><a name="p4705161018358"></a>string</p> </th>
</td> <th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p14862744191618"><a name="p14862744191618"></a><a name="p14862744191618"></a>Description</p>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p938862743518"><a name="p938862743518"></a><a name="p938862743518"></a>Yes</p> </th>
</td> </tr>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p440462743518"><a name="p440462743518"></a><a name="p440462743518"></a>Yes</p> </thead>
</td> <tbody><tr id="row20862544191620"><td class="cellrowborder" valign="top" width="10.73326248671626%" headers="mcps1.1.5.1.1 "><p id="p3862344191619"><a name="p3862344191619"></a><a name="p3862344191619"></a>locales</p>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p2499410317"><a name="p2499410317"></a><a name="p2499410317"></a>Currency unit.</p> </td>
</td> <td class="cellrowborder" valign="top" width="23.29243551347696%" headers="mcps1.1.5.1.2 "><p id="p28621044131614"><a name="p28621044131614"></a><a name="p28621044131614"></a>Array&lt;string&gt;</p>
</tr> </td>
<tr id="row17758199133220"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p13758129103211"><a name="p13758129103211"></a><a name="p13758129103211"></a>unitDisplay</p> <td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1086211440167"><a name="p1086211440167"></a><a name="p1086211440167"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1772013101356"><a name="p1772013101356"></a><a name="p1772013101356"></a>string</p> <td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p386234417161"><a name="p386234417161"></a><a name="p386234417161"></a>An array of strings containing locale information.</p>
</td> </td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p1342018270359"><a name="p1342018270359"></a><a name="p1342018270359"></a>Yes</p> </tr>
</td> <tr id="row986254461614"><td class="cellrowborder" valign="top" width="10.73326248671626%" headers="mcps1.1.5.1.1 "><p id="p88621344181616"><a name="p88621344181616"></a><a name="p88621344181616"></a>options</p>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p184363276352"><a name="p184363276352"></a><a name="p184363276352"></a>Yes</p> </td>
</td> <td class="cellrowborder" valign="top" width="23.29243551347696%" headers="mcps1.1.5.1.2 "><p id="p486284417168"><a name="p486284417168"></a><a name="p486284417168"></a><a href="#section1359213512417">NumberOptions</a></p>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p8758119193219"><a name="p8758119193219"></a><a name="p8758119193219"></a>Currency unit display format. The value can be <strong id="b951522863410"><a name="b951522863410"></a><a name="b951522863410"></a>long</strong>, <strong id="b352212803414"><a name="b352212803414"></a><a name="b352212803414"></a>short</strong>, or <strong id="b6522172812347"><a name="b6522172812347"></a><a name="b6522172812347"></a>medium</strong>.</p> </td>
</td> <td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1986216442160"><a name="p1986216442160"></a><a name="p1986216442160"></a>No</p>
</tr> </td>
<tr id="row1244996173217"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p845017623210"><a name="p845017623210"></a><a name="p845017623210"></a>signDisplay</p> <td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p4862104421615"><a name="p4862104421615"></a><a name="p4862104421615"></a>Options for creating a <strong id="b728515579"><a name="b728515579"></a><a name="b728515579"></a>NumberFormat</strong> object.</p>
</td> </td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1373617108355"><a name="p1373617108355"></a><a name="p1373617108355"></a>string</p> </tr>
</td> </tbody>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p545216279357"><a name="p545216279357"></a><a name="p545216279357"></a>Yes</p> </table>
- Example
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
```
### format<a name="section94551936203114"></a>
format\(number: number\): string;
Formats a number.
- Parameters
<a name="table1459775620188"></a>
<table><thead align="left"><tr id="row059755610184"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p19597205631810"><a name="p19597205631810"></a><a name="p19597205631810"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p18597856161815"><a name="p18597856161815"></a><a name="p18597856161815"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p1859735614180"><a name="p1859735614180"></a><a name="p1859735614180"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p145971656101812"><a name="p145971656101812"></a><a name="p145971656101812"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row11597195617186"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p1959755631818"><a name="p1959755631818"></a><a name="p1959755631818"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p12597155613186"><a name="p12597155613186"></a><a name="p12597155613186"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1559865612186"><a name="p1559865612186"></a><a name="p1559865612186"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p95981556161816"><a name="p95981556161816"></a><a name="p95981556161816"></a>Number to be formatted.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table114558369317"></a>
<table><thead align="left"><tr id="row12455133613312"><th class="cellrowborder" valign="top" width="17.01%" id="mcps1.1.3.1.1"><p id="p545515361318"><a name="p545515361318"></a><a name="p545515361318"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="82.99%" id="mcps1.1.3.1.2"><p id="p145512362311"><a name="p145512362311"></a><a name="p145512362311"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row3455193617316"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p745523619314"><a name="p745523619314"></a><a name="p745523619314"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p1745519363315"><a name="p1745519363315"></a><a name="p1745519363315"></a>Formatted number.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.format(1223);
```
### resolvedOptions<a name="section13178203919219"></a>
resolvedOptions\(\): NumberOptions
Obtains the options of the **NumberFormat** object.
- Return values
<a name="table917813992117"></a>
<table><thead align="left"><tr id="row1717883992116"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p91781539202115"><a name="p91781539202115"></a><a name="p91781539202115"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p151783399216"><a name="p151783399216"></a><a name="p151783399216"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1217814392214"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p317903912212"><a name="p317903912212"></a><a name="p317903912212"></a><a href="#section1359213512417">NumberOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p111794399212"><a name="p111794399212"></a><a name="p111794399212"></a>Options of the <strong id="b520810418585"><a name="b520810418585"></a><a name="b520810418585"></a>NumberFormat</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.resolvedOptions();
```
## NumberOptions<a name="section1359213512417"></a>
Provides the device capability.
<a name="table16201103444414"></a>
<table><thead align="left"><tr id="row620123444415"><th class="cellrowborder" valign="top" width="19.15%" id="mcps1.1.6.1.1"><p id="p1620163494418"><a name="p1620163494418"></a><a name="p1620163494418"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.8%" id="mcps1.1.6.1.2"><p id="p15201434124418"><a name="p15201434124418"></a><a name="p15201434124418"></a>Parameter Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.12%" id="mcps1.1.6.1.3"><p id="p13201123484412"><a name="p13201123484412"></a><a name="p13201123484412"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.48%" id="mcps1.1.6.1.4"><p id="p1320123412448"><a name="p1320123412448"></a><a name="p1320123412448"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.449999999999996%" id="mcps1.1.6.1.5"><p id="p9201934134419"><a name="p9201934134419"></a><a name="p9201934134419"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row3201103494415"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p20826502499"><a name="p20826502499"></a><a name="p20826502499"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p120143413448"><a name="p120143413448"></a><a name="p120143413448"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p18201334114417"><a name="p18201334114417"></a><a name="p18201334114417"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p420113347441"><a name="p420113347441"></a><a name="p420113347441"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p8689133923516"><a name="p8689133923516"></a><a name="p8689133923516"></a>Locale, for example, <strong id="b19118162894619"><a name="b19118162894619"></a><a name="b19118162894619"></a>zh-Hans-CN</strong>.</p>
</td>
</tr>
<tr id="row19202113413445"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p82028341442"><a name="p82028341442"></a><a name="p82028341442"></a>currency</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p20653010153513"><a name="p20653010153513"></a><a name="p20653010153513"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p142021134164413"><a name="p142021134164413"></a><a name="p142021134164413"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p163525312356"><a name="p163525312356"></a><a name="p163525312356"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p112021341446"><a name="p112021341446"></a><a name="p112021341446"></a>Currency unit, for example, <strong id="b12457545486"><a name="b12457545486"></a><a name="b12457545486"></a>EUR</strong>, <strong id="b64587414813"><a name="b64587414813"></a><a name="b64587414813"></a>CNY</strong>, or <strong id="b54584494818"><a name="b54584494818"></a><a name="b54584494818"></a>USD</strong>.</p>
</td>
</tr>
<tr id="row181651537153112"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p6165137193115"><a name="p6165137193115"></a><a name="p6165137193115"></a>currencySign</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p26712105353"><a name="p26712105353"></a><a name="p26712105353"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p20320102716353"><a name="p20320102716353"></a><a name="p20320102716353"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p53383279356"><a name="p53383279356"></a><a name="p53383279356"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p416563763115"><a name="p416563763115"></a><a name="p416563763115"></a>Currency unit symbol. The value can be <strong id="b164291039184719"><a name="b164291039184719"></a><a name="b164291039184719"></a>symbol</strong>, <strong id="b164441164714"><a name="b164441164714"></a><a name="b164441164714"></a>narrowSymbol</strong>, <strong id="b3388194264718"><a name="b3388194264718"></a><a name="b3388194264718"></a>code</strong>, or <strong id="b136441643144710"><a name="b136441643144710"></a><a name="b136441643144710"></a>name</strong>.</p>
</td>
</tr>
<tr id="row02243913313"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p922173963114"><a name="p922173963114"></a><a name="p922173963114"></a>currencyDisplay</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p146881510173515"><a name="p146881510173515"></a><a name="p146881510173515"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p18355122710359"><a name="p18355122710359"></a><a name="p18355122710359"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p237211277353"><a name="p237211277353"></a><a name="p237211277353"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p15225393313"><a name="p15225393313"></a><a name="p15225393313"></a>Currency display mode. The value can be <strong id="b166165019292"><a name="b166165019292"></a><a name="b166165019292"></a>symbol</strong>, <strong id="b86561052142914"><a name="b86561052142914"></a><a name="b86561052142914"></a>narrowSymbol</strong>, <strong id="b35020562295"><a name="b35020562295"></a><a name="b35020562295"></a>code</strong>, or <strong id="b19851200143017"><a name="b19851200143017"></a><a name="b19851200143017"></a>name</strong>.</p>
</td>
</tr>
<tr id="row04912413319"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p349204110313"><a name="p349204110313"></a><a name="p349204110313"></a>unit</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p4705161018358"><a name="p4705161018358"></a><a name="p4705161018358"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p938862743518"><a name="p938862743518"></a><a name="p938862743518"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p440462743518"><a name="p440462743518"></a><a name="p440462743518"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p2499410317"><a name="p2499410317"></a><a name="p2499410317"></a>Unit name, for example, <strong id="b184611418134816"><a name="b184611418134816"></a><a name="b184611418134816"></a>meter</strong>, <strong id="b155751719124813"><a name="b155751719124813"></a><a name="b155751719124813"></a>inch</strong>, or <strong id="b118611820184814"><a name="b118611820184814"></a><a name="b118611820184814"></a>hectare</strong>.</p>
</td>
</tr>
<tr id="row17758199133220"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p13758129103211"><a name="p13758129103211"></a><a name="p13758129103211"></a>unitDisplay</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1772013101356"><a name="p1772013101356"></a><a name="p1772013101356"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p1342018270359"><a name="p1342018270359"></a><a name="p1342018270359"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p184363276352"><a name="p184363276352"></a><a name="p184363276352"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p8758119193219"><a name="p8758119193219"></a><a name="p8758119193219"></a>Unit display format. The value can be <strong id="b951522863410"><a name="b951522863410"></a><a name="b951522863410"></a>long</strong>, <strong id="b352212803414"><a name="b352212803414"></a><a name="b352212803414"></a>short</strong>, or <strong id="b6522172812347"><a name="b6522172812347"></a><a name="b6522172812347"></a>medium</strong>.</p>
</td>
</tr>
<tr id="row1767262114313"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p167311211833"><a name="p167311211833"></a><a name="p167311211833"></a>unitUsage</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p16739211316"><a name="p16739211316"></a><a name="p16739211316"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p124821631735"><a name="p124821631735"></a><a name="p124821631735"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p11482183119318"><a name="p11482183119318"></a><a name="p11482183119318"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p9673182115319"><a name="p9673182115319"></a><a name="p9673182115319"></a>Unit use case. The value can be any of the following: <strong id="b198241928114915"><a name="b198241928114915"></a><a name="b198241928114915"></a>default</strong>, <strong id="b9782163255015"><a name="b9782163255015"></a><a name="b9782163255015"></a>area-land-agricult</strong>, <strong id="b569422805016"><a name="b569422805016"></a><a name="b569422805016"></a>area-land-commercl</strong>, <strong id="b1716218239505"><a name="b1716218239505"></a><a name="b1716218239505"></a>area-land-residntl</strong>, <strong id="b7274525125011"><a name="b7274525125011"></a><a name="b7274525125011"></a>length-person</strong>, <strong id="b31216407506"><a name="b31216407506"></a><a name="b31216407506"></a>length-person-small</strong>, <strong id="b12400164245015"><a name="b12400164245015"></a><a name="b12400164245015"></a>length-rainfall</strong>, <strong id="b13888154455014"><a name="b13888154455014"></a><a name="b13888154455014"></a>length-road</strong>, <strong id="b104001548115017"><a name="b104001548115017"></a><a name="b104001548115017"></a>length-road-small</strong>, <strong id="b08888714507"><a name="b08888714507"></a><a name="b08888714507"></a>length-snowfall</strong>, <strong id="b19361451165013"><a name="b19361451165013"></a><a name="b19361451165013"></a>length-vehicle</strong>, <strong id="b149381648504"><a name="b149381648504"></a><a name="b149381648504"></a>length-visiblty</strong>, <strong id="b188073025016"><a name="b188073025016"></a><a name="b188073025016"></a>length-visiblty-small</strong>, <strong id="b16415115754914"><a name="b16415115754914"></a><a name="b16415115754914"></a>length-person-informal</strong>, <strong id="b12793195324910"><a name="b12793195324910"></a><a name="b12793195324910"></a>length-person-small-informal</strong>, <strong id="b2023424813498"><a name="b2023424813498"></a><a name="b2023424813498"></a>length-road-informal</strong>, <strong id="b1297273994918"><a name="b1297273994918"></a><a name="b1297273994918"></a>speed-road-travel</strong>, <strong id="b7416204214495"><a name="b7416204214495"></a><a name="b7416204214495"></a>speed-wind</strong>, <strong id="b48644624917"><a name="b48644624917"></a><a name="b48644624917"></a>temperature-person</strong>, <strong id="b83961637184916"><a name="b83961637184916"></a><a name="b83961637184916"></a>temperature-weather</strong>, and <strong id="b19148123215491"><a name="b19148123215491"></a><a name="b19148123215491"></a>volume-vehicle-fuel</strong>.</p>
</td>
</tr>
<tr id="row1244996173217"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p845017623210"><a name="p845017623210"></a><a name="p845017623210"></a>signDisplay</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1373617108355"><a name="p1373617108355"></a><a name="p1373617108355"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p545216279357"><a name="p545216279357"></a><a name="p545216279357"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p746817276358"><a name="p746817276358"></a><a name="p746817276358"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p746817276358"><a name="p746817276358"></a><a name="p746817276358"></a>Yes</p>
</td> </td>
...@@ -1106,7 +1107,7 @@ Provides the device capability. ...@@ -1106,7 +1107,7 @@ Provides the device capability.
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p96342278351"><a name="p96342278351"></a><a name="p96342278351"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p96342278351"><a name="p96342278351"></a><a name="p96342278351"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p669010518311"><a name="p669010518311"></a><a name="p669010518311"></a>Numbering system.</p> <td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p669010518311"><a name="p669010518311"></a><a name="p669010518311"></a>Numbering system for the locale. The value can be any of the following: <strong id="b12826155595015"><a name="b12826155595015"></a><a name="b12826155595015"></a>adlm</strong>, <strong id="b4828055185013"><a name="b4828055185013"></a><a name="b4828055185013"></a>ahom</strong>, <strong id="b483065510503"><a name="b483065510503"></a><a name="b483065510503"></a>arab</strong>, <strong id="b38321055185013"><a name="b38321055185013"></a><a name="b38321055185013"></a>arabext</strong>, <strong id="b1583495565011"><a name="b1583495565011"></a><a name="b1583495565011"></a>bali</strong>, <strong id="b88351555509"><a name="b88351555509"></a><a name="b88351555509"></a>beng</strong>, <strong id="b18837155165015"><a name="b18837155165015"></a><a name="b18837155165015"></a>bhks</strong>, <strong id="b1983935514506"><a name="b1983935514506"></a><a name="b1983935514506"></a>brah</strong>, <strong id="b88401855175015"><a name="b88401855175015"></a><a name="b88401855175015"></a>cakm</strong>, <strong id="b684245510505"><a name="b684245510505"></a><a name="b684245510505"></a>cham</strong>, <strong id="b19844105512507"><a name="b19844105512507"></a><a name="b19844105512507"></a>deva</strong>, <strong id="b16846105595019"><a name="b16846105595019"></a><a name="b16846105595019"></a>diak</strong>, <strong id="b9848555145011"><a name="b9848555145011"></a><a name="b9848555145011"></a>fullwide</strong>, <strong id="b884925525019"><a name="b884925525019"></a><a name="b884925525019"></a>gong</strong>, <strong id="b19851555175010"><a name="b19851555175010"></a><a name="b19851555175010"></a>gonm</strong>, <strong id="b12853125555020"><a name="b12853125555020"></a><a name="b12853125555020"></a>gujr</strong>, <strong id="b11855455155013"><a name="b11855455155013"></a><a name="b11855455155013"></a>guru</strong>, <strong id="b8856255175019"><a name="b8856255175019"></a><a name="b8856255175019"></a>hanidec</strong>, <strong id="b9858955135011"><a name="b9858955135011"></a><a name="b9858955135011"></a>hmng</strong>, <strong id="b15860955195015"><a name="b15860955195015"></a><a name="b15860955195015"></a>hmnp</strong>, <strong id="b19862255155020"><a name="b19862255155020"></a><a name="b19862255155020"></a>java</strong>, <strong id="b1686310557509"><a name="b1686310557509"></a><a name="b1686310557509"></a>kali</strong>, <strong id="b586585525013"><a name="b586585525013"></a><a name="b586585525013"></a>khmr</strong>, <strong id="b15867455145013"><a name="b15867455145013"></a><a name="b15867455145013"></a>knda</strong>, <strong id="b98692555509"><a name="b98692555509"></a><a name="b98692555509"></a>lana</strong>, <strong id="b1487125595012"><a name="b1487125595012"></a><a name="b1487125595012"></a>lanatham</strong>, <strong id="b1087295518506"><a name="b1087295518506"></a><a name="b1087295518506"></a>laoo</strong>, <strong id="b78741155115010"><a name="b78741155115010"></a><a name="b78741155115010"></a>latn</strong>, <strong id="b208769556503"><a name="b208769556503"></a><a name="b208769556503"></a>lepc</strong>, <strong id="b787835520508"><a name="b787835520508"></a><a name="b787835520508"></a>limb</strong>, <strong id="b15879155135013"><a name="b15879155135013"></a><a name="b15879155135013"></a>mathbold</strong>, <strong id="b108818556503"><a name="b108818556503"></a><a name="b108818556503"></a>mathdbl</strong>, <strong id="b19883255135014"><a name="b19883255135014"></a><a name="b19883255135014"></a>mathmono</strong>, <strong id="b988545516507"><a name="b988545516507"></a><a name="b988545516507"></a>mathsanb</strong>, <strong id="b7886125512508"><a name="b7886125512508"></a><a name="b7886125512508"></a>mathsans</strong>, <strong id="b20888555175015"><a name="b20888555175015"></a><a name="b20888555175015"></a>mlym</strong>, <strong id="b289015585018"><a name="b289015585018"></a><a name="b289015585018"></a>modi</strong>, <strong id="b189295585012"><a name="b189295585012"></a><a name="b189295585012"></a>mong</strong>, <strong id="b689575545011"><a name="b689575545011"></a><a name="b689575545011"></a>mroo</strong>, <strong id="b48961255175019"><a name="b48961255175019"></a><a name="b48961255175019"></a>mtei</strong>, <strong id="b11898155518500"><a name="b11898155518500"></a><a name="b11898155518500"></a>mymr</strong>, <strong id="b1790075585017"><a name="b1790075585017"></a><a name="b1790075585017"></a>mymrshan</strong>, <strong id="b7902855155014"><a name="b7902855155014"></a><a name="b7902855155014"></a>mymrtlng</strong>, <strong id="b8903855145019"><a name="b8903855145019"></a><a name="b8903855145019"></a>newa</strong>, <strong id="b69051955165016"><a name="b69051955165016"></a><a name="b69051955165016"></a>nkoo</strong>, <strong id="b990765511507"><a name="b990765511507"></a><a name="b990765511507"></a>olck</strong>, <strong id="b1490875525015"><a name="b1490875525015"></a><a name="b1490875525015"></a>orya</strong>, <strong id="b491016550506"><a name="b491016550506"></a><a name="b491016550506"></a>osma</strong>, <strong id="b1991255516507"><a name="b1991255516507"></a><a name="b1991255516507"></a>rohg</strong>, <strong id="b11914105511506"><a name="b11914105511506"></a><a name="b11914105511506"></a>saur</strong>, <strong id="b39156559507"><a name="b39156559507"></a><a name="b39156559507"></a>segment</strong>, <strong id="b10917195515503"><a name="b10917195515503"></a><a name="b10917195515503"></a>shrd</strong>, <strong id="b891985555017"><a name="b891985555017"></a><a name="b891985555017"></a>sind</strong>, <strong id="b139201955185012"><a name="b139201955185012"></a><a name="b139201955185012"></a>sinh</strong>, <strong id="b5922755205011"><a name="b5922755205011"></a><a name="b5922755205011"></a>sora</strong>, <strong id="b2092435519506"><a name="b2092435519506"></a><a name="b2092435519506"></a>sund</strong>, <strong id="b139260552507"><a name="b139260552507"></a><a name="b139260552507"></a>takr</strong>, <strong id="b139281554503"><a name="b139281554503"></a><a name="b139281554503"></a>talu</strong>, <strong id="b13930255135018"><a name="b13930255135018"></a><a name="b13930255135018"></a>tamldec</strong>, <strong id="b139318556501"><a name="b139318556501"></a><a name="b139318556501"></a>telu</strong>, <strong id="b793365505014"><a name="b793365505014"></a><a name="b793365505014"></a>thai</strong>, <strong id="b2935655155012"><a name="b2935655155012"></a><a name="b2935655155012"></a>tibt</strong>, <strong id="b1937055165013"><a name="b1937055165013"></a><a name="b1937055165013"></a>tirh</strong>, <strong id="b1939175519504"><a name="b1939175519504"></a><a name="b1939175519504"></a>vaii</strong>, <strong id="b3941205515505"><a name="b3941205515505"></a><a name="b3941205515505"></a>wara</strong>, and <strong id="b1943155195018"><a name="b1943155195018"></a><a name="b1943155195018"></a>wcho</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row1539618585317"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p93961258123112"><a name="p93961258123112"></a><a name="p93961258123112"></a>useGrouping</p> <tr id="row1539618585317"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p93961258123112"><a name="p93961258123112"></a><a name="p93961258123112"></a>useGrouping</p>
...@@ -1117,7 +1118,7 @@ Provides the device capability. ...@@ -1117,7 +1118,7 @@ Provides the device capability.
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p1667152753514"><a name="p1667152753514"></a><a name="p1667152753514"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p1667152753514"><a name="p1667152753514"></a><a name="p1667152753514"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p1639665815311"><a name="p1639665815311"></a><a name="p1639665815311"></a>Whether to enable grouping for display.</p> <td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p1639665815311"><a name="p1639665815311"></a><a name="p1639665815311"></a>Whether to use grouping for display.</p>
</td> </td>
</tr> </tr>
<tr id="row072885623114"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p972925613314"><a name="p972925613314"></a><a name="p972925613314"></a>miniumumIntegerDigits</p> <tr id="row072885623114"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p972925613314"><a name="p972925613314"></a><a name="p972925613314"></a>miniumumIntegerDigits</p>
...@@ -1128,7 +1129,7 @@ Provides the device capability. ...@@ -1128,7 +1129,7 @@ Provides the device capability.
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p370042710357"><a name="p370042710357"></a><a name="p370042710357"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p370042710357"><a name="p370042710357"></a><a name="p370042710357"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p372995623120"><a name="p372995623120"></a><a name="p372995623120"></a>Minimum number of integer digits.</p> <td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p1816915914299"><a name="p1816915914299"></a><a name="p1816915914299"></a>Minimum number of digits allowed in the integer part of a number. The value ranges from <strong id="b101801936183911"><a name="b101801936183911"></a><a name="b101801936183911"></a>1</strong> to <strong id="b1071513717399"><a name="b1071513717399"></a><a name="b1071513717399"></a>21</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row16189155013112"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1318945073110"><a name="p1318945073110"></a><a name="p1318945073110"></a>miniumumFractionDigits</p> <tr id="row16189155013112"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1318945073110"><a name="p1318945073110"></a><a name="p1318945073110"></a>miniumumFractionDigits</p>
...@@ -1139,7 +1140,7 @@ Provides the device capability. ...@@ -1139,7 +1140,7 @@ Provides the device capability.
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p1273214274357"><a name="p1273214274357"></a><a name="p1273214274357"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p1273214274357"><a name="p1273214274357"></a><a name="p1273214274357"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p19189195053112"><a name="p19189195053112"></a><a name="p19189195053112"></a>Minimum number of fraction digits.</p> <td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p1287821073012"><a name="p1287821073012"></a><a name="p1287821073012"></a>Minimum number of digits in the fraction part of a number. The value ranges from <strong id="b2088115413453"><a name="b2088115413453"></a><a name="b2088115413453"></a>0</strong> to <strong id="b1933025674516"><a name="b1933025674516"></a><a name="b1933025674516"></a>20</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row666184819318"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1066194810314"><a name="p1066194810314"></a><a name="p1066194810314"></a>maxiumumFractionDigits</p> <tr id="row666184819318"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1066194810314"><a name="p1066194810314"></a><a name="p1066194810314"></a>maxiumumFractionDigits</p>
...@@ -1150,7 +1151,7 @@ Provides the device capability. ...@@ -1150,7 +1151,7 @@ Provides the device capability.
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p476412763517"><a name="p476412763517"></a><a name="p476412763517"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p476412763517"><a name="p476412763517"></a><a name="p476412763517"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p1866154811315"><a name="p1866154811315"></a><a name="p1866154811315"></a>Maximum number of fraction digits.</p> <td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p1723192113302"><a name="p1723192113302"></a><a name="p1723192113302"></a>Maximum number of digits in the fraction part of a number. The value ranges from <strong id="b133767377540"><a name="b133767377540"></a><a name="b133767377540"></a>1</strong> to <strong id="b17376103717545"><a name="b17376103717545"></a><a name="b17376103717545"></a>21</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row18191543113111"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p7191134310318"><a name="p7191134310318"></a><a name="p7191134310318"></a>miniumumSignificantDigits</p> <tr id="row18191543113111"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p7191134310318"><a name="p7191134310318"></a><a name="p7191134310318"></a>miniumumSignificantDigits</p>
...@@ -1161,7 +1162,7 @@ Provides the device capability. ...@@ -1161,7 +1162,7 @@ Provides the device capability.
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p479622793511"><a name="p479622793511"></a><a name="p479622793511"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p479622793511"><a name="p479622793511"></a><a name="p479622793511"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p81919438317"><a name="p81919438317"></a><a name="p81919438317"></a>Minimum number of significant digits.</p> <td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p492643083012"><a name="p492643083012"></a><a name="p492643083012"></a>Minimum number of the least significant digits. The value ranges from <strong id="b1066413266184"><a name="b1066413266184"></a><a name="b1066413266184"></a>1</strong> to <strong id="b1674382721812"><a name="b1674382721812"></a><a name="b1674382721812"></a>21</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="row1514134520316"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p5141045153119"><a name="p5141045153119"></a><a name="p5141045153119"></a>maxiumumSignificantDigits</p> <tr id="row1514134520316"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p5141045153119"><a name="p5141045153119"></a><a name="p5141045153119"></a>maxiumumSignificantDigits</p>
...@@ -1172,9 +1173,824 @@ Provides the device capability. ...@@ -1172,9 +1173,824 @@ Provides the device capability.
</td> </td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p382912713352"><a name="p382912713352"></a><a name="p382912713352"></a>Yes</p> <td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p382912713352"><a name="p382912713352"></a><a name="p382912713352"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p11418457317"><a name="p11418457317"></a><a name="p11418457317"></a>Maximum number of significant digits.</p> <td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p9826164011305"><a name="p9826164011305"></a><a name="p9826164011305"></a>Maximum number of the least significant digits. The value ranges from <strong id="b17992744161819"><a name="b17992744161819"></a><a name="b17992744161819"></a>1</strong> to <strong id="b2992144451817"><a name="b2992144451817"></a><a name="b2992144451817"></a>21</strong>.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
## Collator<sup>8+</sup><a name="section235715217348"></a>
### constructor<sup>8+</sup><a name="section18837131612590"></a>
constructor\(\)
Creates a **Collator** object.
- Example
```
var collator = new Intl.Collator();
```
### constructor<sup>8+</sup><a name="section7598254309"></a>
constructor\(locale: string | Array<string\>, options?: CollatorOptions\)
Creates a **Collator** object based on the specified locale and options.
Parameters
<a name="table1259875413019"></a>
<table><thead align="left"><tr id="row2599155413011"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p125991854804"><a name="p125991854804"></a><a name="p125991854804"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1159910546011"><a name="p1159910546011"></a><a name="p1159910546011"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p2059916545014"><a name="p2059916545014"></a><a name="p2059916545014"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p3599155415015"><a name="p3599155415015"></a><a name="p3599155415015"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row85995547019"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p75996541301"><a name="p75996541301"></a><a name="p75996541301"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p18599105410016"><a name="p18599105410016"></a><a name="p18599105410016"></a>string|Array&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1459975411018"><a name="p1459975411018"></a><a name="p1459975411018"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p12599175415019"><a name="p12599175415019"></a><a name="p12599175415019"></a>A string containing locale information, including the language, optional script, and locale.</p>
</td>
</tr>
<tr id="row1059911541207"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p559911541807"><a name="p559911541807"></a><a name="p559911541807"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p485617734320"><a name="p485617734320"></a><a name="p485617734320"></a><a href="#section108211016144217">CollatorOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p65992541709"><a name="p65992541709"></a><a name="p65992541709"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p115991454502"><a name="p115991454502"></a><a name="p115991454502"></a>Options for creating a <strong id="b9299182502014"><a name="b9299182502014"></a><a name="b9299182502014"></a>Collator</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var collator = new Intl.Collator("zh-CN", {"localeMatcher": "lookup", "usage": "sort"});
```
### compare<sup>8+</sup><a name="section11357165253410"></a>
compare\(first: string, second: string\): number
Compares two strings based on the sorting policy of the **Collator**.
- Parameters
<a name="table1735716522346"></a>
<table><thead align="left"><tr id="row23571252113418"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p10357125220349"><a name="p10357125220349"></a><a name="p10357125220349"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1735795219342"><a name="p1735795219342"></a><a name="p1735795219342"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p6357952143412"><a name="p6357952143412"></a><a name="p6357952143412"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p43571352153410"><a name="p43571352153410"></a><a name="p43571352153410"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1635795219345"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p15357125253410"><a name="p15357125253410"></a><a name="p15357125253410"></a>first</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p935715213419"><a name="p935715213419"></a><a name="p935715213419"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p19357135233415"><a name="p19357135233415"></a><a name="p19357135233415"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p153578524344"><a name="p153578524344"></a><a name="p153578524344"></a>First string to compare.</p>
</td>
</tr>
<tr id="row535765210341"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p1335714529340"><a name="p1335714529340"></a><a name="p1335714529340"></a>second</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p11240226133812"><a name="p11240226133812"></a><a name="p11240226133812"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p1835855273414"><a name="p1835855273414"></a><a name="p1835855273414"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p835811525341"><a name="p835811525341"></a><a name="p835811525341"></a>Second string to compare.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table6691123533613"></a>
<table><thead align="left"><tr id="row14691935163611"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p16692153513369"><a name="p16692153513369"></a><a name="p16692153513369"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p11692173515369"><a name="p11692173515369"></a><a name="p11692173515369"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row16928352364"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p1080975012364"><a name="p1080975012364"></a><a name="p1080975012364"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p16564185893810"><a name="p16564185893810"></a><a name="p16564185893810"></a>Comparison result. If the value is a negative number, the first string is before the second string. If the value of number is <strong id="b1849452404716"><a name="b1849452404716"></a><a name="b1849452404716"></a>0</strong>, the first string is equal to the second string. If the value of number is a positive number, the first string is after the second string.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var collator = new intl.Collator("zh-Hans");
collator.compare("first", "second");
```
### resolvedOptions<sup>8+</sup><a name="section15243163410393"></a>
resolvedOptions\(\): CollatorOptions
Returns properties reflecting the locale and collation options of a **Collator** object.
- Return values
<a name="table162458345399"></a>
<table><thead align="left"><tr id="row4245634123916"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p1424553413393"><a name="p1424553413393"></a><a name="p1424553413393"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p32451346398"><a name="p32451346398"></a><a name="p32451346398"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row724533419397"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p24019226402"><a name="p24019226402"></a><a name="p24019226402"></a><a href="#section108211016144217">CollatorOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p13363832134013"><a name="p13363832134013"></a><a name="p13363832134013"></a>Properties of the <strong id="b4567130102118"><a name="b4567130102118"></a><a name="b4567130102118"></a>Collator</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var collator = new intl.Collator("zh-Hans");
var options = collator.resolvedOptions();
```
## CollatorOptions<sup>8+</sup><a name="section108211016144217"></a>
Represents the properties of a **Collator** object.
<a name="table172555417444"></a>
<table><thead align="left"><tr id="row7725654154416"><th class="cellrowborder" valign="top" width="19.15%" id="mcps1.1.6.1.1"><p id="p7726205484410"><a name="p7726205484410"></a><a name="p7726205484410"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.8%" id="mcps1.1.6.1.2"><p id="p19726354164418"><a name="p19726354164418"></a><a name="p19726354164418"></a>Parameter Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.12%" id="mcps1.1.6.1.3"><p id="p6726454194410"><a name="p6726454194410"></a><a name="p6726454194410"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.48%" id="mcps1.1.6.1.4"><p id="p47266544447"><a name="p47266544447"></a><a name="p47266544447"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.449999999999996%" id="mcps1.1.6.1.5"><p id="p27261954174414"><a name="p27261954174414"></a><a name="p27261954174414"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row37261854114415"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1172685417444"><a name="p1172685417444"></a><a name="p1172685417444"></a>localeMatcher</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p14726135464412"><a name="p14726135464412"></a><a name="p14726135464412"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p1572610548442"><a name="p1572610548442"></a><a name="p1572610548442"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p772635484415"><a name="p772635484415"></a><a name="p772635484415"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p17265540445"><a name="p17265540445"></a><a name="p17265540445"></a>Locale matching algorithm. The value can be <strong id="b8012135310"><a name="b8012135310"></a><a name="b8012135310"></a>lookup</strong> or <strong id="b1522311395310"><a name="b1522311395310"></a><a name="b1522311395310"></a>best fit</strong>.</p>
</td>
</tr>
<tr id="row072665474415"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p2726155417448"><a name="p2726155417448"></a><a name="p2726155417448"></a>usage</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p10726854174420"><a name="p10726854174420"></a><a name="p10726854174420"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p2072619548447"><a name="p2072619548447"></a><a name="p2072619548447"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p1572713544445"><a name="p1572713544445"></a><a name="p1572713544445"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p2727125414441"><a name="p2727125414441"></a><a name="p2727125414441"></a>Whether the comparison is for sorting or for searching. The value can be <strong id="b77011012115817"><a name="b77011012115817"></a><a name="b77011012115817"></a>sort</strong> or <strong id="b5865118135813"><a name="b5865118135813"></a><a name="b5865118135813"></a>search</strong>.</p>
</td>
</tr>
<tr id="row17727105494410"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p9727205415445"><a name="p9727205415445"></a><a name="p9727205415445"></a>sensitivity</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p18727145411443"><a name="p18727145411443"></a><a name="p18727145411443"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p87275542443"><a name="p87275542443"></a><a name="p87275542443"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p8727135414410"><a name="p8727135414410"></a><a name="p8727135414410"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p18727155414445"><a name="p18727155414445"></a><a name="p18727155414445"></a>Differences in the strings that lead to non-zero return values. The value can be <strong id="b3397820257"><a name="b3397820257"></a><a name="b3397820257"></a>base</strong>, <strong id="b3629201610510"><a name="b3629201610510"></a><a name="b3629201610510"></a>accent</strong>, <strong id="b16792189353"><a name="b16792189353"></a><a name="b16792189353"></a>case</strong>, or <strong id="b1413413810515"><a name="b1413413810515"></a><a name="b1413413810515"></a>variant</strong>.</p>
</td>
</tr>
<tr id="row5727185434416"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p472715544443"><a name="p472715544443"></a><a name="p472715544443"></a>ignorePunctuation</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p127272549446"><a name="p127272549446"></a><a name="p127272549446"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p9727165434418"><a name="p9727165434418"></a><a name="p9727165434418"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p7727185415440"><a name="p7727185415440"></a><a name="p7727185415440"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p9727754134412"><a name="p9727754134412"></a><a name="p9727754134412"></a>Whether punctuation is ignored. The value can be <strong id="b21098284611"><a name="b21098284611"></a><a name="b21098284611"></a>true</strong> or <strong id="b433311291767"><a name="b433311291767"></a><a name="b433311291767"></a>false</strong>.</p>
</td>
</tr>
<tr id="row10727454184411"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p67271754184420"><a name="p67271754184420"></a><a name="p67271754184420"></a>collation</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p47271954184417"><a name="p47271954184417"></a><a name="p47271954184417"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p1472855417446"><a name="p1472855417446"></a><a name="p1472855417446"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p19728454104418"><a name="p19728454104418"></a><a name="p19728454104418"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p0728254114411"><a name="p0728254114411"></a><a name="p0728254114411"></a>Sorting policy. The value can be any of the following: <strong id="b107216261374"><a name="b107216261374"></a><a name="b107216261374"></a>big5han</strong>, <strong id="b1853152516719"><a name="b1853152516719"></a><a name="b1853152516719"></a>compat</strong>, <strong id="b2886327076"><a name="b2886327076"></a><a name="b2886327076"></a>dict</strong>, <strong id="b1523162913713"><a name="b1523162913713"></a><a name="b1523162913713"></a>direct</strong>, <strong id="b940618222719"><a name="b940618222719"></a><a name="b940618222719"></a>ducet</strong>, <strong id="b1852022113712"><a name="b1852022113712"></a><a name="b1852022113712"></a>eor</strong>, <strong id="b1024415201718"><a name="b1024415201718"></a><a name="b1024415201718"></a>gb2312</strong>, <strong id="b292063015711"><a name="b292063015711"></a><a name="b292063015711"></a>phonebk</strong>, <strong id="b1035611323715"><a name="b1035611323715"></a><a name="b1035611323715"></a>phonetic</strong>, <strong id="b158911331279"><a name="b158911331279"></a><a name="b158911331279"></a>pinyin</strong>, <strong id="b69901034372"><a name="b69901034372"></a><a name="b69901034372"></a>reformed</strong>, <strong id="b19248336377"><a name="b19248336377"></a><a name="b19248336377"></a>searchjl</strong>, <strong id="b310583813720"><a name="b310583813720"></a><a name="b310583813720"></a>stroke</strong>, <strong id="b17644839276"><a name="b17644839276"></a><a name="b17644839276"></a>trad</strong>, <strong id="b20863640873"><a name="b20863640873"></a><a name="b20863640873"></a>unihan</strong>, and <strong id="b117413189718"><a name="b117413189718"></a><a name="b117413189718"></a>zhuyin</strong>.</p>
</td>
</tr>
<tr id="row1172814546444"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p57281054164413"><a name="p57281054164413"></a><a name="p57281054164413"></a>numeric</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p8728155404415"><a name="p8728155404415"></a><a name="p8728155404415"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p57283545442"><a name="p57283545442"></a><a name="p57283545442"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p1572818545448"><a name="p1572818545448"></a><a name="p1572818545448"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p4728185411441"><a name="p4728185411441"></a><a name="p4728185411441"></a>Whether numeric collation is used. The value can be <strong id="b20979351189"><a name="b20979351189"></a><a name="b20979351189"></a>true</strong> or <strong id="b5976351281"><a name="b5976351281"></a><a name="b5976351281"></a>false</strong>.</p>
</td>
</tr>
<tr id="row147288548449"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1472855454413"><a name="p1472855454413"></a><a name="p1472855454413"></a>caseFirst</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p872825410441"><a name="p872825410441"></a><a name="p872825410441"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p5728454184412"><a name="p5728454184412"></a><a name="p5728454184412"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p19728654134412"><a name="p19728654134412"></a><a name="p19728654134412"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p15728165414442"><a name="p15728165414442"></a><a name="p15728165414442"></a>Whether upper case or lower case is sorted first. The value can be <strong id="b9136115715911"><a name="b9136115715911"></a><a name="b9136115715911"></a>upper</strong>, <strong id="b17959711100"><a name="b17959711100"></a><a name="b17959711100"></a>lower</strong>, or <strong id="b15857137201011"><a name="b15857137201011"></a><a name="b15857137201011"></a>false</strong>.</p>
</td>
</tr>
</tbody>
</table>
## PluralRules<sup>8+</sup><a name="section723424617417"></a>
### constructor<sup>8+</sup><a name="section962717442119"></a>
constructor\(\)
Create a **PluralRules** object.
- Example
```
var pluralRules = new Intl.PluralRules();
```
### constructor<sup>8+</sup><a name="section186273446118"></a>
constructor\(locale: string | Array<string\>, options?: PluralRulesOptions\)
Creates a **PluralRules** object based on the specified locale and options.
Parameters
<a name="table6627244111119"></a>
<table><thead align="left"><tr id="row562834412111"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p1462854451114"><a name="p1462854451114"></a><a name="p1462854451114"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1762819446119"><a name="p1762819446119"></a><a name="p1762819446119"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p15628044141119"><a name="p15628044141119"></a><a name="p15628044141119"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p76286443111"><a name="p76286443111"></a><a name="p76286443111"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row7628164419115"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p8628124414113"><a name="p8628124414113"></a><a name="p8628124414113"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p862864421112"><a name="p862864421112"></a><a name="p862864421112"></a>string|Array&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p2062864441119"><a name="p2062864441119"></a><a name="p2062864441119"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p0628344161114"><a name="p0628344161114"></a><a name="p0628344161114"></a>A string containing locale information, including the language, optional script, and locale.</p>
</td>
</tr>
<tr id="row1628344191118"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p7628114421115"><a name="p7628114421115"></a><a name="p7628114421115"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p19629144491117"><a name="p19629144491117"></a><a name="p19629144491117"></a><a href="#section1841753254214">PluralRulesOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p11629134471115"><a name="p11629134471115"></a><a name="p11629134471115"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p2629134411115"><a name="p2629134411115"></a><a name="p2629134411115"></a>Options for creating a <strong id="b951941519119"><a name="b951941519119"></a><a name="b951941519119"></a>PluralRules</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var pluralRules= new Intl.PluraRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"});
```
### select<sup>8+</sup><a name="section15234174634111"></a>
select\(n: number\): string
Obtains a string that represents the singular-plural type of the specified number.
- Parameters
<a name="table72341046194119"></a>
<table><thead align="left"><tr id="row18235204612418"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p323564613414"><a name="p323564613414"></a><a name="p323564613414"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p3235346104113"><a name="p3235346104113"></a><a name="p3235346104113"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p9235146184111"><a name="p9235146184111"></a><a name="p9235146184111"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p112351546164112"><a name="p112351546164112"></a><a name="p112351546164112"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row32351946114112"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p1523524624111"><a name="p1523524624111"></a><a name="p1523524624111"></a>n</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p132354467414"><a name="p132354467414"></a><a name="p132354467414"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p8235174620414"><a name="p8235174620414"></a><a name="p8235174620414"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p101692039174312"><a name="p101692039174312"></a><a name="p101692039174312"></a>Number for which the singular-plural type is to be obtained.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table7236246114115"></a>
<table><thead align="left"><tr id="row023674613411"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p19236154610413"><a name="p19236154610413"></a><a name="p19236154610413"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p1823612467419"><a name="p1823612467419"></a><a name="p1823612467419"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row623654616412"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p923654619418"><a name="p923654619418"></a><a name="p923654619418"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p191471117444"><a name="p191471117444"></a><a name="p191471117444"></a>Singular-plural type. The options are as follows: <strong id="b1724317811219"><a name="b1724317811219"></a><a name="b1724317811219"></a>zero</strong>, <strong id="b11930511521"><a name="b11930511521"></a><a name="b11930511521"></a>one</strong>, <strong id="b1511013141520"><a name="b1511013141520"></a><a name="b1511013141520"></a>two</strong>, <strong id="b111925431425"><a name="b111925431425"></a><a name="b111925431425"></a>few</strong>, <strong id="b9636144416210"><a name="b9636144416210"></a><a name="b9636144416210"></a>many</strong>, and <strong id="b181312461219"><a name="b181312461219"></a><a name="b181312461219"></a>others</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var pluralRules = new intl.PluralRules("zh-Hans");
pluralRules.select(1);
```
## PluralRulesOptions<sup>8+</sup><a name="section1841753254214"></a>
Represents the properties of a **PluralRules** object.
<a name="table581363516811"></a>
<table><thead align="left"><tr id="row581393517817"><th class="cellrowborder" valign="top" width="19.15%" id="mcps1.1.6.1.1"><p id="p881312351783"><a name="p881312351783"></a><a name="p881312351783"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.8%" id="mcps1.1.6.1.2"><p id="p138134351288"><a name="p138134351288"></a><a name="p138134351288"></a>Parameter Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.12%" id="mcps1.1.6.1.3"><p id="p1481313351381"><a name="p1481313351381"></a><a name="p1481313351381"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.48%" id="mcps1.1.6.1.4"><p id="p28132351689"><a name="p28132351689"></a><a name="p28132351689"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.449999999999996%" id="mcps1.1.6.1.5"><p id="p7813635689"><a name="p7813635689"></a><a name="p7813635689"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row158131835687"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1181443520810"><a name="p1181443520810"></a><a name="p1181443520810"></a>localeMatcher</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1581416352086"><a name="p1581416352086"></a><a name="p1581416352086"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p9814133515816"><a name="p9814133515816"></a><a name="p9814133515816"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p12814435287"><a name="p12814435287"></a><a name="p12814435287"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p781453518814"><a name="p781453518814"></a><a name="p781453518814"></a>Locale matching algorithm. The value can be <strong id="b23681479211"><a name="b23681479211"></a><a name="b23681479211"></a>lookup</strong> or <strong id="b621814499210"><a name="b621814499210"></a><a name="b621814499210"></a>best fit</strong>.</p>
</td>
</tr>
<tr id="row381416351488"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p5814203520818"><a name="p5814203520818"></a><a name="p5814203520818"></a>type</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1981423516817"><a name="p1981423516817"></a><a name="p1981423516817"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p681414358815"><a name="p681414358815"></a><a name="p681414358815"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p208147356810"><a name="p208147356810"></a><a name="p208147356810"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p781416351785"><a name="p781416351785"></a><a name="p781416351785"></a>Sorting type. The value can be <strong id="b982732712225"><a name="b982732712225"></a><a name="b982732712225"></a>cardinal</strong> or <strong id="b31202035112217"><a name="b31202035112217"></a><a name="b31202035112217"></a>ordinal</strong>.</p>
</td>
</tr>
<tr id="row128144352083"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p181420359814"><a name="p181420359814"></a><a name="p181420359814"></a>minimumIntegerDigits</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p7814235483"><a name="p7814235483"></a><a name="p7814235483"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p1814173518813"><a name="p1814173518813"></a><a name="p1814173518813"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p18815103511810"><a name="p18815103511810"></a><a name="p18815103511810"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p188158351084"><a name="p188158351084"></a><a name="p188158351084"></a>Minimum number of digits allowed in the integer part of a number. The value ranges from <strong id="b113900459227"><a name="b113900459227"></a><a name="b113900459227"></a>1</strong> to <strong id="b839674520221"><a name="b839674520221"></a><a name="b839674520221"></a>21</strong>.</p>
</td>
</tr>
<tr id="row68158351181"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p148159351386"><a name="p148159351386"></a><a name="p148159351386"></a>minimumFractionDigits</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p181543512811"><a name="p181543512811"></a><a name="p181543512811"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p3815335288"><a name="p3815335288"></a><a name="p3815335288"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p58154351081"><a name="p58154351081"></a><a name="p58154351081"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p4815123517813"><a name="p4815123517813"></a><a name="p4815123517813"></a>Minimum number of digits in the fraction part of a number. The value ranges from <strong id="b17179105210224"><a name="b17179105210224"></a><a name="b17179105210224"></a>0</strong> to <strong id="b1018511524226"><a name="b1018511524226"></a><a name="b1018511524226"></a>20</strong>.</p>
</td>
</tr>
<tr id="row1181543517816"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p16815163519818"><a name="p16815163519818"></a><a name="p16815163519818"></a>maximumFractionDigits</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p178155357817"><a name="p178155357817"></a><a name="p178155357817"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p1481512351383"><a name="p1481512351383"></a><a name="p1481512351383"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p13815735787"><a name="p13815735787"></a><a name="p13815735787"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p1181583515811"><a name="p1181583515811"></a><a name="p1181583515811"></a>Maximum number of digits in the fraction part of a number. The value ranges from <strong id="b7831105412211"><a name="b7831105412211"></a><a name="b7831105412211"></a>1</strong> to <strong id="b1583185462220"><a name="b1583185462220"></a><a name="b1583185462220"></a>21</strong>.</p>
</td>
</tr>
<tr id="row581515351487"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p15815133518814"><a name="p15815133518814"></a><a name="p15815133518814"></a>minimumSignificantDigits</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1081683511810"><a name="p1081683511810"></a><a name="p1081683511810"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p68160359817"><a name="p68160359817"></a><a name="p68160359817"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p5816153516817"><a name="p5816153516817"></a><a name="p5816153516817"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p14816113510816"><a name="p14816113510816"></a><a name="p14816113510816"></a>Minimum number of the least significant digits. The value ranges from <strong id="b158681056172216"><a name="b158681056172216"></a><a name="b158681056172216"></a>1</strong> to <strong id="b686917568221"><a name="b686917568221"></a><a name="b686917568221"></a>21</strong>.</p>
</td>
</tr>
<tr id="row381653513815"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p881643510817"><a name="p881643510817"></a><a name="p881643510817"></a>maximumSignificantDigits</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1816735285"><a name="p1816735285"></a><a name="p1816735285"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p1981614351884"><a name="p1981614351884"></a><a name="p1981614351884"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p1681613351682"><a name="p1681613351682"></a><a name="p1681613351682"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p68161435287"><a name="p68161435287"></a><a name="p68161435287"></a>Maximum number of the least significant digits. The value ranges from <strong id="b11755917223"><a name="b11755917223"></a><a name="b11755917223"></a>1</strong> to <strong id="b177359192215"><a name="b177359192215"></a><a name="b177359192215"></a>21</strong>.</p>
</td>
</tr>
</tbody>
</table>
## RelativeTimeFormat<sup>8+</sup><a name="section12691145262"></a>
### constructor<sup>8+</sup><a name="section1492214108187"></a>
constructor\(\)
Creates a **RelativeTimeFormat** object.
- Example
```
var relativetimefmt = new Intl.RelativeTimeFormat();
```
### constructor<sup>8+</sup><a name="section119221810141812"></a>
constructor\(locale: string | Array<string\>, options?: RelativeTimeFormatInputOptions\)
Creates a **RelativeTimeFormat** object based on the specified locale and options.
Parameters
<a name="table3923710191817"></a>
<table><thead align="left"><tr id="row14923131031814"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p16923131051816"><a name="p16923131051816"></a><a name="p16923131051816"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p1923111014180"><a name="p1923111014180"></a><a name="p1923111014180"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p292316108182"><a name="p292316108182"></a><a name="p292316108182"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p19923171091815"><a name="p19923171091815"></a><a name="p19923171091815"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row199231610151813"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p392381041811"><a name="p392381041811"></a><a name="p392381041811"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p1392318109189"><a name="p1392318109189"></a><a name="p1392318109189"></a>string|Array&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p2092381071819"><a name="p2092381071819"></a><a name="p2092381071819"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p49249104184"><a name="p49249104184"></a><a name="p49249104184"></a>A string containing locale information, including the language, optional script, and locale.</p>
</td>
</tr>
<tr id="row192451013183"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p49244106183"><a name="p49244106183"></a><a name="p49244106183"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p1924121011813"><a name="p1924121011813"></a><a name="p1924121011813"></a><a href="#section13434174316429">RelativeTimeFormatInputOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p79249106186"><a name="p79249106186"></a><a name="p79249106186"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p10924121010188"><a name="p10924121010188"></a><a name="p10924121010188"></a>Options for creating a <strong id="b17306422182713"><a name="b17306422182713"></a><a name="b17306422182713"></a>RelativeTimeFormat</strong> object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"});
```
### format<sup>8+</sup><a name="section772213281272"></a>
format\(value: numeric, unit: string\): string
Formats the value and unit based on the specified locale and formatting options.
- Parameters
<a name="table153401772300"></a>
<table><thead align="left"><tr id="row20341175308"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p173412710304"><a name="p173412710304"></a><a name="p173412710304"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p7341167193019"><a name="p7341167193019"></a><a name="p7341167193019"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p0341774305"><a name="p0341774305"></a><a name="p0341774305"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p734113713307"><a name="p734113713307"></a><a name="p734113713307"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row133414743017"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p153416733020"><a name="p153416733020"></a><a name="p153416733020"></a>value</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p33411377303"><a name="p33411377303"></a><a name="p33411377303"></a>numeric</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p14341207143015"><a name="p14341207143015"></a><a name="p14341207143015"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p193412714308"><a name="p193412714308"></a><a name="p193412714308"></a>Value to format.</p>
</td>
</tr>
<tr id="row1059201311327"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p13601613183217"><a name="p13601613183217"></a><a name="p13601613183217"></a>unit</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p156031373214"><a name="p156031373214"></a><a name="p156031373214"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p13601813183218"><a name="p13601813183218"></a><a name="p13601813183218"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p060181310321"><a name="p060181310321"></a><a name="p060181310321"></a>Unit to format. The value can be <strong id="b1080143716299"><a name="b1080143716299"></a><a name="b1080143716299"></a>year</strong>, <strong id="b189345417291"><a name="b189345417291"></a><a name="b189345417291"></a>quarter</strong>, <strong id="b1032817449295"><a name="b1032817449295"></a><a name="b1032817449295"></a>month</strong>, <strong id="b101371946112910"><a name="b101371946112910"></a><a name="b101371946112910"></a>week</strong>, <strong id="b16295114872912"><a name="b16295114872912"></a><a name="b16295114872912"></a>day</strong>, <strong id="b15844134917293"><a name="b15844134917293"></a><a name="b15844134917293"></a>hour</strong>, <strong id="b724785120299"><a name="b724785120299"></a><a name="b724785120299"></a>minute</strong>, or <strong id="b1502652192918"><a name="b1502652192918"></a><a name="b1502652192918"></a>second</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table133411723011"></a>
<table><thead align="left"><tr id="row73411573307"><th class="cellrowborder" valign="top" width="17.01%" id="mcps1.1.3.1.1"><p id="p1534114710307"><a name="p1534114710307"></a><a name="p1534114710307"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="82.99%" id="mcps1.1.3.1.2"><p id="p1934114716300"><a name="p1934114716300"></a><a name="p1934114716300"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row183411279305"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p1634147113014"><a name="p1634147113014"></a><a name="p1634147113014"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p173417753017"><a name="p173417753017"></a><a name="p173417753017"></a>Relative time after formatting.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var relativetimefmt = new Intl.RelativeTimeFormat("zh-CN");
relativetimefmt.format(3, "quarter")
```
### formatToParts<sup>8+</sup><a name="section97312511713"></a>
formatToParts\(value: numeric, unit: string\): Array<Object\>
Returns an array of **RelativeTimeFormat** objects in parts for locale-aware formatting.
- Parameters
<a name="table1857281113389"></a>
<table><thead align="left"><tr id="row12572311173813"><th class="cellrowborder" valign="top" width="11.119698579847357%" id="mcps1.1.5.1.1"><p id="p2572181183819"><a name="p2572181183819"></a><a name="p2572181183819"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.905999420345864%" id="mcps1.1.5.1.2"><p id="p14572711193816"><a name="p14572711193816"></a><a name="p14572711193816"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.356873732006569%" id="mcps1.1.5.1.3"><p id="p8572161116386"><a name="p8572161116386"></a><a name="p8572161116386"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.61742826780022%" id="mcps1.1.5.1.4"><p id="p1357310118382"><a name="p1357310118382"></a><a name="p1357310118382"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row175733110387"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p357319117385"><a name="p357319117385"></a><a name="p357319117385"></a>value</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p15573311143810"><a name="p15573311143810"></a><a name="p15573311143810"></a>numeric</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p757320114386"><a name="p757320114386"></a><a name="p757320114386"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p15731711123810"><a name="p15731711123810"></a><a name="p15731711123810"></a>Value to format.</p>
</td>
</tr>
<tr id="row195731111113820"><td class="cellrowborder" valign="top" width="11.119698579847357%" headers="mcps1.1.5.1.1 "><p id="p7573121118385"><a name="p7573121118385"></a><a name="p7573121118385"></a>unit</p>
</td>
<td class="cellrowborder" valign="top" width="22.905999420345864%" headers="mcps1.1.5.1.2 "><p id="p105731711153811"><a name="p105731711153811"></a><a name="p105731711153811"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.356873732006569%" headers="mcps1.1.5.1.3 "><p id="p5573201113381"><a name="p5573201113381"></a><a name="p5573201113381"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.61742826780022%" headers="mcps1.1.5.1.4 "><p id="p7573121153814"><a name="p7573121153814"></a><a name="p7573121153814"></a>Unit to format. The value can be <strong id="b227510227115"><a name="b227510227115"></a><a name="b227510227115"></a>year</strong>, <strong id="b92808221315"><a name="b92808221315"></a><a name="b92808221315"></a>quarter</strong>, <strong id="b92811622219"><a name="b92811622219"></a><a name="b92811622219"></a>month</strong>, <strong id="b728119221013"><a name="b728119221013"></a><a name="b728119221013"></a>week</strong>, <strong id="b128119221419"><a name="b128119221419"></a><a name="b128119221419"></a>day</strong>, <strong id="b728112218116"><a name="b728112218116"></a><a name="b728112218116"></a>hour</strong>, <strong id="b228117221613"><a name="b228117221613"></a><a name="b228117221613"></a>minute</strong>, or <strong id="b728152217110"><a name="b728152217110"></a><a name="b728152217110"></a>second</strong>.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table1457420114389"></a>
<table><thead align="left"><tr id="row257411123817"><th class="cellrowborder" valign="top" width="17.01%" id="mcps1.1.3.1.1"><p id="p15741611113813"><a name="p15741611113813"></a><a name="p15741611113813"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="82.99%" id="mcps1.1.3.1.2"><p id="p6574151143819"><a name="p6574151143819"></a><a name="p6574151143819"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row75749116385"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p157411117381"><a name="p157411117381"></a><a name="p157411117381"></a>Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p12734113617442"><a name="p12734113617442"></a><a name="p12734113617442"></a>An array of <strong id="b18873161045910"><a name="b18873161045910"></a><a name="b18873161045910"></a>RelativeTimeFormat</strong> objects in parts.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"});
var parts = relativetimefmt.format(10, "seconds");
```
### resolvedOptions<sup>8+</sup><a name="section43038316814"></a>
resolvedOptions\(\): RelativeTimeFormatResolvedOptions
Obtains the formatting options for **RelativeTimeFormat** objects.
- Return values
<a name="table17671173914915"></a>
<table><thead align="left"><tr id="row11671153914918"><th class="cellrowborder" valign="top" width="20.05%" id="mcps1.1.3.1.1"><p id="p5671183919490"><a name="p5671183919490"></a><a name="p5671183919490"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.95%" id="mcps1.1.3.1.2"><p id="p167211392497"><a name="p167211392497"></a><a name="p167211392497"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row156728399490"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p827161075013"><a name="p827161075013"></a><a name="p827161075013"></a><a href="#section441474654220">RelativeTimeFormatResolvedOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p1967203910493"><a name="p1967203910493"></a><a name="p1967203910493"></a>Formatting options for <strong id="b1410313141307"><a name="b1410313141307"></a><a name="b1410313141307"></a>RelativeTimeFormat</strong> objects.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var relativetimefmt= new Intl.RelativeTimeFormat("en-GB");
relativetimefmt.resolvedOptions();
```
## RelativeTimeFormatInputOptions<sup>8+</sup><a name="section13434174316429"></a>
Represents the properties of a **RelativeTimeFormat** object.
<a name="table06645448207"></a>
<table><thead align="left"><tr id="row86642446206"><th class="cellrowborder" valign="top" width="19.15%" id="mcps1.1.6.1.1"><p id="p966404417205"><a name="p966404417205"></a><a name="p966404417205"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.8%" id="mcps1.1.6.1.2"><p id="p8665644122010"><a name="p8665644122010"></a><a name="p8665644122010"></a>Parameter Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.12%" id="mcps1.1.6.1.3"><p id="p1866510447209"><a name="p1866510447209"></a><a name="p1866510447209"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.48%" id="mcps1.1.6.1.4"><p id="p966544413201"><a name="p966544413201"></a><a name="p966544413201"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.449999999999996%" id="mcps1.1.6.1.5"><p id="p126655442201"><a name="p126655442201"></a><a name="p126655442201"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1466564413206"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p136653446205"><a name="p136653446205"></a><a name="p136653446205"></a>localeMatcher</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p16665154472016"><a name="p16665154472016"></a><a name="p16665154472016"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p8665154492011"><a name="p8665154492011"></a><a name="p8665154492011"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p8665544142016"><a name="p8665544142016"></a><a name="p8665544142016"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p1666594462010"><a name="p1666594462010"></a><a name="p1666594462010"></a>Locale matching algorithm. The value can be <strong id="b767412210320"><a name="b767412210320"></a><a name="b767412210320"></a>lookup</strong> or <strong id="b16680722932"><a name="b16680722932"></a><a name="b16680722932"></a>best fit</strong>.</p>
</td>
</tr>
<tr id="row7666844182010"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p1266617445201"><a name="p1266617445201"></a><a name="p1266617445201"></a>numeric</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p106661044102019"><a name="p106661044102019"></a><a name="p106661044102019"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p166661444142017"><a name="p166661444142017"></a><a name="p166661444142017"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p2066694442012"><a name="p2066694442012"></a><a name="p2066694442012"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p86661344162020"><a name="p86661344162020"></a><a name="p86661344162020"></a>Format of the output message. The value can be <strong id="b0481258238"><a name="b0481258238"></a><a name="b0481258238"></a>always</strong> or <strong id="b15389132745"><a name="b15389132745"></a><a name="b15389132745"></a>auto</strong>.</p>
</td>
</tr>
<tr id="row866617448204"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p20690185818217"><a name="p20690185818217"></a><a name="p20690185818217"></a>style</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p1266644412204"><a name="p1266644412204"></a><a name="p1266644412204"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p11666194419207"><a name="p11666194419207"></a><a name="p11666194419207"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p4667444132016"><a name="p4667444132016"></a><a name="p4667444132016"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p966794419201"><a name="p966794419201"></a><a name="p966794419201"></a>Length of the internationalized message. The value can be <strong id="b1373134714816"><a name="b1373134714816"></a><a name="b1373134714816"></a>long</strong>, <strong id="b11972481385"><a name="b11972481385"></a><a name="b11972481385"></a>short</strong>, or <strong id="b1351664912810"><a name="b1351664912810"></a><a name="b1351664912810"></a>narrow</strong>.</p>
</td>
</tr>
</tbody>
</table>
## RelativeTimeFormatResolvedOptions<sup>8+</sup><a name="section441474654220"></a>
Represents the properties of a **RelativeTimeFormat** object.
<a name="table1697188434"></a>
<table><thead align="left"><tr id="row1498168174315"><th class="cellrowborder" valign="top" width="19.15%" id="mcps1.1.6.1.1"><p id="p1298288433"><a name="p1298288433"></a><a name="p1298288433"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.8%" id="mcps1.1.6.1.2"><p id="p15986874313"><a name="p15986874313"></a><a name="p15986874313"></a>Parameter Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.12%" id="mcps1.1.6.1.3"><p id="p29868174317"><a name="p29868174317"></a><a name="p29868174317"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.48%" id="mcps1.1.6.1.4"><p id="p89811884311"><a name="p89811884311"></a><a name="p89811884311"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.449999999999996%" id="mcps1.1.6.1.5"><p id="p14987817436"><a name="p14987817436"></a><a name="p14987817436"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row129819844311"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p129911816436"><a name="p129911816436"></a><a name="p129911816436"></a>locale</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p5994814311"><a name="p5994814311"></a><a name="p5994814311"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p14991584436"><a name="p14991584436"></a><a name="p14991584436"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p14996894319"><a name="p14996894319"></a><a name="p14996894319"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p14561269443"><a name="p14561269443"></a><a name="p14561269443"></a>A string containing locale information, including the language, optional script, and locale.</p>
</td>
</tr>
<tr id="row119978194311"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p39913811434"><a name="p39913811434"></a><a name="p39913811434"></a>numeric</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p199918813439"><a name="p199918813439"></a><a name="p199918813439"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p199916813430"><a name="p199916813430"></a><a name="p199916813430"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p59914817435"><a name="p59914817435"></a><a name="p59914817435"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p61005854317"><a name="p61005854317"></a><a name="p61005854317"></a>Format of the output message. The value can be <strong id="b1150713718510"><a name="b1150713718510"></a><a name="b1150713718510"></a>always</strong> or <strong id="b195131471458"><a name="b195131471458"></a><a name="b195131471458"></a>auto</strong>.</p>
</td>
</tr>
<tr id="row10100158174310"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p151001585436"><a name="p151001585436"></a><a name="p151001585436"></a>style</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p17100148114312"><a name="p17100148114312"></a><a name="p17100148114312"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p11009815435"><a name="p11009815435"></a><a name="p11009815435"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p111009884316"><a name="p111009884316"></a><a name="p111009884316"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p191008814318"><a name="p191008814318"></a><a name="p191008814318"></a>Length of the internationalized message. The value can be <strong id="b1782351519610"><a name="b1782351519610"></a><a name="b1782351519610"></a>long</strong>, <strong id="b59781217963"><a name="b59781217963"></a><a name="b59781217963"></a>short</strong>, or <strong id="b46725196613"><a name="b46725196613"></a><a name="b46725196613"></a>narrow</strong>.</p>
</td>
</tr>
<tr id="row31241030174419"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.1.6.1.1 "><p id="p10124930164412"><a name="p10124930164412"></a><a name="p10124930164412"></a>numberingSystem</p>
</td>
<td class="cellrowborder" valign="top" width="10.8%" headers="mcps1.1.6.1.2 "><p id="p111241530174413"><a name="p111241530174413"></a><a name="p111241530174413"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.12%" headers="mcps1.1.6.1.3 "><p id="p16124143017447"><a name="p16124143017447"></a><a name="p16124143017447"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.48%" headers="mcps1.1.6.1.4 "><p id="p1712463034417"><a name="p1712463034417"></a><a name="p1712463034417"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.449999999999996%" headers="mcps1.1.6.1.5 "><p id="p14124113074410"><a name="p14124113074410"></a><a name="p14124113074410"></a>Numbering system.</p>
</td>
</tr>
</tbody>
</table>
en/application-dev/reference/apis/js-apis-notification.md
浏览文件 @ 5b59ac7a
# Notification Module # Notification Module
## Applicable Devices
| API | Phone | Tablet | Smart TV | Wearable |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- |
| Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.publish(request: NotificationRequest) | Yes | Yes | Yes | Yes |
| Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.cancel(id：number, label?：string） | Yes | Yes | Yes | Yes |
| Notification.cancel(id: number, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.cancelAll(callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.cancelAll() | Yes | Yes | Yes | Yes |
| Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.addSlot(slot: NotificationSlot) | Yes | Yes | Yes | Yes |
| Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.addSlot(type: SlotType) | Yes | Yes | Yes | Yes |
| Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.addSlots(slots: Array\<NotificationSlot\>) | Yes | Yes | Yes | Yes |
| Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>) | Yes | Yes | Yes | Yes |
| Notification.getSlot(slotType: SlotType) | Yes | Yes | Yes | Yes |
| Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>) | Yes | Yes | Yes | Yes |
| Notification.getSlots() | Yes | Yes | Yes | Yes |
| Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.removeSlot(slotType: SlotType) | Yes | Yes | Yes | Yes |
| Notification.removeAllSlots(callback: AsyncCallback\<void\>): void | Yes | Yes | Yes | Yes |
| Notification.removeAllSlots(): Promise\<void\> | Yes | Yes | Yes | Yes |
| Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo) | Yes | Yes | Yes | Yes |
| Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.unsubscribe(subscriber: NotificationSubscriber) | Yes | Yes | Yes | Yes |
| Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.enableNotification(bundle: BundleOption, enable: boolean) | Yes | Yes | Yes | Yes |
| Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>) | Yes | Yes | Yes | Yes |
| Notification.isNotificationEnabled(bundle: BundleOption) | Yes | Yes | Yes | Yes |
| Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>) | Yes | Yes | Yes | Yes |
| Notification.isNotificationEnabled() | Yes | Yes | Yes | Yes |
| Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.displayBadge(bundle: BundleOption, enable: boolean) | Yes | Yes | Yes | Yes |
| Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>) | Yes | Yes | Yes | Yes |
| Notification.isBadgeDisplayed(bundle: BundleOption) | Yes | Yes | Yes | Yes |
| Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot) | Yes | Yes | Yes | Yes |
| Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>) | Yes | Yes | Yes | Yes |
| Notification.getSlotsByBundle(bundle: BundleOption) | Yes | Yes | Yes | Yes |
| Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>) | Yes | Yes | Yes | Yes |
| Notification.getSlotNumByBundle(bundle: BundleOption) | Yes | Yes | Yes | Yes |
| Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.remove(bundle: BundleOption, notificationKey: NotificationKey) | Yes | Yes | Yes | Yes |
| Notification.remove(hashCode: string, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.remove(hashCode: string) | Yes | Yes | Yes | Yes |
| Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.removeAll(callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.removeAll(bundle?: BundleOption) | Yes | Yes | Yes | Yes |
| Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) | Yes | Yes | Yes | Yes |
| Notification.getAllActiveNotifications() | Yes | Yes | Yes | Yes |
| Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>) | Yes | Yes | Yes | Yes |
| Notification.getActiveNotificationCount() | Yes | Yes | Yes | Yes |
| Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) | Yes | Yes | Yes | Yes |
| Notification.getActiveNotifications() | Yes | Yes | Yes | Yes |
| Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.cancelGroup(groupName: string) | Yes | Yes | Yes | Yes |
| Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.removeGroupByBundle(bundle: BundleOption, groupName: string) | Yes | Yes | Yes | Yes |
| Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| Notification.setDoNotDisturbDate(date: DoNotDisturbDate) | Yes | Yes | Yes | Yes |
| Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>) | Yes | Yes | Yes | Yes |
| Notification.getDoNotDisturbDate() | Yes | Yes | Yes | Yes |
| Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>) | Yes | Yes | Yes | Yes |
| Notification.supportDoNotDisturbMode() | Yes | Yes | Yes | Yes |
| WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>) | Yes | Yes | Yes | Yes |
| WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> | Yes | Yes | Yes | Yes |
| WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>) | Yes | Yes | Yes | Yes |
| WantAgent.getBundleName(agent: WantAgent): Promise\<string\> | Yes | Yes | Yes | Yes |
| WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>) | Yes | Yes | Yes | Yes |
| WantAgent.getUid(agent: WantAgent): Promise\<number\> | Yes | Yes | Yes | Yes |
| WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>) | Yes | Yes | Yes | Yes |
| WantAgent.getWant(agent: WantAgent): Promise\<Want\> | Yes | Yes | Yes | Yes |
| WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>) | Yes | Yes | Yes | Yes |
| WantAgent.cancel(agent: WantAgent): Promise\<void\> | Yes | Yes | Yes | Yes |
| WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>) | Yes | Yes | Yes | Yes |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>) | Yes | Yes | Yes | Yes |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> | Yes | Yes | Yes | Yes |
## Required Permissions ## Required Permissions
......
en/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @ 5b59ac7a
# ParticleAbility Module # ParticleAbility Module
## Applicable Devices
| API | Phone| Tablet| Smart TV| Wearable| Lite Wearable| SmartVision Device|
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| particleAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>: void | Yes| Yes| Yes| Yes| No| No|
| particleAbility.startAbility(parameter: StartAbilityParameter): Promise\<number> | Yes| Yes| Yes| Yes| No| No|
| particleAbility.terminateSelf(callback: AsyncCallback\<void>): void | Yes| Yes| Yes| Yes| No| No|
| particleAbility.terminateSelf(): Promise\<void> | Yes| Yes| Yes| Yes| No| No|
| particleAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper | Yes| Yes| Yes| Yes| No| No|
| particleAbility.connectAbility(request: Want, options:ConnectOptions): number | Yes| Yes| Yes| Yes| No| No|
| particleAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void | Yes| Yes| Yes| Yes| No| No|
| particleAbility.disconnectAbility(connection: number): Promise\<void> | Yes| Yes| Yes| Yes| No| No|
## Constraints ## Constraints
The ParticleAbility module is used to perform operations on abilities of the Data and Service types. The ParticleAbility module is used to perform operations on abilities of the Data and Service types.
......
en/application-dev/reference/apis/js-apis-process.md
浏览文件 @ 5b59ac7a
# Obtaining Process Information<a name="EN-US_TOPIC_0000001151456638"></a> # Obtaining Process Information<a name="EN-US_TOPIC_0000001237480785"></a>
>![](../../public_sys-resources/icon-note.gif) **NOTE:** >![](../../public_sys-resources/icon-note.gif) **NOTE:**
>The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. >The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
...@@ -80,7 +80,7 @@ None ...@@ -80,7 +80,7 @@ None
</td> </td>
<td class="cellrowborder" valign="top" width="8.110000000000001%" headers="mcps1.1.6.1.4 "><p id="p19456195718542"><a name="p19456195718542"></a><a name="p19456195718542"></a>No</p> <td class="cellrowborder" valign="top" width="8.110000000000001%" headers="mcps1.1.6.1.4 "><p id="p19456195718542"><a name="p19456195718542"></a><a name="p19456195718542"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="47.94%" headers="mcps1.1.6.1.5 "><p id="p12456257145411"><a name="p12456257145411"></a><a name="p12456257145411"></a>An array with supplementary group IDs.</p> <td class="cellrowborder" valign="top" width="47.94%" headers="mcps1.1.6.1.5 "><p id="p12456257145411"><a name="p12456257145411"></a><a name="p12456257145411"></a>Array with supplementary group IDs.</p>
</td> </td>
</tr> </tr>
<tr id="row2456155735410"><td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.1.6.1.1 "><p id="p145695716545"><a name="p145695716545"></a><a name="p145695716545"></a>pid</p> <tr id="row2456155735410"><td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.1.6.1.1 "><p id="p145695716545"><a name="p145695716545"></a><a name="p145695716545"></a>pid</p>
...@@ -105,12 +105,23 @@ None ...@@ -105,12 +105,23 @@ None
<td class="cellrowborder" valign="top" width="47.94%" headers="mcps1.1.6.1.5 "><p id="p2050111216567"><a name="p2050111216567"></a><a name="p2050111216567"></a>Parent process ID (PPID) of a process.</p> <td class="cellrowborder" valign="top" width="47.94%" headers="mcps1.1.6.1.5 "><p id="p2050111216567"><a name="p2050111216567"></a><a name="p2050111216567"></a>Parent process ID (PPID) of a process.</p>
</td> </td>
</tr> </tr>
<tr id="row383373231019"><td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.1.6.1.1 "><p id="p28339326100"><a name="p28339326100"></a><a name="p28339326100"></a>tid<sup id="sup515125418117"><a name="sup515125418117"></a><a name="sup515125418117"></a>8+</sup></p>
</td>
<td class="cellrowborder" valign="top" width="21.16%" headers="mcps1.1.6.1.2 "><p id="p1083318320102"><a name="p1083318320102"></a><a name="p1083318320102"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="8.39%" headers="mcps1.1.6.1.3 "><p id="p983433218101"><a name="p983433218101"></a><a name="p983433218101"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="8.110000000000001%" headers="mcps1.1.6.1.4 "><p id="p58341432121020"><a name="p58341432121020"></a><a name="p58341432121020"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="47.94%" headers="mcps1.1.6.1.5 "><p id="p16834532191011"><a name="p16834532191011"></a><a name="p16834532191011"></a>Thread ID (TID) of a process.</p>
</td>
</tr>
</tbody> </tbody>
</table> </table>
## ChildProcess<a name="section6521387200"></a> ## ChildProcess<a name="section6521387200"></a>
Allows a process to obtain the standard input and output of its child processes, send signals, and close its child processes. Provides methods for a process to obtain the standard input and output of its child processes, send signals, and close its child processes.
### Attributes<a name="section18482944113517"></a> ### Attributes<a name="section18482944113517"></a>
...@@ -200,7 +211,6 @@ Waits until the child process ends. This method uses a promise to return the exi ...@@ -200,7 +211,6 @@ Waits until the child process ends. This method uses a promise to return the exi
- Example - Example
``` ```
import process from '@ohos.process';
var child = process.runCmd('ls'); var child = process.runCmd('ls');
var result = child.wait(); var result = child.wait();
result.then(val=>{ result.then(val=>{
...@@ -235,7 +245,6 @@ Obtains the standard output of the child process. ...@@ -235,7 +245,6 @@ Obtains the standard output of the child process.
- Example - Example
``` ```
import process from '@ohos.process';
var child = process.runCmd('ls'); var child = process.runCmd('ls');
var result = child.wait(); var result = child.wait();
child.getOutput.then(val=>{ child.getOutput.then(val=>{
...@@ -270,7 +279,6 @@ Obtains the standard error output of the child process. ...@@ -270,7 +279,6 @@ Obtains the standard error output of the child process.
- Example - Example
``` ```
import process from '@ohos.process';
var child = process.runCmd('madir test.text'); var child = process.runCmd('madir test.text');
var result = child.wait(); var result = child.wait();
child.getErrorOutput.then(val=>{ child.getErrorOutput.then(val=>{
...@@ -288,7 +296,6 @@ Closes the child process in running. ...@@ -288,7 +296,6 @@ Closes the child process in running.
- Example - Example
``` ```
import process from '@ohos.process';
var child = process.runCmd('sleep 5; ls'); var child = process.runCmd('sleep 5; ls');
child.close(); child.close();
``` ```
...@@ -328,12 +335,443 @@ Sends a signal to the specified child process to terminate it. ...@@ -328,12 +335,443 @@ Sends a signal to the specified child process to terminate it.
- Example - Example
``` ```
import process from '@ohos.process';
var child = process.runCmd('sleep 5; ls'); var child = process.runCmd('sleep 5; ls');
child.kill(9); child.kill(9);
``` ```
## process.isIsolatedProcess<sup>8+</sup><a name="section18531656131211"></a>
isIsolatedProcess\(\): boolean
Checks whether the process is isolated.
- Return values
<a name="table16748145772610"></a>
<table><thead align="left"><tr id="row13748857132613"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p5748125722616"><a name="p5748125722616"></a><a name="p5748125722616"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p8748155719267"><a name="p8748155719267"></a><a name="p8748155719267"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row16748135742613"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p6748757162618"><a name="p6748757162618"></a><a name="p6748757162618"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p16749057182614"><a name="p16749057182614"></a><a name="p16749057182614"></a>Returns <strong id="b1257840101118"><a name="b1257840101118"></a><a name="b1257840101118"></a>true</strong> if the process is isolated; returns <strong id="b295119021219"><a name="b295119021219"></a><a name="b295119021219"></a>false</strong> otherwise.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var result = process.isIsolatedProcess();
```
## process.isAppUid<sup>8+</sup><a name="section3483872142"></a>
isAppUid\(v:number\): boolean
Checks whether a UID belongs to this app.
- Parameters
<a name="table1130031918288"></a>
<table><thead align="left"><tr id="row5300181932814"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p13300131917284"><a name="p13300131917284"></a><a name="p13300131917284"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p12301131912284"><a name="p12301131912284"></a><a name="p12301131912284"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p13011819122814"><a name="p13011819122814"></a><a name="p13011819122814"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p10301141922817"><a name="p10301141922817"></a><a name="p10301141922817"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1630116194285"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p438853552813"><a name="p438853552813"></a><a name="p438853552813"></a>v</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p530151916283"><a name="p530151916283"></a><a name="p530151916283"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p12301819172811"><a name="p12301819172811"></a><a name="p12301819172811"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p9302111962811"><a name="p9302111962811"></a><a name="p9302111962811"></a>UID.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table193021119132815"></a>
<table><thead align="left"><tr id="row630281915283"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p13303619192811"><a name="p13303619192811"></a><a name="p13303619192811"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p93034196281"><a name="p93034196281"></a><a name="p93034196281"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row0303201917288"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p93031719172815"><a name="p93031719172815"></a><a name="p93031719172815"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p2044064714286"><a name="p2044064714286"></a><a name="p2044064714286"></a>Returns <strong id="b11496154718238"><a name="b11496154718238"></a><a name="b11496154718238"></a>true</strong> if the UID is the app's UID; returns <strong id="b1549674712316"><a name="b1549674712316"></a><a name="b1549674712316"></a>false</strong> otherwise.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var result = process.isAppUid(688);
```
## process.is64Bit<sup>8+</sup><a name="section19430255141411"></a>
is64Bit\(\): boolean
Checks whether the operating environment is of 64-bit.
- Return values
<a name="table18430115511149"></a>
<table><thead align="left"><tr id="row4430165512148"><th class="cellrowborder" valign="top" width="21.02%" id="mcps1.1.3.1.1"><p id="p94301555141"><a name="p94301555141"></a><a name="p94301555141"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="78.97999999999999%" id="mcps1.1.3.1.2"><p id="p6430185515144"><a name="p6430185515144"></a><a name="p6430185515144"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row9430125531413"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.1.3.1.1 "><p id="p14430655121410"><a name="p14430655121410"></a><a name="p14430655121410"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="78.97999999999999%" headers="mcps1.1.3.1.2 "><p id="p943075571418"><a name="p943075571418"></a><a name="p943075571418"></a>Returns <strong id="b542211113264"><a name="b542211113264"></a><a name="b542211113264"></a>true</strong> if the operating environment is of 64-bit; returns <strong id="b1142231110265"><a name="b1142231110265"></a><a name="b1142231110265"></a>false</strong> otherwise.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var ressult = process.is64Bit();
```
## process.getUidForName<sup>8+</sup><a name="section1727712617154"></a>
getUidForName\(v:string\): number
Obtains the process UID based on the process name.
- Parameters
<a name="table10277142671518"></a>
<table><thead align="left"><tr id="row1727719261158"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p17277122616159"><a name="p17277122616159"></a><a name="p17277122616159"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p11277172619159"><a name="p11277172619159"></a><a name="p11277172619159"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p1127732661515"><a name="p1127732661515"></a><a name="p1127732661515"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p102775264152"><a name="p102775264152"></a><a name="p102775264152"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row16277122631517"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p192771126131510"><a name="p192771126131510"></a><a name="p192771126131510"></a>v</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p827814265151"><a name="p827814265151"></a><a name="p827814265151"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p122783261158"><a name="p122783261158"></a><a name="p122783261158"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p22781526111515"><a name="p22781526111515"></a><a name="p22781526111515"></a>Process name.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table12278152615151"></a>
<table><thead align="left"><tr id="row1527842610155"><th class="cellrowborder" valign="top" width="21.02%" id="mcps1.1.3.1.1"><p id="p182781267158"><a name="p182781267158"></a><a name="p182781267158"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="78.97999999999999%" id="mcps1.1.3.1.2"><p id="p52781826161511"><a name="p52781826161511"></a><a name="p52781826161511"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row19278112681516"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.1.3.1.1 "><p id="p927822691514"><a name="p927822691514"></a><a name="p927822691514"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="78.97999999999999%" headers="mcps1.1.3.1.2 "><p id="p18278426161512"><a name="p18278426161512"></a><a name="p18278426161512"></a>Process UID.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var pres = process.getUidForName("tool")
```
## process.getThreadPriority<sup>8+</sup><a name="section10468310163512"></a>
getThreadPriority\(v:number\): number
Obtains the thread priority based on the specified TID.
- Parameters
<a name="table1546841011357"></a>
<table><thead align="left"><tr id="row14469111063515"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p346951013359"><a name="p346951013359"></a><a name="p346951013359"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p246918103351"><a name="p246918103351"></a><a name="p246918103351"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p6469171013513"><a name="p6469171013513"></a><a name="p6469171013513"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1446917101352"><a name="p1446917101352"></a><a name="p1446917101352"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row5469910143518"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1247011033512"><a name="p1247011033512"></a><a name="p1247011033512"></a>v</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p18470171083516"><a name="p18470171083516"></a><a name="p18470171083516"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p7470110113512"><a name="p7470110113512"></a><a name="p7470110113512"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1327223011365"><a name="p1327223011365"></a><a name="p1327223011365"></a>TID.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table1947018103358"></a>
<table><thead align="left"><tr id="row134713108353"><th class="cellrowborder" valign="top" width="21.02%" id="mcps1.1.3.1.1"><p id="p84712101359"><a name="p84712101359"></a><a name="p84712101359"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="78.97999999999999%" id="mcps1.1.3.1.2"><p id="p44711910103519"><a name="p44711910103519"></a><a name="p44711910103519"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row154710105354"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.1.3.1.1 "><p id="p1447181023517"><a name="p1447181023517"></a><a name="p1447181023517"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="78.97999999999999%" headers="mcps1.1.3.1.2 "><p id="p8471110183520"><a name="p8471110183520"></a><a name="p8471110183520"></a>Priority of the thread.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var tid = process.tid;
var pres = process.getThreadPriority(tid);
```
## process.getStartRealtime<sup>8+</sup><a name="section1336514287167"></a>
getStartRealtime\(\) :number
Obtains the duration, in milliseconds, from the time the system starts to the time the process starts.
- Return values
<a name="table191971559142420"></a>
<table><thead align="left"><tr id="row1119785919245"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p2197115962417"><a name="p2197115962417"></a><a name="p2197115962417"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p1419713599243"><a name="p1419713599243"></a><a name="p1419713599243"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row10198175982415"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p719855942415"><a name="p719855942415"></a><a name="p719855942415"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p1119875918248"><a name="p1119875918248"></a><a name="p1119875918248"></a>Time duration obtained.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var realtime = process.getStartRealtime();
```
## process.getAvailableCores<sup>8+</sup><a name="section168171781714"></a>
getAvailableCores\(\) :number\[\]
Obtains the number of CPU cores available for the current process on a multi-core device.
- Return values
<a name="table164412912250"></a>
<table><thead align="left"><tr id="row7441229172510"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p1144162952513"><a name="p1144162952513"></a><a name="p1144162952513"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p194442942512"><a name="p194442942512"></a><a name="p194442942512"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row844142919253"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p364463482517"><a name="p364463482517"></a><a name="p364463482517"></a>number[]</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p104402911252"><a name="p104402911252"></a><a name="p104402911252"></a>Number of cores available for the process.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var result = getAvailableCores();
```
## process.getPastCputime<sup>8+</sup><a name="section93991533201718"></a>
getPastCputime\(\) :number
Obtains the CPU time \(in milliseconds\) from the time the process starts to the current time.
- Return values
<a name="table935012126260"></a>
<table><thead align="left"><tr id="row12350111272614"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p1635081217266"><a name="p1635081217266"></a><a name="p1635081217266"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p335014125263"><a name="p335014125263"></a><a name="p335014125263"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row835171215263"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p1914922192620"><a name="p1914922192620"></a><a name="p1914922192620"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p135118122264"><a name="p135118122264"></a><a name="p135118122264"></a>CPU time obtained.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var result = process.getPastCputime() ;
```
## process.getSystemConfig<sup>8+</sup><a name="section872533219413"></a>
getSystemConfig\(name:number\): number
Obtains the system configuration.
- Parameters
<a name="table187251232124112"></a>
<table><thead align="left"><tr id="row1726153264119"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p187261932204117"><a name="p187261932204117"></a><a name="p187261932204117"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p19726163214110"><a name="p19726163214110"></a><a name="p19726163214110"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p472613325413"><a name="p472613325413"></a><a name="p472613325413"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p15726133284110"><a name="p15726133284110"></a><a name="p15726133284110"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row672763214419"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p12727432174114"><a name="p12727432174114"></a><a name="p12727432174114"></a>name</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1372743216418"><a name="p1372743216418"></a><a name="p1372743216418"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p2727153213419"><a name="p2727153213419"></a><a name="p2727153213419"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1572743215418"><a name="p1572743215418"></a><a name="p1572743215418"></a>System configuration parameter name.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table2727123213413"></a>
<table><thead align="left"><tr id="row117281232184114"><th class="cellrowborder" valign="top" width="21.02%" id="mcps1.1.3.1.1"><p id="p97281232104111"><a name="p97281232104111"></a><a name="p97281232104111"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="78.97999999999999%" id="mcps1.1.3.1.2"><p id="p1572853218415"><a name="p1572853218415"></a><a name="p1572853218415"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row14728732174120"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.1.3.1.1 "><p id="p4728153254120"><a name="p4728153254120"></a><a name="p4728153254120"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="78.97999999999999%" headers="mcps1.1.3.1.2 "><p id="p3728193216419"><a name="p3728193216419"></a><a name="p3728193216419"></a>System configuration obtained.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var _SC_ARG_MAX = 0
var pres = process.getSystemConfig(_SC_ARG_MAX)
```
## process.getEnvironmentVar<sup>8+</sup><a name="section3554201415462"></a>
getEnvironmentVar\(name:string\): string
Obtains the value of an environment variable.
- Parameters
<a name="table1554101419462"></a>
<table><thead align="left"><tr id="row9555131415465"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p25559140465"><a name="p25559140465"></a><a name="p25559140465"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p65551014124619"><a name="p65551014124619"></a><a name="p65551014124619"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p55569142467"><a name="p55569142467"></a><a name="p55569142467"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1855641454611"><a name="p1855641454611"></a><a name="p1855641454611"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row755681414469"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p145561714164615"><a name="p145561714164615"></a><a name="p145561714164615"></a>name</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p4556121444615"><a name="p4556121444615"></a><a name="p4556121444615"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p055681484619"><a name="p055681484619"></a><a name="p055681484619"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p755612143463"><a name="p755612143463"></a><a name="p755612143463"></a>Environment variable name.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table75571014164610"></a>
<table><thead align="left"><tr id="row75571914184619"><th class="cellrowborder" valign="top" width="21.02%" id="mcps1.1.3.1.1"><p id="p12557101474617"><a name="p12557101474617"></a><a name="p12557101474617"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="78.97999999999999%" id="mcps1.1.3.1.2"><p id="p9557191417469"><a name="p9557191417469"></a><a name="p9557191417469"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8557121474617"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.1.3.1.1 "><p id="p948123084713"><a name="p948123084713"></a><a name="p948123084713"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="78.97999999999999%" headers="mcps1.1.3.1.2 "><p id="p18558141494617"><a name="p18558141494617"></a><a name="p18558141494617"></a>Value of the environment variable.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var pres = process.getEnvironmentVar("PATH")
```
## process.runCmd<a name="section19358326587"></a> ## process.runCmd<a name="section19358326587"></a>
runCmd\(command: string, options?: \{ timeout : number, killSignal : number | string, maxBuffer : number \}\) : ChildProcess runCmd\(command: string, options?: \{ timeout : number, killSignal : number | string, maxBuffer : number \}\) : ChildProcess
...@@ -437,12 +875,11 @@ Forks a new process to run a shell command and returns the **ChildProcess** ob ...@@ -437,12 +875,11 @@ Forks a new process to run a shell command and returns the **ChildProcess** ob
- Example - Example
``` ```
import process from '@ohos.process';
var child = process.runCmd('ls', { maxBuffer : 2 }); var child = process.runCmd('ls', { maxBuffer : 2 });
var result = child.wait(); var result = child.wait();
child.getOutput.then(val=>{ child.getOutput.then(val=>{
console.log("child.getOutput = " + val); console.log("child.getOutput = " + val);
} })
``` ```
...@@ -455,7 +892,6 @@ Aborts a process and generates a core file. This method will cause a process to ...@@ -455,7 +892,6 @@ Aborts a process and generates a core file. This method will cause a process to
- Example - Example
``` ```
import process from '@ohos.process';
process.abort(); process.abort();
``` ```
...@@ -520,7 +956,6 @@ Stores the events triggered by the user. ...@@ -520,7 +956,6 @@ Stores the events triggered by the user.
- Example - Example
``` ```
import process from '@ohos.process';
process.on("data", (e)=>{ process.on("data", (e)=>{
console.log("data callback"); console.log("data callback");
}) })
...@@ -569,7 +1004,7 @@ Deletes the event stored by the user. ...@@ -569,7 +1004,7 @@ Deletes the event stored by the user.
</thead> </thead>
<tbody><tr id="row322716540586"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p4227105415813"><a name="p4227105415813"></a><a name="p4227105415813"></a>boolean</p> <tbody><tr id="row322716540586"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p4227105415813"><a name="p4227105415813"></a><a name="p4227105415813"></a>boolean</p>
</td> </td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p20227155415582"><a name="p20227155415582"></a><a name="p20227155415582"></a>Whether the event is deleted.</p> <td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p20227155415582"><a name="p20227155415582"></a><a name="p20227155415582"></a>Returns <strong id="b9330203617455"><a name="b9330203617455"></a><a name="b9330203617455"></a>true</strong> if the event is deleted; returns <strong id="b1815112412453"><a name="b1815112412453"></a><a name="b1815112412453"></a>false</strong> otherwise.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -578,7 +1013,6 @@ Deletes the event stored by the user. ...@@ -578,7 +1013,6 @@ Deletes the event stored by the user.
- Example - Example
``` ```
import process from '@ohos.process';
process.on("data", (e)=>{ process.on("data", (e)=>{
console.log("data callback"); console.log("data callback");
}) })
...@@ -590,7 +1024,7 @@ Deletes the event stored by the user. ...@@ -590,7 +1024,7 @@ Deletes the event stored by the user.
exit\(code: number\): void exit\(code: number\): void
Terminates a process. Terminates this process.
- Parameters - Parameters
...@@ -620,7 +1054,6 @@ Terminates a process. ...@@ -620,7 +1054,6 @@ Terminates a process.
- Example - Example
``` ```
import process from '@ohos.process';
process.exit(0); process.exit(0);
``` ```
...@@ -629,12 +1062,11 @@ Terminates a process. ...@@ -629,12 +1062,11 @@ Terminates a process.
cwd\(\): string cwd\(\): string
Obtains the working directory of the process. Obtains the working directory of this process.
- Example - Example
``` ```
import process from '@ohos.process';
var path = process.cwd(); var path = process.cwd();
``` ```
...@@ -643,7 +1075,7 @@ Obtains the working directory of the process. ...@@ -643,7 +1075,7 @@ Obtains the working directory of the process.
chdir\(dir: string\): void chdir\(dir: string\): void
Changes the working directory of the process. Changes the working directory of this process.
- Parameters - Parameters
...@@ -673,7 +1105,6 @@ Changes the working directory of the process. ...@@ -673,7 +1105,6 @@ Changes the working directory of the process.
- Example - Example
``` ```
import process from '@ohos.process';
process.chdir('/system'); process.chdir('/system');
``` ```
...@@ -682,7 +1113,7 @@ Changes the working directory of the process. ...@@ -682,7 +1113,7 @@ Changes the working directory of the process.
uptime\(\): number uptime\(\): number
Obtains the running time of the process. Obtains the running time of this process.
- Return values - Return values
...@@ -704,7 +1135,6 @@ Obtains the running time of the process. ...@@ -704,7 +1135,6 @@ Obtains the running time of the process.
- Example - Example
``` ```
import process from '@ohos.process';
var time = process.uptime(); var time = process.uptime();
``` ```
...@@ -760,7 +1190,7 @@ Sends a signal to the specified process to terminate it. ...@@ -760,7 +1190,7 @@ Sends a signal to the specified process to terminate it.
</thead> </thead>
<tbody><tr id="row15207741141911"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p1620714412197"><a name="p1620714412197"></a><a name="p1620714412197"></a>boolean</p> <tbody><tr id="row15207741141911"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p1620714412197"><a name="p1620714412197"></a><a name="p1620714412197"></a>boolean</p>
</td> </td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p7207194141914"><a name="p7207194141914"></a><a name="p7207194141914"></a>Whether the signal is sent successfully.</p> <td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p7207194141914"><a name="p7207194141914"></a><a name="p7207194141914"></a>Returns <strong id="b5691160144712"><a name="b5691160144712"></a><a name="b5691160144712"></a>true</strong> if the signal is sent successfully; returns <strong id="b5409191810479"><a name="b5409191810479"></a><a name="b5409191810479"></a>false</strong> otherwise.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -769,7 +1199,6 @@ Sends a signal to the specified process to terminate it. ...@@ -769,7 +1199,6 @@ Sends a signal to the specified process to terminate it.
- Example - Example
``` ```
import process from '@ohos.process'
var pres = process.pid var pres = process.pid
var result = that.kill(pres, 28) var result = that.kill(pres, 28)
``` ```
......
en/application-dev/reference/apis/js-apis-reminderAgent.md 0 → 100644
浏览文件 @ 5b59ac7a
# Reminder Agent<a name="EN-US_TOPIC_0000001158696346"></a>
>**NOTE:**
>The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Applicable Devices<a name="section16881239114912"></a>
<a name="table857714145377"></a>
<table><thead align="left"><tr id="row55778146373"><th class="cellrowborder" valign="top" width="24.257574242575743%" id="mcps1.1.5.1.1"><p id="p7577141417376"><a name="p7577141417376"></a><a name="p7577141417376"></a>Phone</p>
</th>
<th class="cellrowborder" valign="top" width="25.5974402559744%" id="mcps1.1.5.1.2"><p id="p487719816463"><a name="p487719816463"></a><a name="p487719816463"></a>Tablet</p>
</th>
<th class="cellrowborder" valign="top" width="25.147485251474855%" id="mcps1.1.5.1.3"><p id="p135771614203720"><a name="p135771614203720"></a><a name="p135771614203720"></a>Smart TV</p>
</th>
<th class="cellrowborder" valign="top" width="24.997500249975%" id="mcps1.1.5.1.4"><p id="p25772014133712"><a name="p25772014133712"></a><a name="p25772014133712"></a>Wearable</p>
</th>
</tr>
</thead>
<tbody><tr id="row8578151423715"><td class="cellrowborder" valign="top" width="24.257574242575743%" headers="mcps1.1.5.1.1 "><p id="p65782014203718"><a name="p65782014203718"></a><a name="p65782014203718"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.5974402559744%" headers="mcps1.1.5.1.2 "><p id="p137739557452"><a name="p137739557452"></a><a name="p137739557452"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.147485251474855%" headers="mcps1.1.5.1.3 "><p id="p26978547459"><a name="p26978547459"></a><a name="p26978547459"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="24.997500249975%" headers="mcps1.1.5.1.4 "><p id="p1893114512453"><a name="p1893114512453"></a><a name="p1893114512453"></a>Yes</p>
</td>
</tr>
</tbody>
</table>
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
```
import reminderAgent from '@ohos.reminderAgent';
```
## Required Permissions<a name="section11257113618419"></a>
ohos.permission.PUBLISH\_AGENT\_REMINDER
## reminderAgent.publishReminder<a name="section192192415554"></a>
publishReminder\(reminderReq: ReminderRequest, callback: AsyncCallback<number\>\): void
Publishes an agent-powered reminder. This method uses an asynchronous callback to return the published reminder's ID.
- Parameters
<a name="table552833562419"></a>
<table><thead align="left"><tr id="row149668318915_1"><th class="cellrowborder" valign="top" width="14.820000000000002%" id="mcps1.1.5.1.1"><p id="p653073517241"><a name="p653073517241"></a><a name="p653073517241"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="15.950000000000003%" id="mcps1.1.5.1.2"><p id="p1853017357240"><a name="p1853017357240"></a><a name="p1853017357240"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="16.970000000000002%" id="mcps1.1.5.1.3"><p id="p12530153562416"><a name="p12530153562416"></a><a name="p12530153562416"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="52.260000000000005%" id="mcps1.1.5.1.4"><p id="p17531173542420"><a name="p17531173542420"></a><a name="p17531173542420"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row99671533914_1"><td class="cellrowborder" valign="top" width="14.820000000000002%" headers="mcps1.1.5.1.1 "><p id="p1953114358246"><a name="p1953114358246"></a><a name="p1953114358246"></a>reminderReq</p>
</td>
<td class="cellrowborder" valign="top" width="15.950000000000003%" headers="mcps1.1.5.1.2 "><p id="p125321335162419"><a name="p125321335162419"></a><a name="p125321335162419"></a><a href="#section351144413217">ReminderRequest</a></p>
</td>
<td class="cellrowborder" valign="top" width="16.970000000000002%" headers="mcps1.1.5.1.3 "><p id="p20532133542419"><a name="p20532133542419"></a><a name="p20532133542419"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.260000000000005%" headers="mcps1.1.5.1.4 "><p id="p7533153542413"><a name="p7533153542413"></a><a name="p7533153542413"></a>Reminder to be published.</p>
</td>
</tr>
<tr id="row18967831393_1"><td class="cellrowborder" valign="top" width="14.820000000000002%" headers="mcps1.1.5.1.1 "><p id="p19533535132417"><a name="p19533535132417"></a><a name="p19533535132417"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="15.950000000000003%" headers="mcps1.1.5.1.2 "><p id="p05341035122417"><a name="p05341035122417"></a><a name="p05341035122417"></a>AsyncCallback&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="16.970000000000002%" headers="mcps1.1.5.1.3 "><p id="p18534235142412"><a name="p18534235142412"></a><a name="p18534235142412"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.260000000000005%" headers="mcps1.1.5.1.4 "><p id="p12534335162410"><a name="p12534335162410"></a><a name="p12534335162410"></a>Asynchronous callback used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
export default {
data: {
timer: {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 3
}
},
startTimer() {
reminderAgent.publishReminder(timer, (err, reminderId) => {
console.log("reminderId = " + reminderId);
});
}
}
```
## reminderAgent.publishReminder<a name="section01485631611"></a>
publishReminder\(reminderReq: ReminderRequest\): Promise<number\>
Publishes an agent-powered reminder. This method uses a promise callback to return the published reminder's ID.
- Parameters
<a name="table17452145512178"></a>
<table><thead align="left"><tr id="row545235520177"><th class="cellrowborder" valign="top" width="14.81%" id="mcps1.1.5.1.1"><p id="p17452155131715"><a name="p17452155131715"></a><a name="p17452155131715"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="13.850000000000001%" id="mcps1.1.5.1.2"><p id="p2452105519172"><a name="p2452105519172"></a><a name="p2452105519172"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="15.879999999999999%" id="mcps1.1.5.1.3"><p id="p14452955121711"><a name="p14452955121711"></a><a name="p14452955121711"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="55.46%" id="mcps1.1.5.1.4"><p id="p1145295512176"><a name="p1145295512176"></a><a name="p1145295512176"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row104521255121719"><td class="cellrowborder" valign="top" width="14.81%" headers="mcps1.1.5.1.1 "><p id="p345235519176"><a name="p345235519176"></a><a name="p345235519176"></a>reminderReq</p>
</td>
<td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.1.5.1.2 "><p id="p12452165591710"><a name="p12452165591710"></a><a name="p12452165591710"></a><a href="#section351144413217">ReminderRequest</a></p>
</td>
<td class="cellrowborder" valign="top" width="15.879999999999999%" headers="mcps1.1.5.1.3 "><p id="p345325517172"><a name="p345325517172"></a><a name="p345325517172"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.46%" headers="mcps1.1.5.1.4 "><p id="p17453655181710"><a name="p17453655181710"></a><a name="p17453655181710"></a>Reminder to be published.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table8453175520171"></a>
<table><thead align="left"><tr id="row1245355510178"><th class="cellrowborder" valign="top" width="16.49%" id="mcps1.1.3.1.1"><p id="p111061550175217"><a name="p111061550175217"></a><a name="p111061550175217"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="83.50999999999999%" id="mcps1.1.3.1.2"><p id="p54532557176"><a name="p54532557176"></a><a name="p54532557176"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row194530559171"><td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.1.3.1.1 "><p id="p6106250165212"><a name="p6106250165212"></a><a name="p6106250165212"></a>Promise&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="83.50999999999999%" headers="mcps1.1.3.1.2 "><p id="p3453185521713"><a name="p3453185521713"></a><a name="p3453185521713"></a>Promise used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
export default {
data: {
timer: {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 3
}
},
startTimer() {
reminderAgent.publishReminder(this.timer).then((reminderId) => {
console.log("reminderId = " + reminderId);
});
}
}
```
## reminderAgent.cancelReminder<a name="section1499919239817"></a>
cancelReminder\(reminderId: number, callback: AsyncCallback<void\>\): void
Cancels the reminder with the specified ID. This method uses an asynchronous callback to return the cancellation result.
- Parameters
<a name="table1552512311910"></a>
<table><thead align="left"><tr id="row155261223298"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p14766356916"><a name="p14766356916"></a><a name="p14766356916"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="24.560000000000002%" id="mcps1.1.5.1.2"><p id="p137619351911"><a name="p137619351911"></a><a name="p137619351911"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25.44%" id="mcps1.1.5.1.3"><p id="p15761335196"><a name="p15761335196"></a><a name="p15761335196"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p207653514912"><a name="p207653514912"></a><a name="p207653514912"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row9526723692"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1526523397"><a name="p1526523397"></a><a name="p1526523397"></a>reminderId</p>
</td>
<td class="cellrowborder" valign="top" width="24.560000000000002%" headers="mcps1.1.5.1.2 "><p id="p1526023792"><a name="p1526023792"></a><a name="p1526023792"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25.44%" headers="mcps1.1.5.1.3 "><p id="p1652613231193"><a name="p1652613231193"></a><a name="p1652613231193"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p8526323195"><a name="p8526323195"></a><a name="p8526323195"></a>ID of the reminder to cancel.</p>
</td>
</tr>
<tr id="row2526102316910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p42419381017"><a name="p42419381017"></a><a name="p42419381017"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="24.560000000000002%" headers="mcps1.1.5.1.2 "><p id="p32413316101"><a name="p32413316101"></a><a name="p32413316101"></a>AsyncCallback&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="25.44%" headers="mcps1.1.5.1.3 "><p id="p20241237108"><a name="p20241237108"></a><a name="p20241237108"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p10241193191015"><a name="p10241193191015"></a><a name="p10241193191015"></a>Asynchronous callback used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
export default {
cancel() {
reminderAgent.cancelReminder(1, (err, data) => {
console.log("do next");
});
}
}
```
## reminderAgent.cancelReminder<a name="section12314647135615"></a>
cancelReminder\(reminderId: number\): Promise<void\>
Cancels the reminder with the specified ID. This method uses a promise to return the cancellation result.
- Parameters
<a name="table155132817584"></a>
<table><thead align="left"><tr id="row65511428165816"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p9551112875817"><a name="p9551112875817"></a><a name="p9551112875817"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p1655112285580"><a name="p1655112285580"></a><a name="p1655112285580"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p955119288584"><a name="p955119288584"></a><a name="p955119288584"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p1055118285589"><a name="p1055118285589"></a><a name="p1055118285589"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row13552192814585"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p355272875812"><a name="p355272875812"></a><a name="p355272875812"></a>reminderId</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p1155212287589"><a name="p1155212287589"></a><a name="p1155212287589"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p6552182811589"><a name="p6552182811589"></a><a name="p6552182811589"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p15521284588"><a name="p15521284588"></a><a name="p15521284588"></a>ID of the reminder to cancel.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table146386141918"></a>
<table><thead align="left"><tr id="row8638214612"><th class="cellrowborder" valign="top" width="16.49%" id="mcps1.1.3.1.1"><p id="p1363871412117"><a name="p1363871412117"></a><a name="p1363871412117"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="83.50999999999999%" id="mcps1.1.3.1.2"><p id="p156381514110"><a name="p156381514110"></a><a name="p156381514110"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row9638161420117"><td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.1.3.1.1 "><p id="p106382141716"><a name="p106382141716"></a><a name="p106382141716"></a>Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="83.50999999999999%" headers="mcps1.1.3.1.2 "><p id="p9638101412116"><a name="p9638101412116"></a><a name="p9638101412116"></a>Promise used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
export default {
cancel() {
reminderAgent.cancelReminder(1).then(() => {
console.log("do next");
});
}
}
```
## reminderAgent.getValidReminders<a name="section1132713911215"></a>
getValidReminders\(callback: AsyncCallback<Array<ReminderRequest\>\>\): void
Obtains all valid \(not yet expired\) reminders set by the current application. This method uses an asynchronous callback to return the reminders.
- Parameters
<a name="table178891222111215"></a>
<table><thead align="left"><tr id="row1589513222126"><th class="cellrowborder" valign="top" width="19.470000000000002%" id="mcps1.1.5.1.1"><p id="p7279112691218"><a name="p7279112691218"></a><a name="p7279112691218"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="30.53%" id="mcps1.1.5.1.2"><p id="p11279132611126"><a name="p11279132611126"></a><a name="p11279132611126"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p19279142611217"><a name="p19279142611217"></a><a name="p19279142611217"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p132791526191220"><a name="p132791526191220"></a><a name="p132791526191220"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row188961221122"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.1.5.1.1 "><p id="p154501725111319"><a name="p154501725111319"></a><a name="p154501725111319"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="30.53%" headers="mcps1.1.5.1.2 "><p id="p545020254138"><a name="p545020254138"></a><a name="p545020254138"></a>AsyncCallback&lt;Array&lt;<a href="#section351144413217">ReminderRequest</a>&gt;&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p3450102511131"><a name="p3450102511131"></a><a name="p3450102511131"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p9450122531318"><a name="p9450122531318"></a><a name="p9450122531318"></a>Asynchronous callback used to return an array of all valid reminders set by the current application.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
reminderAgent.getValidReminders((err, reminders) => {
for (let i = 0; i < reminders.length; i++) {
console.log("getValidReminders = " + reminders[i]);
console.log("getValidReminders, reminderType = " + reminders[i].reminderType);
for (let j = 0; j < reminders[i].actionButton.length; j++) {
console.log("getValidReminders, actionButton.title = " + reminders[i].actionButton[j].title);
console.log("getValidReminders, actionButton.type = " + reminders[i].actionButton[j].type);
}
console.log("getValidReminders, wantAgent.pkgName = " + reminders[i].wantAgent.pkgName);
console.log("getValidReminders, wantAgent.abilityName = " + reminders[i].wantAgent.abilityName);
console.log("getValidReminders, maxScreenWantAgent.pkgName = " + reminders[i].maxScreenWantAgent.pkgName);
console.log("getValidReminders, maxScreenWantAgent.abilityName = " + reminders[i].maxScreenWantAgent.abilityName);
console.log("getValidReminders, ringDuration = " + reminders[i].ringDuration);
console.log("getValidReminders, snoozeTimes = " + reminders[i].snoozeTimes);
console.log("getValidReminders, timeInterval = " + reminders[i].timeInterval);
console.log("getValidReminders, title = " + reminders[i].title);
console.log("getValidReminders, content = " + reminders[i].content);
console.log("getValidReminders, expiredContent = " + reminders[i].expiredContent);
console.log("getValidReminders, snoozeContent = " + reminders[i].snoozeContent);
console.log("getValidReminders, notificationId = " + reminders[i].notificationId);
console.log("getValidReminders, slotType = " + reminders[i].slotType);
}
})
```
## reminderAgent.getValidReminders<a name="section43649405310"></a>
getValidReminders\(\): Promise<Array<ReminderRequest\>\>
Obtains all valid \(not yet expired\) reminders set by the current application. This method uses a promise to return the reminders.
- Return values
<a name="table187080176416"></a>
<table><thead align="left"><tr id="row770816172041"><th class="cellrowborder" valign="top" width="35.42%" id="mcps1.1.3.1.1"><p id="p931203175318"><a name="p931203175318"></a><a name="p931203175318"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="64.58%" id="mcps1.1.3.1.2"><p id="p157099171145"><a name="p157099171145"></a><a name="p157099171145"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row970914171947"><td class="cellrowborder" valign="top" width="35.42%" headers="mcps1.1.3.1.1 "><p id="p15311231145316"><a name="p15311231145316"></a><a name="p15311231145316"></a>Promise&lt;Array&lt;<a href="#section351144413217">ReminderRequest</a>&gt;&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="64.58%" headers="mcps1.1.3.1.2 "><p id="p5709101715414"><a name="p5709101715414"></a><a name="p5709101715414"></a>Promise used to return an array of all valid reminders set by the current application.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
reminderAgent.getValidReminders().then((reminders) => {
for (let i = 0; i < reminders.length; i++) {
console.log("getValidReminders = " + reminders[i]);
console.log("getValidReminders, reminderType = " + reminders[i].reminderType);
for (let j = 0; j < reminders[i].actionButton.length; j++) {
console.log("getValidReminders, actionButton.title = " + reminders[i].actionButton[j].title);
console.log("getValidReminders, actionButton.type = " + reminders[i].actionButton[j].type);
}
console.log("getValidReminders, wantAgent.pkgName = " + reminders[i].wantAgent.pkgName);
console.log("getValidReminders, wantAgent.abilityName = " + reminders[i].wantAgent.abilityName);
console.log("getValidReminders, maxScreenWantAgent.pkgName = " + reminders[i].maxScreenWantAgent.pkgName);
console.log("getValidReminders, maxScreenWantAgent.abilityName = " + reminders[i].maxScreenWantAgent.abilityName);
console.log("getValidReminders, ringDuration = " + reminders[i].ringDuration);
console.log("getValidReminders, snoozeTimes = " + reminders[i].snoozeTimes);
console.log("getValidReminders, timeInterval = " + reminders[i].timeInterval);
console.log("getValidReminders, title = " + reminders[i].title);
console.log("getValidReminders, content = " + reminders[i].content);
console.log("getValidReminders, expiredContent = " + reminders[i].expiredContent);
console.log("getValidReminders, snoozeContent = " + reminders[i].snoozeContent);
console.log("getValidReminders, notificationId = " + reminders[i].notificationId);
console.log("getValidReminders, slotType = " + reminders[i].slotType);
}
})
```
## reminderAgent.cancelAllReminders<a name="section45271040171518"></a>
cancelAllReminders\(callback: AsyncCallback<void\>\): void
Cancels all reminders set by the current application. This method uses an asynchronous callback to return the cancellation result.
- Parameters
<a name="table534005201614"></a>
<table><thead align="left"><tr id="row1834055141618"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p1662742420169"><a name="p1662742420169"></a><a name="p1662742420169"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p16272247164"><a name="p16272247164"></a><a name="p16272247164"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p146271924151612"><a name="p146271924151612"></a><a name="p146271924151612"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p46276248164"><a name="p46276248164"></a><a name="p46276248164"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row634025131612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1374893112168"><a name="p1374893112168"></a><a name="p1374893112168"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p12748531141615"><a name="p12748531141615"></a><a name="p12748531141615"></a>AsyncCallback&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p7748531111615"><a name="p7748531111615"></a><a name="p7748531111615"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p13748123131616"><a name="p13748123131616"></a><a name="p13748123131616"></a>Asynchronous callback used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
reminderAgent.cancelAllReminders((err, data) =>{
console.log("do next")}
)
```
## reminderAgent.cancelAllReminders<a name="section995114367166"></a>
cancelAllReminders\(\): Promise<void\>
Cancels all reminders set by the current application. This method uses a promise to return the cancellation result.
- Return values
<a name="table29095131310"></a>
<table><thead align="left"><tr id="row12909161310318"><th class="cellrowborder" valign="top" width="16.49%" id="mcps1.1.3.1.1"><p id="p14909141310317"><a name="p14909141310317"></a><a name="p14909141310317"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="83.50999999999999%" id="mcps1.1.3.1.2"><p id="p99097132317"><a name="p99097132317"></a><a name="p99097132317"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row790913131530"><td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.1.3.1.1 "><p id="p1790912131337"><a name="p1790912131337"></a><a name="p1790912131337"></a>Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="83.50999999999999%" headers="mcps1.1.3.1.2 "><p id="p10909141313310"><a name="p10909141313310"></a><a name="p10909141313310"></a>Promise used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
reminderAgent.cancelAllReminders().then(() => {
console.log("do next")}
)
```
## reminderAgent.addNotificationSlot<a name="section5438241287"></a>
addNotificationSlot\(slot: NotificationSlot, callback: AsyncCallback<void\>\): void
Adds a reminder notification slot. This method uses an asynchronous callback to return the result.
- Parameters
<a name="table35415101896"></a>
<table><thead align="left"><tr id="row19548100916"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p20542107919"><a name="p20542107919"></a><a name="p20542107919"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p4548106917"><a name="p4548106917"></a><a name="p4548106917"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p05410105910"><a name="p05410105910"></a><a name="p05410105910"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p1054101017911"><a name="p1054101017911"></a><a name="p1054101017911"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row35416101090"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p3542103919"><a name="p3542103919"></a><a name="p3542103919"></a>slot</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p75441016916"><a name="p75441016916"></a><a name="p75441016916"></a><a href="../nottoctopics/en-us_topic_0000001180018813.md#section1382174172015">NotificationSlot</a></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p1754181020915"><a name="p1754181020915"></a><a name="p1754181020915"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p13541510592"><a name="p13541510592"></a><a name="p13541510592"></a>Reminder notification slot to add.</p>
</td>
</tr>
<tr id="row8545101292"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1754910498"><a name="p1754910498"></a><a name="p1754910498"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p11541310397"><a name="p11541310397"></a><a name="p11541310397"></a>AsyncCallback&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p3548101192"><a name="p3548101192"></a><a name="p3548101192"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p9553101593"><a name="p9553101593"></a><a name="p9553101593"></a>Asynchronous callback used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
export default {
data: {
mySlot: {
type: 3,
sound: "/sdcard/music2.mp3"
}
},
addSlot() {
reminderAgent.addNotificationSlot(this.mySlot, (err, data) => {
console.log("do next");
});
}
}
```
## reminderAgent.addNotificationSlot<a name="section9578138886"></a>
addNotificationSlot\(slot: NotificationSlot\): Promise<void\>
Adds a reminder notification slot. This method uses a promise to return the result.
- Parameters
<a name="table144984401798"></a>
<table><thead align="left"><tr id="row204981240997"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p94982040897"><a name="p94982040897"></a><a name="p94982040897"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p549904010913"><a name="p549904010913"></a><a name="p549904010913"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p94999405911"><a name="p94999405911"></a><a name="p94999405911"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p1549924017914"><a name="p1549924017914"></a><a name="p1549924017914"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row949919401498"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p449911401493"><a name="p449911401493"></a><a name="p449911401493"></a>slot</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p114991540996"><a name="p114991540996"></a><a name="p114991540996"></a><a href="../nottoctopics/en-us_topic_0000001180018813.md#section1382174172015">NotificationSlot</a></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p04991140690"><a name="p04991140690"></a><a name="p04991140690"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p6499114013913"><a name="p6499114013913"></a><a name="p6499114013913"></a>Reminder notification slot to add.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table8952481825"></a>
<table><thead align="left"><tr id="row129527818213"><th class="cellrowborder" valign="top" width="16.49%" id="mcps1.1.3.1.1"><p id="p5952789213"><a name="p5952789213"></a><a name="p5952789213"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="83.50999999999999%" id="mcps1.1.3.1.2"><p id="p199526812214"><a name="p199526812214"></a><a name="p199526812214"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8952198027"><td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.1.3.1.1 "><p id="p15952281027"><a name="p15952281027"></a><a name="p15952281027"></a>Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="83.50999999999999%" headers="mcps1.1.3.1.2 "><p id="p69521686215"><a name="p69521686215"></a><a name="p69521686215"></a>Promise used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
export default {
data: {
mySlot: {
type: 3,
sound: "/sdcard/music2.mp3"
}
},
addSlot() {
reminderAgent.addNotificationSlot(this.mySlot).then(() => {
console.log("do next");
});
}
}
```
## reminderAgent.removeNotificationSlot<a name="section690314291188"></a>
removeNotificationSlot\(slotType: notification.SlotType, callback: AsyncCallback<void\>\): void
Removes a **NotificationSlot** instance of a specified type. This method uses an asynchronous callback to return the result.
- Parameters
<a name="table18836121111196"></a>
<table><thead align="left"><tr id="row1283611161918"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p11229116171910"><a name="p11229116171910"></a><a name="p11229116171910"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p172294165191"><a name="p172294165191"></a><a name="p172294165191"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p422941611194"><a name="p422941611194"></a><a name="p422941611194"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p1122910168192"><a name="p1122910168192"></a><a name="p1122910168192"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row48371611201912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p583701119198"><a name="p583701119198"></a><a name="p583701119198"></a>slotType</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p283751171916"><a name="p283751171916"></a><a name="p283751171916"></a><a href="../nottoctopics/en-us_topic_0000001180018813.md#section072355105110">notification.SlotType</a></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p2083731110197"><a name="p2083731110197"></a><a name="p2083731110197"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p38371711181913"><a name="p38371711181913"></a><a name="p38371711181913"></a>Type of the reminder notification slot to remove.</p>
</td>
</tr>
<tr id="row483718118198"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p106321702208"><a name="p106321702208"></a><a name="p106321702208"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p186324012019"><a name="p186324012019"></a><a name="p186324012019"></a>AsyncCallback&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p263210012203"><a name="p263210012203"></a><a name="p263210012203"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p13632804203"><a name="p13632804203"></a><a name="p13632804203"></a>Asynchronous callback used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
export default {
removeSlot() {
reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) => {
console.log("do next");
});
}
}
```
## reminderAgent.removeNotificationSlot<a name="section7370189151011"></a>
removeNotificationSlot\(slotType: notification.SlotType\): Promise<void\>
Removes a **NotificationSlot** instance of a specified type. This method uses a promise to return the result.
- Parameters
<a name="table12207123541011"></a>
<table><thead align="left"><tr id="row142073350105"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p1720712352109"><a name="p1720712352109"></a><a name="p1720712352109"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p720719355109"><a name="p720719355109"></a><a name="p720719355109"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p1720793591014"><a name="p1720793591014"></a><a name="p1720793591014"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p72077353109"><a name="p72077353109"></a><a name="p72077353109"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row120720355108"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1120893520105"><a name="p1120893520105"></a><a name="p1120893520105"></a>slotType</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p22081435141018"><a name="p22081435141018"></a><a name="p22081435141018"></a><a href="../nottoctopics/en-us_topic_0000001180018813.md#section072355105110">notification.SlotType</a></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p920813531010"><a name="p920813531010"></a><a name="p920813531010"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p72081335131013"><a name="p72081335131013"></a><a name="p72081335131013"></a>Type of the reminder notification slot to remove.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table993713301926"></a>
<table><thead align="left"><tr id="row493714301427"><th class="cellrowborder" valign="top" width="16.49%" id="mcps1.1.3.1.1"><p id="p17937430426"><a name="p17937430426"></a><a name="p17937430426"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="83.50999999999999%" id="mcps1.1.3.1.2"><p id="p1493712301211"><a name="p1493712301211"></a><a name="p1493712301211"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row119371130229"><td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.1.3.1.1 "><p id="p139372301324"><a name="p139372301324"></a><a name="p139372301324"></a>Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="83.50999999999999%" headers="mcps1.1.3.1.2 "><p id="p159379302215"><a name="p159379302215"></a><a name="p159379302215"></a>Promise used to return the result.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
export default {
removeSlot() {
reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() => {
console.log("do next");
});
}
}
```
## ActionButtonType<a name="section099619567453"></a>
Enumerates button types.
<a name="table20633101642315"></a>
<table><thead align="left"><tr id="row663331618238"><th class="cellrowborder" valign="top" width="27.900000000000002%" id="mcps1.1.4.1.1"><p id="a3d0fc780cc904c1cbab7991251622f65"><a name="a3d0fc780cc904c1cbab7991251622f65"></a><a name="a3d0fc780cc904c1cbab7991251622f65"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="12.43%" id="mcps1.1.4.1.2"><p id="aace9cae4ba0d4939bfa048460f61c3c7"><a name="aace9cae4ba0d4939bfa048460f61c3c7"></a><a name="aace9cae4ba0d4939bfa048460f61c3c7"></a>Default Value</p>
</th>
<th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="afec895de33f94e3c87ee7acc20190a17"><a name="afec895de33f94e3c87ee7acc20190a17"></a><a name="afec895de33f94e3c87ee7acc20190a17"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row188481425182510"><td class="cellrowborder" valign="top" width="27.900000000000002%" headers="mcps1.1.4.1.1 "><p id="p52851329122117"><a name="p52851329122117"></a><a name="p52851329122117"></a>ACTION_BUTTON_TYPE_CLOSE</p>
</td>
<td class="cellrowborder" valign="top" width="12.43%" headers="mcps1.1.4.1.2 "><p id="p2282152962115"><a name="p2282152962115"></a><a name="p2282152962115"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p328012293211"><a name="p328012293211"></a><a name="p328012293211"></a>Button for closing the reminder.</p>
</td>
</tr>
<tr id="row0461622112513"><td class="cellrowborder" valign="top" width="27.900000000000002%" headers="mcps1.1.4.1.1 "><p id="p12106173918219"><a name="p12106173918219"></a><a name="p12106173918219"></a>ACTION_BUTTON_TYPE_SNOOZE</p>
</td>
<td class="cellrowborder" valign="top" width="12.43%" headers="mcps1.1.4.1.2 "><p id="p1310553911218"><a name="p1310553911218"></a><a name="p1310553911218"></a>1</p>
</td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p15865395215"><a name="p15865395215"></a><a name="p15865395215"></a>Button for snoozing the reminder.</p>
</td>
</tr>
</tbody>
</table>
## ReminderType<a name="section2657271303"></a>
Enumerates reminder types.
<a name="table2900133119415"></a>
<table><thead align="left"><tr id="row19067314413"><th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.1.4.1.1"><p id="p179062311742"><a name="p179062311742"></a><a name="p179062311742"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.1.4.1.2"><p id="p29062313419"><a name="p29062313419"></a><a name="p29062313419"></a>Default Value</p>
</th>
<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.1.4.1.3"><p id="p09061317413"><a name="p09061317413"></a><a name="p09061317413"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1290613318410"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.1 "><p id="p99062311246"><a name="p99062311246"></a><a name="p99062311246"></a>REMINDER_TYPE_TIMER</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.2 "><p id="p1890618311647"><a name="p1890618311647"></a><a name="p1890618311647"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.3 "><p id="p19068314416"><a name="p19068314416"></a><a name="p19068314416"></a>Countdown reminder.</p>
</td>
</tr>
<tr id="row19906631841"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.1 "><p id="p119061831645"><a name="p119061831645"></a><a name="p119061831645"></a>REMINDER_TYPE_CALENDAR</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.2 "><p id="p29067311648"><a name="p29067311648"></a><a name="p29067311648"></a>1</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.3 "><p id="p1212482762"><a name="p1212482762"></a><a name="p1212482762"></a>Calendar reminder.</p>
</td>
</tr>
<tr id="row13209436251"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.1 "><p id="p19215133613519"><a name="p19215133613519"></a><a name="p19215133613519"></a>REMINDER_TYPE_ALARM</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.2 "><p id="p18215183620512"><a name="p18215183620512"></a><a name="p18215183620512"></a>2</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.1.4.1.3 "><p id="p3768321467"><a name="p3768321467"></a><a name="p3768321467"></a>Alarm reminder.</p>
</td>
</tr>
</tbody>
</table>
## ActionButton<a name="section256244135613"></a>
Defines a button displayed in the reminder notification.
<a name="table0103172561814"></a>
<table><thead align="left"><tr id="row12103152513185"><th class="cellrowborder" valign="top" width="15.3015301530153%" id="mcps1.1.5.1.1"><p id="p1610322561817"><a name="p1610322561817"></a><a name="p1610322561817"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.891489148914891%" id="mcps1.1.5.1.2"><p id="p20103132551816"><a name="p20103132551816"></a><a name="p20103132551816"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="10.561056105610561%" id="mcps1.1.5.1.3"><p id="p1103172518188"><a name="p1103172518188"></a><a name="p1103172518188"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.245924592459254%" id="mcps1.1.5.1.4"><p id="p19103125141812"><a name="p19103125141812"></a><a name="p19103125141812"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row201031125101812"><td class="cellrowborder" valign="top" width="15.3015301530153%" headers="mcps1.1.5.1.1 "><p id="p293518218251"><a name="p293518218251"></a><a name="p293518218251"></a>title</p>
</td>
<td class="cellrowborder" valign="top" width="14.891489148914891%" headers="mcps1.1.5.1.2 "><p id="p39351925253"><a name="p39351925253"></a><a name="p39351925253"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="10.561056105610561%" headers="mcps1.1.5.1.3 "><p id="p8935162182512"><a name="p8935162182512"></a><a name="p8935162182512"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.245924592459254%" headers="mcps1.1.5.1.4 "><p id="p109351224253"><a name="p109351224253"></a><a name="p109351224253"></a>Text on the button.</p>
</td>
</tr>
<tr id="row750201314232"><td class="cellrowborder" valign="top" width="15.3015301530153%" headers="mcps1.1.5.1.1 "><p id="p5501413112313"><a name="p5501413112313"></a><a name="p5501413112313"></a>type</p>
</td>
<td class="cellrowborder" valign="top" width="14.891489148914891%" headers="mcps1.1.5.1.2 "><p id="p7501313142310"><a name="p7501313142310"></a><a name="p7501313142310"></a><a href="#section099619567453">ActionButtonType</a></p>
</td>
<td class="cellrowborder" valign="top" width="10.561056105610561%" headers="mcps1.1.5.1.3 "><p id="p550141313239"><a name="p550141313239"></a><a name="p550141313239"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.245924592459254%" headers="mcps1.1.5.1.4 "><p id="p197354308819"><a name="p197354308819"></a><a name="p197354308819"></a>Button type.</p>
</td>
</tr>
</tbody>
</table>
## WantAgent<a name="section1225014446367"></a>
Sets the package and ability that are redirected to when the reminder notification is clicked.
<a name="table189723718371"></a>
<table><thead align="left"><tr id="row1410333716376"><th class="cellrowborder" valign="top" width="17.49%" id="mcps1.1.5.1.1"><p id="p1835875816376"><a name="p1835875816376"></a><a name="p1835875816376"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.1.5.1.2"><p id="p161031537183718"><a name="p161031537183718"></a><a name="p161031537183718"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="21.97%" id="mcps1.1.5.1.3"><p id="p15103133743715"><a name="p15103133743715"></a><a name="p15103133743715"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="42.94%" id="mcps1.1.5.1.4"><p id="p17103537133712"><a name="p17103537133712"></a><a name="p17103537133712"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row6103113719375"><td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.1.5.1.1 "><p id="p1110319371371"><a name="p1110319371371"></a><a name="p1110319371371"></a>pkgName</p>
</td>
<td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.2 "><p id="p13103837173713"><a name="p13103837173713"></a><a name="p13103837173713"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="21.97%" headers="mcps1.1.5.1.3 "><p id="p111038377378"><a name="p111038377378"></a><a name="p111038377378"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.94%" headers="mcps1.1.5.1.4 "><p id="p11032371372"><a name="p11032371372"></a><a name="p11032371372"></a>Name of the package redirected to when the reminder notification is clicked.</p>
</td>
</tr>
<tr id="row1010313376379"><td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.1.5.1.1 "><p id="p10103137163715"><a name="p10103137163715"></a><a name="p10103137163715"></a>abilityName</p>
</td>
<td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.2 "><p id="p131031237103713"><a name="p131031237103713"></a><a name="p131031237103713"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="21.97%" headers="mcps1.1.5.1.3 "><p id="p910353793716"><a name="p910353793716"></a><a name="p910353793716"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.94%" headers="mcps1.1.5.1.4 "><p id="p110323723719"><a name="p110323723719"></a><a name="p110323723719"></a>Name of the ability that is redirected to when the reminder notification is clicked.</p>
</td>
</tr>
</tbody>
</table>
## MaxScreenWantAgent<a name="section442031712444"></a>
Sets the name of the target package and ability to start automatically when the reminder arrives and the device is not in use. If the device is in use, a notification will be displayed.
<a name="table5665154184414"></a>
<table><thead align="left"><tr id="row667004164415"><th class="cellrowborder" valign="top" width="15.22%" id="mcps1.1.5.1.1"><p id="p067875154419"><a name="p067875154419"></a><a name="p067875154419"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="15.21%" id="mcps1.1.5.1.2"><p id="p1067895112446"><a name="p1067895112446"></a><a name="p1067895112446"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="17%" id="mcps1.1.5.1.3"><p id="p166784511444"><a name="p166784511444"></a><a name="p166784511444"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="52.56999999999999%" id="mcps1.1.5.1.4"><p id="p166784518445"><a name="p166784518445"></a><a name="p166784518445"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row10671124114440"><td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.1.5.1.1 "><p id="p1641510290476"><a name="p1641510290476"></a><a name="p1641510290476"></a>pkgName</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.2 "><p id="p941516290477"><a name="p941516290477"></a><a name="p941516290477"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.1.5.1.3 "><p id="p134158295472"><a name="p134158295472"></a><a name="p134158295472"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.56999999999999%" headers="mcps1.1.5.1.4 "><p id="p06713419449"><a name="p06713419449"></a><a name="p06713419449"></a>Name of the package that is automatically started when the reminder arrives and the device is not in use.</p>
</td>
</tr>
<tr id="row1767164104416"><td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.1.5.1.1 "><p id="p1415182918479"><a name="p1415182918479"></a><a name="p1415182918479"></a>abilityName</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.2 "><p id="p9415142974718"><a name="p9415142974718"></a><a name="p9415142974718"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.1.5.1.3 "><p id="p1441502944718"><a name="p1441502944718"></a><a name="p1441502944718"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.56999999999999%" headers="mcps1.1.5.1.4 "><p id="p1067124114413"><a name="p1067124114413"></a><a name="p1067124114413"></a>Name of the ability that is automatically started when the reminder arrives and the device is not in use.</p>
</td>
</tr>
</tbody>
</table>
## ReminderRequest<a name="section351144413217"></a>
Defines the reminder to publish.
<a name="table1290341511316"></a>
<table><thead align="left"><tr id="row89081015834"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p15182016319"><a name="p15182016319"></a><a name="p15182016319"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p4117201531"><a name="p4117201531"></a><a name="p4117201531"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="15.21%" id="mcps1.1.5.1.3"><p id="p91132015318"><a name="p91132015318"></a><a name="p91132015318"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="34.79%" id="mcps1.1.5.1.4"><p id="p4116201939"><a name="p4116201939"></a><a name="p4116201939"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row19096154313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p17909121519315"><a name="p17909121519315"></a><a name="p17909121519315"></a>reminderType</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p119096151035"><a name="p119096151035"></a><a name="p119096151035"></a>ReminderType</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p1890916151932"><a name="p1890916151932"></a><a name="p1890916151932"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p189097154319"><a name="p189097154319"></a><a name="p189097154319"></a>Type of the reminder.</p>
</td>
</tr>
<tr id="row4909111515313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p79090155314"><a name="p79090155314"></a><a name="p79090155314"></a>actionButton</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p690913152319"><a name="p690913152319"></a><a name="p690913152319"></a>[ActionButton?, ActionButton?]</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p109096151136"><a name="p109096151136"></a><a name="p109096151136"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p290916157310"><a name="p290916157310"></a><a name="p290916157310"></a>Action button displayed in the reminder notification. (The parameter is optional. Up to two buttons are supported.)</p>
</td>
</tr>
<tr id="row18909415537"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p10909215036"><a name="p10909215036"></a><a name="p10909215036"></a>wantAgent</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p1790917151030"><a name="p1790917151030"></a><a name="p1790917151030"></a>WantAgent</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p690918155311"><a name="p690918155311"></a><a name="p690918155311"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p39099154310"><a name="p39099154310"></a><a name="p39099154310"></a>Information about the ability that is redirected to when the notification is clicked.</p>
</td>
</tr>
<tr id="row290961515313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p59094154320"><a name="p59094154320"></a><a name="p59094154320"></a>maxScreenWantAgent</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p15909161517314"><a name="p15909161517314"></a><a name="p15909161517314"></a>MaxScreenWantAgent</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p1286714720714"><a name="p1286714720714"></a><a name="p1286714720714"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p1590971511318"><a name="p1590971511318"></a><a name="p1590971511318"></a>Information about the ability that is automatically started when the reminder arrives. If the device is in use, a notification will be displayed.</p>
</td>
</tr>
<tr id="row8909715730"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1890918151311"><a name="p1890918151311"></a><a name="p1890918151311"></a>ringDuration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p59091515030"><a name="p59091515030"></a><a name="p59091515030"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p1889171471"><a name="p1889171471"></a><a name="p1889171471"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p0909815932"><a name="p0909815932"></a><a name="p0909815932"></a>Ringing duration.</p>
</td>
</tr>
<tr id="row189091151637"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p490919153316"><a name="p490919153316"></a><a name="p490919153316"></a>snoozeTimes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p13909181514311"><a name="p13909181514311"></a><a name="p13909181514311"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p292087771"><a name="p292087771"></a><a name="p292087771"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p09101215435"><a name="p09101215435"></a><a name="p09101215435"></a>Number of reminder snooze times.</p>
</td>
</tr>
<tr id="row1691016154310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p15910151518311"><a name="p15910151518311"></a><a name="p15910151518311"></a>timeInterval</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p59100152035"><a name="p59100152035"></a><a name="p59100152035"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p59381172719"><a name="p59381172719"></a><a name="p59381172719"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p1891016151332"><a name="p1891016151332"></a><a name="p1891016151332"></a>Reminder snooze interval.</p>
</td>
</tr>
<tr id="row66171484413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p06261381549"><a name="p06261381549"></a><a name="p06261381549"></a>title</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p1962612820413"><a name="p1962612820413"></a><a name="p1962612820413"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p495618718720"><a name="p495618718720"></a><a name="p495618718720"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p3626380410"><a name="p3626380410"></a><a name="p3626380410"></a>Reminder title.</p>
</td>
</tr>
<tr id="row0463331249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1946733249"><a name="p1946733249"></a><a name="p1946733249"></a>content</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p04616336415"><a name="p04616336415"></a><a name="p04616336415"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p4973672710"><a name="p4973672710"></a><a name="p4973672710"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p11461533349"><a name="p11461533349"></a><a name="p11461533349"></a>Reminder content.</p>
</td>
</tr>
<tr id="row93248291645"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p63301829549"><a name="p63301829549"></a><a name="p63301829549"></a>expiredContent</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p233012291047"><a name="p233012291047"></a><a name="p233012291047"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p1298567671"><a name="p1298567671"></a><a name="p1298567671"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p1133019297412"><a name="p1133019297412"></a><a name="p1133019297412"></a>Content to be displayed after the reminder expires.</p>
</td>
</tr>
<tr id="row34302231744"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1443614231246"><a name="p1443614231246"></a><a name="p1443614231246"></a>snoozeContent</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p74365234411"><a name="p74365234411"></a><a name="p74365234411"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p499627179"><a name="p499627179"></a><a name="p499627179"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p144369238411"><a name="p144369238411"></a><a name="p144369238411"></a>Content to be displayed when the reminder is snoozing.</p>
</td>
</tr>
<tr id="row540852612412"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p34081726541"><a name="p34081726541"></a><a name="p34081726541"></a>notificationId</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p2408426148"><a name="p2408426148"></a><a name="p2408426148"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p14848475"><a name="p14848475"></a><a name="p14848475"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p1408226147"><a name="p1408226147"></a><a name="p1408226147"></a>Notification ID used by the reminder. If there are reminders with the same notification ID, the later one will overwrite the earlier one.</p>
</td>
</tr>
<tr id="row47993181141"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p198054189418"><a name="p198054189418"></a><a name="p198054189418"></a>slotType</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p18805318844"><a name="p18805318844"></a><a name="p18805318844"></a><a href="../nottoctopics/en-us_topic_0000001180018813.md#section072355105110">notification.SlotType</a></p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.1.5.1.3 "><p id="p162610811713"><a name="p162610811713"></a><a name="p162610811713"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="34.79%" headers="mcps1.1.5.1.4 "><p id="p38051918641"><a name="p38051918641"></a><a name="p38051918641"></a>Type of the slot used by the reminder.</p>
</td>
</tr>
</tbody>
</table>
## ReminderRequestCalendar<a name="section91823641810"></a>
ReminderRequestCalendar extends ReminderRequest
Defines a reminder for a calendar event.
<a name="table1348794314217"></a>
<table><thead align="left"><tr id="row9493164312218"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p814317512211"><a name="p814317512211"></a><a name="p814317512211"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p191435510217"><a name="p191435510217"></a><a name="p191435510217"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p114310513214"><a name="p114310513214"></a><a name="p114310513214"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p1514345102118"><a name="p1514345102118"></a><a name="p1514345102118"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row11493184352111"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p15493114310215"><a name="p15493114310215"></a><a name="p15493114310215"></a>dateTime</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p949412434212"><a name="p949412434212"></a><a name="p949412434212"></a><a href="#section89511926203615">LocalDateTime</a></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p20494184362111"><a name="p20494184362111"></a><a name="p20494184362111"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p54942043142112"><a name="p54942043142112"></a><a name="p54942043142112"></a>Reminder time.</p>
</td>
</tr>
<tr id="row1849434312114"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1849454342114"><a name="p1849454342114"></a><a name="p1849454342114"></a>repeatMonths</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p5494194352117"><a name="p5494194352117"></a><a name="p5494194352117"></a>Array&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p184941143112110"><a name="p184941143112110"></a><a name="p184941143112110"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p1949464352118"><a name="p1949464352118"></a><a name="p1949464352118"></a>Month in which the reminder repeats.</p>
</td>
</tr>
<tr id="row1049415430216"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p114941243132113"><a name="p114941243132113"></a><a name="p114941243132113"></a>repeatDays</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p1549434315212"><a name="p1549434315212"></a><a name="p1549434315212"></a>Array&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p1349414432218"><a name="p1349414432218"></a><a name="p1349414432218"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p18494164317214"><a name="p18494164317214"></a><a name="p18494164317214"></a>Date on which the reminder repeats.</p>
</td>
</tr>
</tbody>
</table>
## ReminderRequestAlarm<a name="section1195619282246"></a>
ReminderRequestAlarm extends ReminderRequest
Defines a reminder for the alarm clock.
<a name="table2536135232411"></a>
<table><thead align="left"><tr id="row10542195232417"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p10944125614245"><a name="p10944125614245"></a><a name="p10944125614245"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p11944105662411"><a name="p11944105662411"></a><a name="p11944105662411"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p149441568241"><a name="p149441568241"></a><a name="p149441568241"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p1494412560242"><a name="p1494412560242"></a><a name="p1494412560242"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row75421252122412"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p45421952152415"><a name="p45421952152415"></a><a name="p45421952152415"></a>hour</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p15421152172418"><a name="p15421152172418"></a><a name="p15421152172418"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p18542165212416"><a name="p18542165212416"></a><a name="p18542165212416"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p654235218243"><a name="p654235218243"></a><a name="p654235218243"></a>Hour portion of the reminder time.</p>
</td>
</tr>
<tr id="row195427528245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p16542115212419"><a name="p16542115212419"></a><a name="p16542115212419"></a>minute</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p6542552202417"><a name="p6542552202417"></a><a name="p6542552202417"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p55421152172415"><a name="p55421152172415"></a><a name="p55421152172415"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p1254265213248"><a name="p1254265213248"></a><a name="p1254265213248"></a>Minute portion of the reminder time.</p>
</td>
</tr>
<tr id="row10542752132419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p155421952112417"><a name="p155421952112417"></a><a name="p155421952112417"></a>daysOfWeek</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p154295292414"><a name="p154295292414"></a><a name="p154295292414"></a>Array&lt;number&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p5542185212410"><a name="p5542185212410"></a><a name="p5542185212410"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p125422524244"><a name="p125422524244"></a><a name="p125422524244"></a>Days of a week when the reminder repeats.</p>
</td>
</tr>
</tbody>
</table>
## ReminderRequestTimer<a name="section383902012275"></a>
Defines a **ReminderRequestTimer** instance, which extends **ReminderRequest**.
Defines a reminder for a scheduled timer.
<a name="table16410183917272"></a>
<table><thead align="left"><tr id="row11416103915275"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p28631117296"><a name="p28631117296"></a><a name="p28631117296"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p108632102910"><a name="p108632102910"></a><a name="p108632102910"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p286314116295"><a name="p286314116295"></a><a name="p286314116295"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p98631811291"><a name="p98631811291"></a><a name="p98631811291"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1241643916276"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p8416139132718"><a name="p8416139132718"></a><a name="p8416139132718"></a>triggerTimeInSeconds</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p174162039172719"><a name="p174162039172719"></a><a name="p174162039172719"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p1241693916278"><a name="p1241693916278"></a><a name="p1241693916278"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p7416133915270"><a name="p7416133915270"></a><a name="p7416133915270"></a>Number of seconds in the countdown timer.</p>
</td>
</tr>
</tbody>
</table>
## LocalDateTime<a name="section89511926203615"></a>
Sets the time information for a calendar reminder.
<a name="table2073374723614"></a>
<table><thead align="left"><tr id="row373424723619"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p12446655133620"><a name="p12446655133620"></a><a name="p12446655133620"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p144625543610"><a name="p144625543610"></a><a name="p144625543610"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p16446655123612"><a name="p16446655123612"></a><a name="p16446655123612"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p114461755133614"><a name="p114461755133614"></a><a name="p114461755133614"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row4734164773613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p173454718366"><a name="p173454718366"></a><a name="p173454718366"></a>year</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p3734447143614"><a name="p3734447143614"></a><a name="p3734447143614"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p4734247113610"><a name="p4734247113610"></a><a name="p4734247113610"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p16734124783614"><a name="p16734124783614"></a><a name="p16734124783614"></a>Year.</p>
</td>
</tr>
<tr id="row11734194723614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p6734124717362"><a name="p6734124717362"></a><a name="p6734124717362"></a>month</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p573424710363"><a name="p573424710363"></a><a name="p573424710363"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p094429163719"><a name="p094429163719"></a><a name="p094429163719"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p373418475366"><a name="p373418475366"></a><a name="p373418475366"></a>Month.</p>
</td>
</tr>
<tr id="row7734114712363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p157347473362"><a name="p157347473362"></a><a name="p157347473362"></a>day</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p1972412153716"><a name="p1972412153716"></a><a name="p1972412153716"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p10110122973716"><a name="p10110122973716"></a><a name="p10110122973716"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p773534733618"><a name="p773534733618"></a><a name="p773534733618"></a>Date.</p>
</td>
</tr>
<tr id="row0735134753616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p10735124718366"><a name="p10735124718366"></a><a name="p10735124718366"></a>hour</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p5751142117378"><a name="p5751142117378"></a><a name="p5751142117378"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p112512298377"><a name="p112512298377"></a><a name="p112512298377"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p15735144743613"><a name="p15735144743613"></a><a name="p15735144743613"></a>Hour.</p>
</td>
</tr>
<tr id="row11735247103620"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p1473554717364"><a name="p1473554717364"></a><a name="p1473554717364"></a>minute</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p4786921183715"><a name="p4786921183715"></a><a name="p4786921183715"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p151411029133719"><a name="p151411029133719"></a><a name="p151411029133719"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p147356473363"><a name="p147356473363"></a><a name="p147356473363"></a>Minute.</p>
</td>
</tr>
<tr id="row5735347113619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p107351847113615"><a name="p107351847113615"></a><a name="p107351847113615"></a>second</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p108021121103713"><a name="p108021121103713"></a><a name="p108021121103713"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p1173554743616"><a name="p1173554743616"></a><a name="p1173554743616"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p773574753611"><a name="p773574753611"></a><a name="p773574753611"></a>Second.</p>
</td>
</tr>
</tbody>
</table>
en/application-dev/reference/apis/js-apis-resource-manager.md
浏览文件 @ 5b59ac7a
# Resource Manager<a name="EN-US_TOPIC_0000001200042191"></a> # Resource Manager<a name="EN-US_TOPIC_0000001192428610"></a>
>![](../../public_sys-resources/icon-note.gif) **NOTE:** >![](../../public_sys-resources/icon-note.gif) **NOTE:**
>The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. >The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a> ## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
``` ```
...@@ -362,8 +362,6 @@ Enumerates screen density types. ...@@ -362,8 +362,6 @@ Enumerates screen density types.
Provides the device configuration. Provides the device configuration.
### Attributes<a name="section254242964810"></a>
<a name="table1459620431636"></a> <a name="table1459620431636"></a>
<table><thead align="left"><tr id="row25971143435"><th class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.1.6.1.1"><p id="p1559716434320"><a name="p1559716434320"></a><a name="p1559716434320"></a>Name</p> <table><thead align="left"><tr id="row25971143435"><th class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.1.6.1.1"><p id="p1559716434320"><a name="p1559716434320"></a><a name="p1559716434320"></a>Name</p>
</th> </th>
...@@ -406,8 +404,6 @@ Provides the device configuration. ...@@ -406,8 +404,6 @@ Provides the device configuration.
Provides the device capability. Provides the device capability.
### Attributes<a name="section2201153419440"></a>
<a name="table16201103444414"></a> <a name="table16201103444414"></a>
<table><thead align="left"><tr id="row620123444415"><th class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.1.6.1.1"><p id="p1620163494418"><a name="p1620163494418"></a><a name="p1620163494418"></a>Name</p> <table><thead align="left"><tr id="row620123444415"><th class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.1.6.1.1"><p id="p1620163494418"><a name="p1620163494418"></a><a name="p1620163494418"></a>Name</p>
</th> </th>
...@@ -450,6 +446,10 @@ Provides the device capability. ...@@ -450,6 +446,10 @@ Provides the device capability.
Provides the capability of accessing application resources. Provides the capability of accessing application resources.
>![](../public_sys-resources/icon-note.gif) **NOTE:**
>- The methods involved in **ResourceManager** are applicable only to the TypeScript-based declarative development paradigm.
>- Resource files are defined in the **resources** directory of the project. You can obtain the resource ID from **$r\(resource address\).id**, for example, **$r\(?app.string.test?\).id**.
### getString<a name="section9779153419548"></a> ### getString<a name="section9779153419548"></a>
getString\(resId: number, callback: AsyncCallback<string\>\): void getString\(resId: number, callback: AsyncCallback<string\>\): void
...@@ -494,7 +494,7 @@ Obtains the string corresponding to the specified resource ID. This method uses ...@@ -494,7 +494,7 @@ Obtains the string corresponding to the specified resource ID. This method uses
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getString(0x1000000, (error, value) => { mgr.getString($r('app.string.test').id, (error, value) => {
if (error != null) { if (error != null) {
console.log(value); console.log(value);
} else { } else {
...@@ -557,7 +557,7 @@ Obtains the string corresponding to the specified resource ID. This method uses ...@@ -557,7 +557,7 @@ Obtains the string corresponding to the specified resource ID. This method uses
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getString(0x1000000).then(value => { mgr.getString($r('app.string.test').id).then(value => {
console.log(value); console.log(value);
}).catch(error => { }).catch(error => {
console.log("getstring promise " + error); console.log("getstring promise " + error);
...@@ -610,7 +610,7 @@ Obtains the array of strings corresponding to the specified resource ID. This me ...@@ -610,7 +610,7 @@ Obtains the array of strings corresponding to the specified resource ID. This me
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray(0x1000000, (error, value) => { mgr.getStringArray($r('app.strarray.test').id, (error, value) => {
if (error != null) { if (error != null) {
console.log(value); console.log(value);
} else { } else {
...@@ -663,7 +663,7 @@ Obtains the array of strings corresponding to the specified resource ID. This me ...@@ -663,7 +663,7 @@ Obtains the array of strings corresponding to the specified resource ID. This me
</thead> </thead>
<tbody><tr id="row119261820145419"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p179309445393"><a name="p179309445393"></a><a name="p179309445393"></a>Promise&lt;Array&lt;string&gt;&gt;</p> <tbody><tr id="row119261820145419"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.1.3.1.1 "><p id="p179309445393"><a name="p179309445393"></a><a name="p179309445393"></a>Promise&lt;Array&lt;string&gt;&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p139301144153915"><a name="p139301144153915"></a><a name="p139301144153915"></a>Array of character strings corresponding to the specified resource ID.</p> <td class="cellrowborder" valign="top" width="79.95%" headers="mcps1.1.3.1.2 "><p id="p139301144153915"><a name="p139301144153915"></a><a name="p139301144153915"></a>Array of strings corresponding to the specified resource ID.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -673,7 +673,7 @@ Obtains the array of strings corresponding to the specified resource ID. This me ...@@ -673,7 +673,7 @@ Obtains the array of strings corresponding to the specified resource ID. This me
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray(0x1000000).then(value => { mgr.getStringArray($r('app.strarray.test').id).then(value => {
console.log(value); console.log(value);
}).catch(error => { }).catch(error => {
console.log("getstring promise " + error); console.log("getstring promise " + error);
...@@ -712,7 +712,7 @@ Obtains the content of the media file corresponding to the specified resource ID ...@@ -712,7 +712,7 @@ Obtains the content of the media file corresponding to the specified resource ID
</tr> </tr>
<tr id="row1971112524019"><td class="cellrowborder" valign="top" width="7.901402961808262%" headers="mcps1.1.5.1.1 "><p id="p27111125204017"><a name="p27111125204017"></a><a name="p27111125204017"></a>callback</p> <tr id="row1971112524019"><td class="cellrowborder" valign="top" width="7.901402961808262%" headers="mcps1.1.5.1.1 "><p id="p27111125204017"><a name="p27111125204017"></a><a name="p27111125204017"></a>callback</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25.565081839438818%" headers="mcps1.1.5.1.2 "><p id="p1371152514409"><a name="p1371152514409"></a><a name="p1371152514409"></a>AsyncCallback&lt;Array&lt;Uint8Array&gt;&gt;</p> <td class="cellrowborder" valign="top" width="25.565081839438818%" headers="mcps1.1.5.1.2 "><p id="p1371152514409"><a name="p1371152514409"></a><a name="p1371152514409"></a>AsyncCallback&lt;Uint8Array&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="6.819953234606392%" headers="mcps1.1.5.1.3 "><p id="p13711625124019"><a name="p13711625124019"></a><a name="p13711625124019"></a>Yes</p> <td class="cellrowborder" valign="top" width="6.819953234606392%" headers="mcps1.1.5.1.3 "><p id="p13711625124019"><a name="p13711625124019"></a><a name="p13711625124019"></a>Yes</p>
</td> </td>
...@@ -726,7 +726,7 @@ Obtains the content of the media file corresponding to the specified resource ID ...@@ -726,7 +726,7 @@ Obtains the content of the media file corresponding to the specified resource ID
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia(0x1000000, (error, value) => { mgr.getMedia($r('app.media.test').id, (error, value) => {
if (error != null) { if (error != null) {
console.log(value); console.log(value);
} else { } else {
...@@ -777,7 +777,7 @@ Obtains the content of the media file corresponding to the specified resource ID ...@@ -777,7 +777,7 @@ Obtains the content of the media file corresponding to the specified resource ID
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="row9713142554012"><td class="cellrowborder" valign="top" width="23.02%" headers="mcps1.1.3.1.1 "><p id="p1071352554019"><a name="p1071352554019"></a><a name="p1071352554019"></a>Promise&lt;Array&lt;Uint8Array&gt;&gt;</p> <tbody><tr id="row9713142554012"><td class="cellrowborder" valign="top" width="23.02%" headers="mcps1.1.3.1.1 "><p id="p1071352554019"><a name="p1071352554019"></a><a name="p1071352554019"></a>Promise&lt;Uint8Array&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="76.98%" headers="mcps1.1.3.1.2 "><p id="p8713192517405"><a name="p8713192517405"></a><a name="p8713192517405"></a>Promise used to return the content of the obtained media file.</p> <td class="cellrowborder" valign="top" width="76.98%" headers="mcps1.1.3.1.2 "><p id="p8713192517405"><a name="p8713192517405"></a><a name="p8713192517405"></a>Promise used to return the content of the obtained media file.</p>
</td> </td>
...@@ -789,7 +789,7 @@ Obtains the content of the media file corresponding to the specified resource ID ...@@ -789,7 +789,7 @@ Obtains the content of the media file corresponding to the specified resource ID
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia(0x1000000).then(value => { mgr.getMedia($r('app.media.test').id).then(value => {
console.log(value); console.log(value);
}).catch(error => { }).catch(error => {
console.log("getstring promise " + error); console.log("getstring promise " + error);
...@@ -842,7 +842,7 @@ Obtains the Base64 code of the image corresponding to the specified resource ID. ...@@ -842,7 +842,7 @@ Obtains the Base64 code of the image corresponding to the specified resource ID.
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64(0x1000000, (error, value) => { mgr.getMediaBase64($r('app.media.test').id, (error, value) => {
if (error != null) { if (error != null) {
console.log(value); console.log(value);
} else { } else {
...@@ -905,7 +905,7 @@ Obtains the Base64 code of the image corresponding to the specified resource ID. ...@@ -905,7 +905,7 @@ Obtains the Base64 code of the image corresponding to the specified resource ID.
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64(0x1000000).then(value => { mgr.getMediaBase64($r('app.media.test').id).then(value => {
console.log(value); console.log(value);
}).catch(error => { }).catch(error => {
console.log("getstring promise " + error); console.log("getstring promise " + error);
...@@ -1131,7 +1131,7 @@ Obtains the specified number of singular-plural strings corresponding to the spe ...@@ -1131,7 +1131,7 @@ Obtains the specified number of singular-plural strings corresponding to the spe
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString(0x1000000, 1, (error, value) => { mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => {
if (error != null) { if (error != null) {
console.log(value); console.log(value);
} else { } else {
...@@ -1203,7 +1203,7 @@ Obtains the specified number of singular-plural strings corresponding to the spe ...@@ -1203,7 +1203,7 @@ Obtains the specified number of singular-plural strings corresponding to the spe
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString(0x1000000, 1).then(value => { mgr.getPluralString($r("app.plural.test").id, 1).then(value => {
console.log(value); console.log(value);
}).catch(error => { }).catch(error => {
console.log("getstring promise " + error); console.log("getstring promise " + error);
...@@ -1212,3 +1212,118 @@ Obtains the specified number of singular-plural strings corresponding to the spe ...@@ -1212,3 +1212,118 @@ Obtains the specified number of singular-plural strings corresponding to the spe
``` ```
### getRawFile<sup>8+</sup><a name="section95073471466"></a>
getRawFile\(path: string, callback: AsyncCallback<Uint8Array\>\): void
Obtains the content of rawfile in the specified path. This method uses an asynchronous callback to return the result.
- Parameters
<a name="table15072471264"></a>
<table><thead align="left"><tr id="row1550784715616"><th class="cellrowborder" valign="top" width="7.901402961808262%" id="mcps1.1.5.1.1"><p id="p1650720473611"><a name="p1650720473611"></a><a name="p1650720473611"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="25.565081839438818%" id="mcps1.1.5.1.2"><p id="p1850710478614"><a name="p1850710478614"></a><a name="p1850710478614"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="6.819953234606392%" id="mcps1.1.5.1.3"><p id="p7508247962"><a name="p7508247962"></a><a name="p7508247962"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="59.713561964146535%" id="mcps1.1.5.1.4"><p id="p1250816471565"><a name="p1250816471565"></a><a name="p1250816471565"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row205084473617"><td class="cellrowborder" valign="top" width="7.901402961808262%" headers="mcps1.1.5.1.1 "><p id="p12508144716615"><a name="p12508144716615"></a><a name="p12508144716615"></a>path</p>
</td>
<td class="cellrowborder" valign="top" width="25.565081839438818%" headers="mcps1.1.5.1.2 "><p id="p45085471768"><a name="p45085471768"></a><a name="p45085471768"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.819953234606392%" headers="mcps1.1.5.1.3 "><p id="p1150834716613"><a name="p1150834716613"></a><a name="p1150834716613"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.713561964146535%" headers="mcps1.1.5.1.4 "><p id="p950814719617"><a name="p950814719617"></a><a name="p950814719617"></a>Path of the rawfile.</p>
</td>
</tr>
<tr id="row145082471163"><td class="cellrowborder" valign="top" width="7.901402961808262%" headers="mcps1.1.5.1.1 "><p id="p145081347867"><a name="p145081347867"></a><a name="p145081347867"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="25.565081839438818%" headers="mcps1.1.5.1.2 "><p id="p550814471615"><a name="p550814471615"></a><a name="p550814471615"></a>AsyncCallback&lt;Uint8Array&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="6.819953234606392%" headers="mcps1.1.5.1.3 "><p id="p1450884713612"><a name="p1450884713612"></a><a name="p1450884713612"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.713561964146535%" headers="mcps1.1.5.1.4 "><p id="p150864719611"><a name="p150864719611"></a><a name="p150864719611"></a> Asynchronous callback used to return the rawfile content, in byte arrays.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml", (error, value) => {
if (error != null) {
console.log(value);
} else {
console.log(value);
}
});
});
```
### getRawFile<sup>8+</sup><a name="section53115315102"></a>
getRawFile\(path: string\): Promise<Uint8Array\>
Obtains the content of the rawfile in the specified path. This method uses a promise to return the result.
- Parameters
<a name="table73111831141015"></a>
<table><thead align="left"><tr id="row1311143131013"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p1631163171011"><a name="p1631163171011"></a><a name="p1631163171011"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p431193191013"><a name="p431193191013"></a><a name="p431193191013"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p131114317106"><a name="p131114317106"></a><a name="p131114317106"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1531211312104"><a name="p1531211312104"></a><a name="p1531211312104"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1331263131011"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1531223111011"><a name="p1531223111011"></a><a name="p1531223111011"></a>path</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p173121931151016"><a name="p173121931151016"></a><a name="p173121931151016"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p12312173118102"><a name="p12312173118102"></a><a name="p12312173118102"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p13312163141013"><a name="p13312163141013"></a><a name="p13312163141013"></a>Path of the rawfile.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table6312113112103"></a>
<table><thead align="left"><tr id="row12312231101015"><th class="cellrowborder" valign="top" width="34.339999999999996%" id="mcps1.1.3.1.1"><p id="p19312173112109"><a name="p19312173112109"></a><a name="p19312173112109"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="65.66%" id="mcps1.1.3.1.2"><p id="p1431223161016"><a name="p1431223161016"></a><a name="p1431223161016"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row12312431151011"><td class="cellrowborder" valign="top" width="34.339999999999996%" headers="mcps1.1.3.1.1 "><p id="p14312113119102"><a name="p14312113119102"></a><a name="p14312113119102"></a>Promise&lt;Uint8Array&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="65.66%" headers="mcps1.1.3.1.2 "><p id="p43128317109"><a name="p43128317109"></a><a name="p43128317109"></a> Promise used to return the rawfile content, in byte arrays.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml").then(value => {
console.log(value);
}).catch(error => {
console.log("getrawfile promise " + error);
});
});
```
en/application-dev/reference/apis/js-apis-system-time.md
浏览文件 @ 5b59ac7a
...@@ -3,30 +3,6 @@ ...@@ -3,30 +3,6 @@
>![](../../public_sys-resources/icon-note.gif) **NOTE:** >![](../../public_sys-resources/icon-note.gif) **NOTE:**
>The APIs of this module are supported since API version 7. >The APIs of this module are supported since API version 7.
## Applicable Devices<a name="section16881239114912"></a>
<a name="table857714145377"></a>
<table><thead align="left"><tr id="row55778146373"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p7577141417376"><a name="p7577141417376"></a><a name="p7577141417376"></a>Phone</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p487719816463"><a name="p487719816463"></a><a name="p487719816463"></a>Tablet</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p135771614203720"><a name="p135771614203720"></a><a name="p135771614203720"></a>Smart TV</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p25772014133712"><a name="p25772014133712"></a><a name="p25772014133712"></a>Wearable</p>
</th>
</tr>
</thead>
<tbody><tr id="row8578151423715"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p65782014203718"><a name="p65782014203718"></a><a name="p65782014203718"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p148771182469"><a name="p148771182469"></a><a name="p148771182469"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p45783141377"><a name="p45783141377"></a><a name="p45783141377"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p11578161443718"><a name="p11578161443718"></a><a name="p11578161443718"></a>Yes</p>
</td>
</tr>
</tbody>
</table>
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a> ## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
......
en/application-dev/reference/apis/js-apis-uri.md 0 → 100644
浏览文件 @ 5b59ac7a
# URI String Parsing<a name="EN-US_TOPIC_0000001206361591"></a>
>![](../../public_sys-resources/icon-note.gif) **NOTE:**
>The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import<a name="section2080512344162"></a>
```
import uri from '@ohos.uri'
```
## Required Permissions<a name="section11257113618419"></a>
None
## URI<a name="section148871646203714"></a>
### Attributes<a name="section18482944113517"></a>
<a name="table20482104463514"></a>
<table><thead align="left"><tr id="row1348214444357"><th class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.1.6.1.1"><p id="p184822443351"><a name="p184822443351"></a><a name="p184822443351"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.86%" id="mcps1.1.6.1.2"><p id="p1648254415353"><a name="p1648254415353"></a><a name="p1648254415353"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.34%" id="mcps1.1.6.1.3"><p id="p9482124413355"><a name="p9482124413355"></a><a name="p9482124413355"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.51%" id="mcps1.1.6.1.4"><p id="p3482124493515"><a name="p3482124493515"></a><a name="p3482124493515"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.42%" id="mcps1.1.6.1.5"><p id="p12482104483513"><a name="p12482104483513"></a><a name="p12482104483513"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row148254473513"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1832319183511"><a name="p1832319183511"></a><a name="p1832319183511"></a>scheme</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p3482124417356"><a name="p3482124417356"></a><a name="p3482124417356"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p16483194443514"><a name="p16483194443514"></a><a name="p16483194443514"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p630714163422"><a name="p630714163422"></a><a name="p630714163422"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p72131224114411"><a name="p72131224114411"></a><a name="p72131224114411"></a>Protocol in the URI.</p>
</td>
</tr>
<tr id="row58631729183511"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1669917383355"><a name="p1669917383355"></a><a name="p1669917383355"></a>userinfo</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p986510296359"><a name="p986510296359"></a><a name="p986510296359"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p14865182993518"><a name="p14865182993518"></a><a name="p14865182993518"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1586552915355"><a name="p1586552915355"></a><a name="p1586552915355"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p12865829133514"><a name="p12865829133514"></a><a name="p12865829133514"></a>User information in the URI.</p>
</td>
</tr>
<tr id="row173737374371"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p73744376373"><a name="p73744376373"></a><a name="p73744376373"></a>host</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p183741337173714"><a name="p183741337173714"></a><a name="p183741337173714"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p13374237173711"><a name="p13374237173711"></a><a name="p13374237173711"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1737416372376"><a name="p1737416372376"></a><a name="p1737416372376"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p737414373372"><a name="p737414373372"></a><a name="p737414373372"></a>Host name (without the port number) in the URI.</p>
</td>
</tr>
<tr id="row18603545143715"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1360410454373"><a name="p1360410454373"></a><a name="p1360410454373"></a>port</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p1260410456378"><a name="p1260410456378"></a><a name="p1260410456378"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p146042453371"><a name="p146042453371"></a><a name="p146042453371"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p460416456374"><a name="p460416456374"></a><a name="p460416456374"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p3153171613242"><a name="p3153171613242"></a><a name="p3153171613242"></a>Port number in the URI.</p>
</td>
</tr>
<tr id="row15118124793712"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p9121914204110"><a name="p9121914204110"></a><a name="p9121914204110"></a>path</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p41181471376"><a name="p41181471376"></a><a name="p41181471376"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p10118447153719"><a name="p10118447153719"></a><a name="p10118447153719"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1111884793714"><a name="p1111884793714"></a><a name="p1111884793714"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p18565132916244"><a name="p18565132916244"></a><a name="p18565132916244"></a>Path in the URI.</p>
</td>
</tr>
<tr id="row2998164312378"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p20998643103713"><a name="p20998643103713"></a><a name="p20998643103713"></a>query</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p1899804315372"><a name="p1899804315372"></a><a name="p1899804315372"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p1399820431377"><a name="p1399820431377"></a><a name="p1399820431377"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p29980434371"><a name="p29980434371"></a><a name="p29980434371"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p1299814373714"><a name="p1299814373714"></a><a name="p1299814373714"></a>Query part in the URI.</p>
</td>
</tr>
<tr id="row6527542193711"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1852784212370"><a name="p1852784212370"></a><a name="p1852784212370"></a>fragment</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p205271742183711"><a name="p205271742183711"></a><a name="p205271742183711"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p952724233717"><a name="p952724233717"></a><a name="p952724233717"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1452784214373"><a name="p1452784214373"></a><a name="p1452784214373"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p18527842143718"><a name="p18527842143718"></a><a name="p18527842143718"></a>Fragment part in the URI.</p>
</td>
</tr>
<tr id="row1221604019378"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p12161040193711"><a name="p12161040193711"></a><a name="p12161040193711"></a>authority</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p12161040103714"><a name="p12161040103714"></a><a name="p12161040103714"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p621674073715"><a name="p621674073715"></a><a name="p621674073715"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1821624033711"><a name="p1821624033711"></a><a name="p1821624033711"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p1421614403377"><a name="p1421614403377"></a><a name="p1421614403377"></a>Authority part in the URI.</p>
</td>
</tr>
<tr id="row763211357376"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p1863313520378"><a name="p1863313520378"></a><a name="p1863313520378"></a>ssp</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p8633113583715"><a name="p8633113583715"></a><a name="p8633113583715"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p1663363533710"><a name="p1663363533710"></a><a name="p1663363533710"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1763312358374"><a name="p1763312358374"></a><a name="p1763312358374"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p363383518374"><a name="p363383518374"></a><a name="p363383518374"></a>Scheme-specific part in the URI.</p>
</td>
</tr>
</tbody>
</table>
### constructor<a name="section796748155213"></a>
constructor\(uri: string\)
A constructor used to create a URI instance.
- Parameters
<a name="table1723015271384"></a>
<table><thead align="left"><tr id="row42301327153814"><th class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.1.6.1.1"><p id="p102307272383"><a name="p102307272383"></a><a name="p102307272383"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10.86%" id="mcps1.1.6.1.2"><p id="p202307278382"><a name="p202307278382"></a><a name="p202307278382"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.34%" id="mcps1.1.6.1.3"><p id="p19231227113813"><a name="p19231227113813"></a><a name="p19231227113813"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="11.51%" id="mcps1.1.6.1.4"><p id="p1123113278381"><a name="p1123113278381"></a><a name="p1123113278381"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="52.42%" id="mcps1.1.6.1.5"><p id="p5231172773815"><a name="p5231172773815"></a><a name="p5231172773815"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row122318279387"><td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.1.6.1.1 "><p id="p161271253807"><a name="p161271253807"></a><a name="p161271253807"></a>url</p>
</td>
<td class="cellrowborder" valign="top" width="10.86%" headers="mcps1.1.6.1.2 "><p id="p11231102719382"><a name="p11231102719382"></a><a name="p11231102719382"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.34%" headers="mcps1.1.6.1.3 "><p id="p182311827173812"><a name="p182311827173812"></a><a name="p182311827173812"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.51%" headers="mcps1.1.6.1.4 "><p id="p1023152712389"><a name="p1023152712389"></a><a name="p1023152712389"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.42%" headers="mcps1.1.6.1.5 "><p id="p323132783819"><a name="p323132783819"></a><a name="p323132783819"></a>Input parameter object.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var mm = 'http://username:password@host:8080/directory/file?foo=1&bar=2#fragment';
new uri.URI(mm); // Output 'http://username:password@host:8080/directory/file?foo=1&bar=2#fragment';
```
```
new uri.URI('http://username:password@host:8080'); // Output 'http://username:password@host:8080';
```
### toString<a name="section1520812025513"></a>
toString\(\): string
Obtains the query string applicable to this URL.
- Return values
<a name="table201041412244"></a>
<table><thead align="left"><tr id="row410431122411"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p110413182418"><a name="p110413182418"></a><a name="p110413182418"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p181042116249"><a name="p181042116249"></a><a name="p181042116249"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row110421182413"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p510461102411"><a name="p510461102411"></a><a name="p510461102411"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p159992542327"><a name="p159992542327"></a><a name="p159992542327"></a>Website address in a serialized string.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
const url = new uri.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
url.toString()
```
### equals<a name="section8201184114551"></a>
equals\(other: URI\): boolean
Checks whether this URI is the same as another URI object.
- Parameters
<a name="table69661135912"></a>
<table><thead align="left"><tr id="row149668318915"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p7966738914"><a name="p7966738914"></a><a name="p7966738914"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p296713699"><a name="p296713699"></a><a name="p296713699"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p196718315911"><a name="p196718315911"></a><a name="p196718315911"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p9967231197"><a name="p9967231197"></a><a name="p9967231197"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row99671533914"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p79671633910"><a name="p79671633910"></a><a name="p79671633910"></a>other</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p780818507106"><a name="p780818507106"></a><a name="p780818507106"></a><a href="#section148871646203714">URI</a></p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p19671336916"><a name="p19671336916"></a><a name="p19671336916"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p69671631796"><a name="p69671631796"></a><a name="p69671631796"></a>URI object to compare.</p>
</td>
</tr>
</tbody>
</table>
- Return values
<a name="table648816575178"></a>
<table><thead align="left"><tr id="row54897577177"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p548916576172"><a name="p548916576172"></a><a name="p548916576172"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p748995711718"><a name="p748995711718"></a><a name="p748995711718"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row448917570178"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p848910579172"><a name="p848910579172"></a><a name="p848910579172"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p18489257161712"><a name="p18489257161712"></a><a name="p18489257161712"></a>Returns <strong id="b137321971865"><a name="b137321971865"></a><a name="b137321971865"></a>true</strong> if the two URIs are the same; returns <strong id="b1160661310617"><a name="b1160661310617"></a><a name="b1160661310617"></a>false</strong> otherwise.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
const uriInstance = new uri.URI('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
const uriInstance1 = new uri.URI('http://username:password@host:8080/directory/file?query=pppppp#qwer=da#fragment');
uriInstance.equals(uriInstance1);
```
### checkIsAbsolute<a name="section17961333135611"></a>
checkIsAbsolute\(\): boolean
Checks whether this URI is an absolute URI \(whether the scheme component is defined\).
- Return values
<a name="table10605130142117"></a>
<table><thead align="left"><tr id="row156051502216"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p1260640112112"><a name="p1260640112112"></a><a name="p1260640112112"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p136062012215"><a name="p136062012215"></a><a name="p136062012215"></a><strong id="b33155560324644"><a name="b33155560324644"></a><a name="b33155560324644"></a>Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="row176062022120"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p19606140142119"><a name="p19606140142119"></a><a name="p19606140142119"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p2060690182114"><a name="p2060690182114"></a><a name="p2060690182114"></a>Returns <strong id="b1461184214711"><a name="b1461184214711"></a><a name="b1461184214711"></a>true</strong> if the URI is an absolute URI; returns <strong id="b13725458815"><a name="b13725458815"></a><a name="b13725458815"></a>false</strong> otherwise.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
const uriInstance = new uri.URI('http://username:password@www.qwer.com:8080?query=pppppp');
uriInstance.checkIsAbsolute();
```
### normalize<a name="section974214585573"></a>
normalize\(\): URI
Normalizes the path of this URI.
- Return values
<a name="table981932613263"></a>
<table><thead align="left"><tr id="row38194264264"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p178208263269"><a name="p178208263269"></a><a name="p178208263269"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p15820112672617"><a name="p15820112672617"></a><a name="p15820112672617"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row2820172622610"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p13820122613264"><a name="p13820122613264"></a><a name="p13820122613264"></a>URI</p>
</td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p18497141212339"><a name="p18497141212339"></a><a name="p18497141212339"></a>URI with the normalized path.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
const uriInstance = new uri.URI('http://username:password@www.qwer.com:8080/path/path1/../path2/./path3?query=pppppp');
let uriInstance1 = uriInstance.normalize();
uriInstance1.path;
```
en/application-dev/reference/apis/js-apis-useriam-userauth.md
浏览文件 @ 5b59ac7a
...@@ -3,30 +3,6 @@ ...@@ -3,30 +3,6 @@
>**NOTE:** >**NOTE:**
>The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. >The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Applicable Devices<a name="section16881239114912"></a>
<a name="table857714145377"></a>
<table><thead align="left"><tr id="row55778146373"><th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.1"><p id="p7577141417376"><a name="p7577141417376"></a><a name="p7577141417376"></a>Phone</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.2"><p id="p487719816463"><a name="p487719816463"></a><a name="p487719816463"></a>Tablet</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.3"><p id="p135771614203720"><a name="p135771614203720"></a><a name="p135771614203720"></a>Smart TV</p>
</th>
<th class="cellrowborder" valign="top" width="25%" id="mcps1.1.5.1.4"><p id="p25772014133712"><a name="p25772014133712"></a><a name="p25772014133712"></a>Wearable</p>
</th>
</tr>
</thead>
<tbody><tr id="row8578151423715"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.1 "><p id="p65782014203718"><a name="p65782014203718"></a><a name="p65782014203718"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.2 "><p id="p148771182469"><a name="p148771182469"></a><a name="p148771182469"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.3 "><p id="p45783141377"><a name="p45783141377"></a><a name="p45783141377"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.1.5.1.4 "><p id="p11578161443718"><a name="p11578161443718"></a><a name="p11578161443718"></a>No</p>
</td>
</tr>
</tbody>
</table>
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a> ## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
......
en/application-dev/reference/apis/js-apis-worker.md
浏览文件 @ 5b59ac7a
# Worker Startup<a name="EN-US_TOPIC_0000001172830331"></a> # Worker Startup<a name="EN-US_TOPIC_0000001172830331"></a>
>![](../../public_sys-resources/icon-note.gif) **NOTE:** >**NOTE:**
>The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. >The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a> ## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
...@@ -131,13 +131,13 @@ A constructor used to create a worker instance. ...@@ -131,13 +131,13 @@ A constructor used to create a worker instance.
- Return values - Return values
<a name="table362855181117"></a> <a name="table362855181117"></a>
<table><thead align="left"><tr id="row1462255191114"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p1621355121115"><a name="p1621355121115"></a><a name="p1621355121115"></a>Name</p> <table><thead align="left"><tr id="row1462255191114"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p1621355121115"><a name="p1621355121115"></a><a name="p1621355121115"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p16295571119"><a name="p16295571119"></a><a name="p16295571119"></a>Description</p> <th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p16295571119"><a name="p16295571119"></a><a name="p16295571119"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="row116275516110"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p76295515112"><a name="p76295515112"></a><a name="p76295515112"></a>worker</p> <tbody><tr id="row116275516110"><td class="cellrowborder" valign="top" width="20.990000000000002%" headers="mcps1.1.3.1.1 "><p id="p76295515112"><a name="p76295515112"></a><a name="p76295515112"></a>Worker</p>
</td> </td>
<td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p362195531112"><a name="p362195531112"></a><a name="p362195531112"></a>Returns the worker instance created; returns <strong id="b49535319421"><a name="b49535319421"></a><a name="b49535319421"></a>undefined</strong> if the worker instance fails to be created.</p> <td class="cellrowborder" valign="top" width="79.01%" headers="mcps1.1.3.1.2 "><p id="p362195531112"><a name="p362195531112"></a><a name="p362195531112"></a>Returns the worker instance created; returns <strong id="b49535319421"><a name="b49535319421"></a><a name="b49535319421"></a>undefined</strong> if the worker instance fails to be created.</p>
</td> </td>
...@@ -148,8 +148,7 @@ A constructor used to create a worker instance. ...@@ -148,8 +148,7 @@ A constructor used to create a worker instance.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js", {name:"first worker"});
const worker = new worker.Worker("workers/worker.js", {name:"first worker"});
``` ```
...@@ -196,13 +195,14 @@ Sends a message to the worker thread. The data is transferred using the structur ...@@ -196,13 +195,14 @@ Sends a message to the worker thread. The data is transferred using the structur
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js");
const worker = new worker.Worker("workers/worker.js"); workerInstance.postMessage("hello world");
worker.postMessage("hello world"); ```
const worker = new worker.Worker("workers/worker.js"); ```
const workerInstance = new worker.Worker("workers/worker.js");
var buffer = new ArrayBuffer(8); var buffer = new ArrayBuffer(8);
worker.postMessage(buffer, [buffer]); workerInstance.postMessage(buffer, [buffer]);
``` ```
...@@ -249,9 +249,8 @@ Adds an event listener to the worker. ...@@ -249,9 +249,8 @@ Adds an event listener to the worker.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.on("alert", (e)=>{
worker.on("alert", (e)=>{
console.log("alert listener callback"); console.log("alert listener callback");
}) })
``` ```
...@@ -300,9 +299,8 @@ Adds an event listener to the worker and removes the event listener automaticall ...@@ -300,9 +299,8 @@ Adds an event listener to the worker and removes the event listener automaticall
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js");
const worker = new worker.Worker("workers/worker.js"); workerInstance.once("alert", (e)=>{
worker.once("alert", (e)=>{
console.log("alert listener callback"); console.log("alert listener callback");
}) })
``` ```
...@@ -351,9 +349,8 @@ Removes an event listener for the worker. ...@@ -351,9 +349,8 @@ Removes an event listener for the worker.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js");
const worker = new worker.Worker("workers/worker.js"); workerInstance.off("alert");
worker.off("alert");
``` ```
...@@ -366,9 +363,8 @@ Terminates the worker thread to stop the worker from receiving messages. ...@@ -366,9 +363,8 @@ Terminates the worker thread to stop the worker from receiving messages.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.terminate()
worker.terminate()
``` ```
...@@ -406,9 +402,8 @@ Defines the event handler to be called when the worker exits. The handler is exe ...@@ -406,9 +402,8 @@ Defines the event handler to be called when the worker exits. The handler is exe
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.onexit = function(e) {
worker.onexit = function(e) {
console.log("onexit") console.log("onexit")
} }
``` ```
...@@ -448,9 +443,8 @@ Defines the event handler to be called when an exception occurs during worker ex ...@@ -448,9 +443,8 @@ Defines the event handler to be called when an exception occurs during worker ex
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.onerror = function(e) {
worker.onerror = function(e) {
console.log("onerror") console.log("onerror")
} }
``` ```
...@@ -490,9 +484,8 @@ Defines the event handler to be called when the host thread receives a message c ...@@ -490,9 +484,8 @@ Defines the event handler to be called when the host thread receives a message c
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.onmessage = function(e) {
worker.onmessage = function(e) {
console.log("onerror") console.log("onerror")
} }
``` ```
...@@ -532,9 +525,8 @@ Defines the event handler to be called when the worker receives a message that c ...@@ -532,9 +525,8 @@ Defines the event handler to be called when the worker receives a message that c
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.onmessageerror= function(e) {
worker.onmessageerror= function(e) {
console.log("onmessageerror") console.log("onmessageerror")
} }
``` ```
...@@ -585,9 +577,8 @@ Adds an event listener to the worker. ...@@ -585,9 +577,8 @@ Adds an event listener to the worker.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.addEventListener("alert", (e)=>{
worker.addEventListener("alert", (e)=>{
console.log("alert listener callback"); console.log("alert listener callback");
}) })
``` ```
...@@ -636,9 +627,8 @@ Removes an event listener for the worker. ...@@ -636,9 +627,8 @@ Removes an event listener for the worker.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.removeEventListener("alert")
worker.removeEventListener("alert")
``` ```
...@@ -676,7 +666,7 @@ Dispatches the event defined for the worker. ...@@ -676,7 +666,7 @@ Dispatches the event defined for the worker.
- Return values - Return values
<a name="table4536208105515"></a> <a name="table4536208105515"></a>
<table><thead align="left"><tr id="row25360810551"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p2536685552"><a name="p2536685552"></a><a name="p2536685552"></a>Name</p> <table><thead align="left"><tr id="row25360810551"><th class="cellrowborder" valign="top" width="20.990000000000002%" id="mcps1.1.3.1.1"><p id="p2536685552"><a name="p2536685552"></a><a name="p2536685552"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p185371287554"><a name="p185371287554"></a><a name="p185371287554"></a>Description</p> <th class="cellrowborder" valign="top" width="79.01%" id="mcps1.1.3.1.2"><p id="p185371287554"><a name="p185371287554"></a><a name="p185371287554"></a>Description</p>
</th> </th>
...@@ -693,9 +683,8 @@ Dispatches the event defined for the worker. ...@@ -693,9 +683,8 @@ Dispatches the event defined for the worker.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.dispatchEvent({type:"alert"})
worker.dispatchEvent({type:"alert"})
``` ```
...@@ -708,9 +697,8 @@ Removes all event listeners for the worker. ...@@ -708,9 +697,8 @@ Removes all event listeners for the worker.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js")
const worker = new worker.Worker("workers/worker.js") workerInstance.removeAllListener({type:"alert"})
worker.removeAllListener({type:"alert"})
``` ```
...@@ -762,13 +750,15 @@ Sends a message to the host thread from the worker. ...@@ -762,13 +750,15 @@ Sends a message to the host thread from the worker.
``` ```
// main.js // main.js
import worker from '@ohos.worker'; import worker from "@ohos.worker";
const worker = new worker.Worker("workers/worker.js") const workerInstance = new worker.Worker("workers/worker.js")
worker.postMessage("hello world") workerInstance.postMessage("hello world")
worker.onmessage = function(e) { workerInstance.onmessage = function(e) {
console.log("receive data from worker.js") console.log("receive data from worker.js")
} }
```
```
// worker.js // worker.js
import worker from "@ohos.worker"; import worker from "@ohos.worker";
const parentPort = worker.parentPort; const parentPort = worker.parentPort;
...@@ -789,8 +779,10 @@ Closes the worker thread to stop the worker from receiving messages. ...@@ -789,8 +779,10 @@ Closes the worker thread to stop the worker from receiving messages.
``` ```
// main.js // main.js
import worker from '@ohos.worker'; import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js") const workerInstance = new worker.Worker("workers/worker.js")
```
```
// worker.js // worker.js
import worker from "@ohos.worker"; import worker from "@ohos.worker";
const parentPort = worker.parentPort; const parentPort = worker.parentPort;
...@@ -836,9 +828,11 @@ Defines the event handler to be called when the worker thread receives a message ...@@ -836,9 +828,11 @@ Defines the event handler to be called when the worker thread receives a message
``` ```
// main.js // main.js
import worker from '@ohos.worker'; import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js") const workerInstance = new worker.Worker("workers/worker.js")
worker.postMessage("hello world") workerInstance.postMessage("hello world")
```
```
// worker.js // worker.js
import worker from "@ohos.worker"; import worker from "@ohos.worker";
const parentPort = worker.parentPort; const parentPort = worker.parentPort;
...@@ -884,8 +878,10 @@ Defines the event handler to be called when the worker receives a message that c ...@@ -884,8 +878,10 @@ Defines the event handler to be called when the worker receives a message that c
``` ```
// main.js // main.js
import worker from '@ohos.worker'; import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js") const workerInstance = new worker.Worker("workers/worker.js")
```
```
// worker.js // worker.js
import worker from "@ohos.worker"; import worker from "@ohos.worker";
const parentPort = worker.parentPort; const parentPort = worker.parentPort;
...@@ -1004,7 +1000,7 @@ Specifies the callback to invoke. ...@@ -1004,7 +1000,7 @@ Specifies the callback to invoke.
- Return values - Return values
<a name="t3e93239d9b134b80957bcdd4acb05291"></a> <a name="t3e93239d9b134b80957bcdd4acb05291"></a>
<table><thead align="left"><tr id="recc81d9f995d44aa87ba9d714b756569"><th class="cellrowborder" valign="top" width="21.84%" id="mcps1.1.3.1.1"><p id="aa3137ce511d140fba6cc93513a7a91e3"><a name="aa3137ce511d140fba6cc93513a7a91e3"></a><a name="aa3137ce511d140fba6cc93513a7a91e3"></a>Name</p> <table><thead align="left"><tr id="recc81d9f995d44aa87ba9d714b756569"><th class="cellrowborder" valign="top" width="21.84%" id="mcps1.1.3.1.1"><p id="aa3137ce511d140fba6cc93513a7a91e3"><a name="aa3137ce511d140fba6cc93513a7a91e3"></a><a name="aa3137ce511d140fba6cc93513a7a91e3"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="78.16%" id="mcps1.1.3.1.2"><p id="a4ba8ead9ee7b48298d9a6ed10659f13b"><a name="a4ba8ead9ee7b48298d9a6ed10659f13b"></a><a name="a4ba8ead9ee7b48298d9a6ed10659f13b"></a>Description</p> <th class="cellrowborder" valign="top" width="78.16%" id="mcps1.1.3.1.2"><p id="a4ba8ead9ee7b48298d9a6ed10659f13b"><a name="a4ba8ead9ee7b48298d9a6ed10659f13b"></a><a name="a4ba8ead9ee7b48298d9a6ed10659f13b"></a>Description</p>
</th> </th>
...@@ -1021,9 +1017,8 @@ Specifies the callback to invoke. ...@@ -1021,9 +1017,8 @@ Specifies the callback to invoke.
- Example - Example
``` ```
import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js");
const worker = new worker.Worker("workers/worker.js"); workerInstance.addEventListener("alert", (e)=>{
worker.addEventListener("alert", (e)=>{
console.log("alert listener callback"); console.log("alert listener callback");
}) })
``` ```
...@@ -1215,8 +1210,10 @@ Defines the event handler to be called when an exception occurs during worker ex ...@@ -1215,8 +1210,10 @@ Defines the event handler to be called when an exception occurs during worker ex
``` ```
// main.js // main.js
import worker from '@ohos.worker'; import worker from '@ohos.worker';
const worker = new worker.Worker("workers/worker.js") const workerInstance = new worker.Worker("workers/worker.js")
```
```
// worker.js // worker.js
import worker from "@ohos.worker"; import worker from "@ohos.worker";
const parentPort = worker.parentPort const parentPort = worker.parentPort
......
en/application-dev/reference/apis/js-apis-xml.md 0 → 100644
浏览文件 @ 5b59ac7a
# XML Parsing and Generation<a name="EN-US_TOPIC_0000001166576450"></a>
>![](../../public_sys-resources/icon-note.gif) **NOTE:**
>The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
```
import xml from '@ohos.xml';
```
## Required Permissions<a name="section11257113618419"></a>
None
## XmlSerializer<a name="section10300157155214"></a>
### constructor<a name="section22631719185510"></a>
constructor\(buffer: ArrayBuffer | DataView, encoding?: string\)
A constructor used to create an **XmlSerializer** instance.
- Parameters
<a name="table371837193011"></a>
<table><thead align="left"><tr id="row672173723013"><th class="cellrowborder" valign="top" width="10.05%" id="mcps1.1.5.1.1"><p id="p1272203710304"><a name="p1272203710304"></a><a name="p1272203710304"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="20.8%" id="mcps1.1.5.1.2"><p id="p1172103715308"><a name="p1172103715308"></a><a name="p1172103715308"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.86%" id="mcps1.1.5.1.3"><p id="p2072537153017"><a name="p2072537153017"></a><a name="p2072537153017"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1572193715303"><a name="p1572193715303"></a><a name="p1572193715303"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row673153793010"><td class="cellrowborder" valign="top" width="10.05%" headers="mcps1.1.5.1.1 "><p id="p197373763013"><a name="p197373763013"></a><a name="p197373763013"></a>buffer</p>
</td>
<td class="cellrowborder" valign="top" width="20.8%" headers="mcps1.1.5.1.2 "><p id="p1773337193020"><a name="p1773337193020"></a><a name="p1773337193020"></a>ArrayBuffer | DataView</p>
</td>
<td class="cellrowborder" valign="top" width="7.86%" headers="mcps1.1.5.1.3 "><p id="p27313376302"><a name="p27313376302"></a><a name="p27313376302"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p19731837133019"><a name="p19731837133019"></a><a name="p19731837133019"></a><strong id="b176576351735"><a name="b176576351735"></a><a name="b176576351735"></a>ArrayBuffer</strong> or <strong id="b14983539439"><a name="b14983539439"></a><a name="b14983539439"></a>DataView</strong> for storing the XML information to write.</p>
</td>
</tr>
<tr id="row873937133017"><td class="cellrowborder" valign="top" width="10.05%" headers="mcps1.1.5.1.1 "><p id="p573837113014"><a name="p573837113014"></a><a name="p573837113014"></a>encoding</p>
</td>
<td class="cellrowborder" valign="top" width="20.8%" headers="mcps1.1.5.1.2 "><p id="p1473837163016"><a name="p1473837163016"></a><a name="p1473837163016"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="7.86%" headers="mcps1.1.5.1.3 "><p id="p1574153711306"><a name="p1574153711306"></a><a name="p1574153711306"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p107416372308"><a name="p107416372308"></a><a name="p107416372308"></a>Encoding format.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var arrayBuffer = new ArrayBuffer(1024);
var bufView = new DataView(arrayBuffer);
var thatSer = new xml.XmlSerializer(bufView);
```
### setAttributes<a name="section2473132013521"></a>
setAttributes\(name: string, value: string\): void
Sets an attribute.
- Parameters
<a name="table89671419586"></a>
<table><thead align="left"><tr id="row1296813405817"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p9968649587"><a name="p9968649587"></a><a name="p9968649587"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p896816415583"><a name="p896816415583"></a><a name="p896816415583"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p19684475811"><a name="p19684475811"></a><a name="p19684475811"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p15969124195818"><a name="p15969124195818"></a><a name="p15969124195818"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1096919414582"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p19764172525816"><a name="p19764172525816"></a><a name="p19764172525816"></a>name</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p209702418584"><a name="p209702418584"></a><a name="p209702418584"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p20970240582"><a name="p20970240582"></a><a name="p20970240582"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p5218548142218"><a name="p5218548142218"></a><a name="p5218548142218"></a>Key of the attribute.</p>
</td>
</tr>
<tr id="row14970184165815"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p1996411319585"><a name="p1996411319585"></a><a name="p1996411319585"></a>value</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p7961171375814"><a name="p7961171375814"></a><a name="p7961171375814"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p1995771345820"><a name="p1995771345820"></a><a name="p1995771345820"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p19532013165816"><a name="p19532013165816"></a><a name="p19532013165816"></a>Value of the attribute.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setAttributes("importance", "high");
```
### addEmptyElement<a name="section66211195611"></a>
addEmptyElement\(name: string\): void
Adds an empty element.
- Parameters
<a name="table14404194817135"></a>
<table><thead align="left"><tr id="row14051748131319"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p1440574821316"><a name="p1440574821316"></a><a name="p1440574821316"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p204051548111311"><a name="p204051548111311"></a><a name="p204051548111311"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p34056481132"><a name="p34056481132"></a><a name="p34056481132"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p5405548161318"><a name="p5405548161318"></a><a name="p5405548161318"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row14063484130"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p13406348101319"><a name="p13406348101319"></a><a name="p13406348101319"></a>name</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p340613481134"><a name="p340613481134"></a><a name="p340613481134"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p14062486135"><a name="p14062486135"></a><a name="p14062486135"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p2406248191315"><a name="p2406248191315"></a><a name="p2406248191315"></a>Name of the empty element to add.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var thatSer = new xml.XmlSerializer(bufView);
thatSer.addEmptyElement("b"); // => <b/>
```
### setDeclaration<a name="section86274211981"></a>
setDeclaration\(\): void
Sets a declaration.
- Example
```
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setDeclaration() // => <?xml version="1.0" encoding="utf-8"?>;
```
### startElement<a name="section7242102181610"></a>
startElement\(name: string\): void
Writes the start tag based on the given element name.
- Parameters
<a name="table181414461248"></a>
<table><thead align="left"><tr id="row714104612417"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p8141546112417"><a name="p8141546112417"></a><a name="p8141546112417"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p14151546172412"><a name="p14151546172412"></a><a name="p14151546172412"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p1615114619244"><a name="p1615114619244"></a><a name="p1615114619244"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p121514469247"><a name="p121514469247"></a><a name="p121514469247"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1615204662414"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p415114614249"><a name="p415114614249"></a><a name="p415114614249"></a>name</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p6151246192420"><a name="p6151246192420"></a><a name="p6151246192420"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p71574612247"><a name="p71574612247"></a><a name="p71574612247"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p415946132417"><a name="p415946132417"></a><a name="p415946132417"></a>Name of the element.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("notel");
thatSer.endElement();// => '<notel/>';
```
### endElement<a name="section357918382815"></a>
endElement\(\): void
Writes the end tag of the element.
- Example
```
var thatSer = new xml.XmlSerializer(bufView);
thatSer.setNamespace("h", "http://www.w3.org/TR/html4/");
thatSer.startElement("table");
thatSer.setAttributes("importance", "high");
thatSer.setText("Happy");
endElement(); // => <h:table importance="high" xmlns:h="http://www.w3.org/TR/html4/">Happy</h:table>
```
### setNamespace<a name="section04112422818"></a>
setNamespace\(prefix: string, namespace: string\): void
Sets the namespace for an element tag.
- Parameters
<a name="table8646118202914"></a>
<table><thead align="left"><tr id="row18646131812296"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p19646118172919"><a name="p19646118172919"></a><a name="p19646118172919"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p364731813291"><a name="p364731813291"></a><a name="p364731813291"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p06473184299"><a name="p06473184299"></a><a name="p06473184299"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p66471618172920"><a name="p66471618172920"></a><a name="p66471618172920"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1564701813298"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p7647101892919"><a name="p7647101892919"></a><a name="p7647101892919"></a>prefix</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p064761822918"><a name="p064761822918"></a><a name="p064761822918"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p36471718162912"><a name="p36471718162912"></a><a name="p36471718162912"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1564731811292"><a name="p1564731811292"></a><a name="p1564731811292"></a>Prefix of the element and its child elements.</p>
</td>
</tr>
<tr id="row5285142452918"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p112861824192919"><a name="p112861824192919"></a><a name="p112861824192919"></a>namespace</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1728692413299"><a name="p1728692413299"></a><a name="p1728692413299"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p14994496295"><a name="p14994496295"></a><a name="p14994496295"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1428714245297"><a name="p1428714245297"></a><a name="p1428714245297"></a>Namespace to set.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setDeclaration();
thatSer.setNamespace("h", "http://www.w3.org/TR/html4/");
thatSer.startElement("note");
thatSer.endElement();// = >'<?xml version="1.0" encoding="utf-8"?>\r\n<h:note xmlns:h="http://www.w3.org/TR/html4/"/>';
```
### setComment<a name="section1174418441186"></a>
setComment\(text: string\): void
Sets the comment.
- Parameters
<a name="table59902223516"></a>
<table><thead align="left"><tr id="row1699117253518"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p09911122354"><a name="p09911122354"></a><a name="p09911122354"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p209911128359"><a name="p209911128359"></a><a name="p209911128359"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p1899119203517"><a name="p1899119203517"></a><a name="p1899119203517"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p19991725355"><a name="p19991725355"></a><a name="p19991725355"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row59921026357"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p2099232153520"><a name="p2099232153520"></a><a name="p2099232153520"></a>text</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1992729353"><a name="p1992729353"></a><a name="p1992729353"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p9992182173517"><a name="p9992182173517"></a><a name="p9992182173517"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1399210223514"><a name="p1399210223514"></a><a name="p1399210223514"></a>Comment to set.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
thatSer.setComment("Hi!");
thatSer.endElement(); // => '<note>\r\n <!--Hi!-->\r\n</note>';
```
### setCDATA<a name="section812915481985"></a>
setCDATA\(text: string\): void
Sets CDATA attributes.
- Parameters
<a name="table374175311366"></a>
<table><thead align="left"><tr id="row475175323615"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p1775553183620"><a name="p1775553183620"></a><a name="p1775553183620"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p2075053103617"><a name="p2075053103617"></a><a name="p2075053103617"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p67565310368"><a name="p67565310368"></a><a name="p67565310368"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1575153143612"><a name="p1575153143612"></a><a name="p1575153143612"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row17525323615"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p47575316364"><a name="p47575316364"></a><a name="p47575316364"></a>text</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p2076105323611"><a name="p2076105323611"></a><a name="p2076105323611"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p1776653183610"><a name="p1776653183610"></a><a name="p1776653183610"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p276135313620"><a name="p276135313620"></a><a name="p276135313620"></a>CDATA attribute to set.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var arrayBuffer = new ArrayBuffer(1028);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setCDATA('root SYSTEM') // => '<![CDATA[root SYSTEM]]>';
```
### setText<a name="section265019491814"></a>
setText\(text: string\): void
Sets **Text**.
- Parameters
<a name="table136227583373"></a>
<table><thead align="left"><tr id="row1662355863713"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p86235584376"><a name="p86235584376"></a><a name="p86235584376"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p106231958103718"><a name="p106231958103718"></a><a name="p106231958103718"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p3624458193719"><a name="p3624458193719"></a><a name="p3624458193719"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1762425863715"><a name="p1762425863715"></a><a name="p1762425863715"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row762405815376"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p062475843712"><a name="p062475843712"></a><a name="p062475843712"></a>text</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1362412588379"><a name="p1362412588379"></a><a name="p1362412588379"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p1062435814373"><a name="p1062435814373"></a><a name="p1062435814373"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p17625105833713"><a name="p17625105833713"></a><a name="p17625105833713"></a>Content of the <strong id="b47250195582"><a name="b47250195582"></a><a name="b47250195582"></a>Text</strong> to set.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.startElement("note");
thatSer.setAttributes("importance", "high");
thatSer.setText("Happy1");
thatSer.endElement(); // => '<note importance="high">Happy1</note>';
```
### setDocType<a name="section104216510819"></a>
setDocType\(text: string\): void
Sets **DocType**.
- Parameters
<a name="table144314794016"></a>
<table><thead align="left"><tr id="row1443167184014"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p174437734018"><a name="p174437734018"></a><a name="p174437734018"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.719999999999999%" id="mcps1.1.5.1.2"><p id="p2443177184017"><a name="p2443177184017"></a><a name="p2443177184017"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.17%" id="mcps1.1.5.1.3"><p id="p1544467124019"><a name="p1544467124019"></a><a name="p1544467124019"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p1444117134017"><a name="p1444117134017"></a><a name="p1444117134017"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row2444975406"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p544497124013"><a name="p544497124013"></a><a name="p544497124013"></a>text</p>
</td>
<td class="cellrowborder" valign="top" width="14.719999999999999%" headers="mcps1.1.5.1.2 "><p id="p1644411764014"><a name="p1644411764014"></a><a name="p1644411764014"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.17%" headers="mcps1.1.5.1.3 "><p id="p12444117204011"><a name="p12444117204011"></a><a name="p12444117204011"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1944520774014"><a name="p1944520774014"></a><a name="p1944520774014"></a>Content of <strong id="b18701135915"><a name="b18701135915"></a><a name="b18701135915"></a>DocType</strong> to set.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var arrayBuffer = new ArrayBuffer(1024);
var thatSer = new xml.XmlSerializer(arrayBuffer);
thatSer.setDocType('root SYSTEM'); // => '<!DOCTYPE root SYSTEM>';
```
## XmlPullParser<a name="section13701854986"></a>
### XmlPullParser<a name="section837014541082"></a>
constructor\(buffer: ArrayBuffer | DataView, encoding?: string\)
Creates and returns an **XmlPullParser** object. The **XmlPullParser** object passes two parameters. The first parameter is the memory of the **ArrayBuffer** or **DataView** type, and the second parameter is the file format \(UTF-8 by default\).
- Parameters
<a name="table288473334210"></a>
<table><thead align="left"><tr id="row388512334421"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p188523334214"><a name="p188523334214"></a><a name="p188523334214"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p108851333154211"><a name="p108851333154211"></a><a name="p108851333154211"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p78851433124211"><a name="p78851433124211"></a><a name="p78851433124211"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p7885183304220"><a name="p7885183304220"></a><a name="p7885183304220"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row388515334428"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p18856335429"><a name="p18856335429"></a><a name="p18856335429"></a>buffer</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p11886173344210"><a name="p11886173344210"></a><a name="p11886173344210"></a>ArrayBuffer | DataView</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p688613334215"><a name="p688613334215"></a><a name="p688613334215"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p1937471913416"><a name="p1937471913416"></a><a name="p1937471913416"></a><strong id="b245371713210"><a name="b245371713210"></a><a name="b245371713210"></a>ArrayBuffer</strong> or <strong id="b178682213217"><a name="b178682213217"></a><a name="b178682213217"></a>DataView</strong> that contains XML text information.</p>
</td>
</tr>
<tr id="row1991038194214"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p12101538134210"><a name="p12101538134210"></a><a name="p12101538134210"></a>encoding</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p1761135812426"><a name="p1761135812426"></a><a name="p1761135812426"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p154915214436"><a name="p154915214436"></a><a name="p154915214436"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p10101138164219"><a name="p10101138164219"></a><a name="p10101138164219"></a>Encoding format. Only UTF-8 is supported.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
' <title>Happy</title>' +
' <todo>Work</todo>' +
' <todo>Play</todo>' +
'</note>';
var arrayBuffer = new ArrayBuffer(strXml.length*2);
var bufView = new Uint8Array(arrayBuffer);
var strLen = strXml.length;
for (var i = 0; i < strLen; ++i) {
bufView[i] = strXml.charCodeAt(i);// Set the ArrayBuffer mode.
}
var that = new xml.XmlPullParser(arrayBuffer);
```
### parse<a name="section12316561182"></a>
parse\(option: ParseOptions\): void
Parses XML information.
- Parameters
<a name="table12343577453"></a>
<table><thead align="left"><tr id="row03443744517"><th class="cellrowborder" valign="top" width="14.82%" id="mcps1.1.5.1.1"><p id="p434416704519"><a name="p434416704519"></a><a name="p434416704519"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="14.729999999999999%" id="mcps1.1.5.1.2"><p id="p634418734515"><a name="p634418734515"></a><a name="p634418734515"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.16%" id="mcps1.1.5.1.3"><p id="p43441777454"><a name="p43441777454"></a><a name="p43441777454"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="61.29%" id="mcps1.1.5.1.4"><p id="p20344571453"><a name="p20344571453"></a><a name="p20344571453"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row634412719455"><td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.1.5.1.1 "><p id="p16344117154513"><a name="p16344117154513"></a><a name="p16344117154513"></a>option</p>
</td>
<td class="cellrowborder" valign="top" width="14.729999999999999%" headers="mcps1.1.5.1.2 "><p id="p834513718453"><a name="p834513718453"></a><a name="p834513718453"></a><a href="#section983614244916">ParseOptions</a></p>
</td>
<td class="cellrowborder" valign="top" width="9.16%" headers="mcps1.1.5.1.3 "><p id="p134518714457"><a name="p134518714457"></a><a name="p134518714457"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.1.5.1.4 "><p id="p83458744511"><a name="p83458744511"></a><a name="p83458744511"></a>Options for controlling and obtaining the parsed information.</p>
</td>
</tr>
</tbody>
</table>
- Example
```
var strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
' <title>Happy</title>' +
' <todo>Work</todo>' +
' <todo>Play</todo>' +
'</note>';
var arrayBuffer = new ArrayBuffer(strXml.length*2);
var bufView = new Uint8Array(arrayBuffer);
var strLen = strXml.length;
for (var i = 0; i < strLen; ++i) {
bufView[i] = strXml.charCodeAt(i);
}
var that = new xml.XmlPullParser(arrayBuffer);
var arrTag = {};
arrTag[0] = '132';
var i = 1;
function func(key, value){
arrTag[i] = 'key:'+key+' value:'+ value.getDepth();
i++;
return true;
}
var options = {supportDoctype:true, ignoreNameSpace:true, tokenValueCallbackFunction:func}
that.parse(options);
```
## ParseOptions<a name="section983614244916"></a>
Defines the XML parsing options.
<a name="table160910591211"></a>
<table><thead align="left"><tr id="row176096590111"><th class="cellrowborder" valign="top" width="21.990000000000002%" id="mcps1.1.5.1.1"><p id="p176091259315"><a name="p176091259315"></a><a name="p176091259315"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="36.309999999999995%" id="mcps1.1.5.1.2"><p id="p260914591118"><a name="p260914591118"></a><a name="p260914591118"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="5.52%" id="mcps1.1.5.1.3"><p id="p66092593113"><a name="p66092593113"></a><a name="p66092593113"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="36.18%" id="mcps1.1.5.1.4"><p id="p160910591312"><a name="p160910591312"></a><a name="p160910591312"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1860911593112"><td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.1.5.1.1 "><p id="p46091159419"><a name="p46091159419"></a><a name="p46091159419"></a>supportDoctype</p>
</td>
<td class="cellrowborder" valign="top" width="36.309999999999995%" headers="mcps1.1.5.1.2 "><p id="p136094597118"><a name="p136094597118"></a><a name="p136094597118"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="5.52%" headers="mcps1.1.5.1.3 "><p id="p660918591814"><a name="p660918591814"></a><a name="p660918591814"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="36.18%" headers="mcps1.1.5.1.4 "><p id="p15609259215"><a name="p15609259215"></a><a name="p15609259215"></a>Whether to ignore <strong id="b1456884321714"><a name="b1456884321714"></a><a name="b1456884321714"></a>Doctype</strong>. The default value is <strong id="b1626514489171"><a name="b1626514489171"></a><a name="b1626514489171"></a>false</strong>.</p>
</td>
</tr>
<tr id="row7610175913118"><td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.1.5.1.1 "><p id="p46108597120"><a name="p46108597120"></a><a name="p46108597120"></a>ignoreNameSpace</p>
</td>
<td class="cellrowborder" valign="top" width="36.309999999999995%" headers="mcps1.1.5.1.2 "><p id="p1661095916114"><a name="p1661095916114"></a><a name="p1661095916114"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="5.52%" headers="mcps1.1.5.1.3 "><p id="p13610559117"><a name="p13610559117"></a><a name="p13610559117"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="36.18%" headers="mcps1.1.5.1.4 "><p id="p1261012591114"><a name="p1261012591114"></a><a name="p1261012591114"></a>Whether to ignore <strong id="b649517181815"><a name="b649517181815"></a><a name="b649517181815"></a>Namespace</strong>. The default value is <strong id="b154747521819"><a name="b154747521819"></a><a name="b154747521819"></a>false</strong>.</p>
</td>
</tr>
<tr id="row16101595112"><td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.1.5.1.1 "><p id="p561013591916"><a name="p561013591916"></a><a name="p561013591916"></a>tagValueCallbackFunction</p>
</td>
<td class="cellrowborder" valign="top" width="36.309999999999995%" headers="mcps1.1.5.1.2 "><p id="p1861035916118"><a name="p1861035916118"></a><a name="p1861035916118"></a>(name: string, value: string)=&gt; boolean</p>
</td>
<td class="cellrowborder" valign="top" width="5.52%" headers="mcps1.1.5.1.3 "><p id="p1961025917117"><a name="p1961025917117"></a><a name="p1961025917117"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="36.18%" headers="mcps1.1.5.1.4 "><p id="p1561095911110"><a name="p1561095911110"></a><a name="p1561095911110"></a>Callback used to return <strong id="b16819155133814"><a name="b16819155133814"></a><a name="b16819155133814"></a>tagValue</strong>.</p>
</td>
</tr>
<tr id="row14610859616"><td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.1.5.1.1 "><p id="p76101359214"><a name="p76101359214"></a><a name="p76101359214"></a>attributeValueCallbackFunction</p>
</td>
<td class="cellrowborder" valign="top" width="36.309999999999995%" headers="mcps1.1.5.1.2 "><p id="p2061014591118"><a name="p2061014591118"></a><a name="p2061014591118"></a>(name: string, value: string)=&gt; boolean</p>
</td>
<td class="cellrowborder" valign="top" width="5.52%" headers="mcps1.1.5.1.3 "><p id="p1161012591018"><a name="p1161012591018"></a><a name="p1161012591018"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="36.18%" headers="mcps1.1.5.1.4 "><p id="p1361010593112"><a name="p1361010593112"></a><a name="p1361010593112"></a>Callback used to return <strong id="b126354223386"><a name="b126354223386"></a><a name="b126354223386"></a>attributeValue</strong>.</p>
</td>
</tr>
<tr id="row5610185911117"><td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.1.5.1.1 "><p id="p56101359912"><a name="p56101359912"></a><a name="p56101359912"></a>tokenValueCallbackFunction</p>
</td>
<td class="cellrowborder" valign="top" width="36.309999999999995%" headers="mcps1.1.5.1.2 "><p id="p1761011596112"><a name="p1761011596112"></a><a name="p1761011596112"></a>(eventType: <a href="#section8364114132911">EventType</a>, value: <a href="#section436931815497">ParseInfo</a>)=&gt; boolean</p>
</td>
<td class="cellrowborder" valign="top" width="5.52%" headers="mcps1.1.5.1.3 "><p id="p46104591014"><a name="p46104591014"></a><a name="p46104591014"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="36.18%" headers="mcps1.1.5.1.4 "><p id="p156118592117"><a name="p156118592117"></a><a name="p156118592117"></a>Callback used to return <strong id="b1063617437387"><a name="b1063617437387"></a><a name="b1063617437387"></a>tokenValue</strong>.</p>
</td>
</tr>
</tbody>
</table>
## ParseInfo<a name="section436931815497"></a>
Provides methods to manage the parsed XML information.
### getColumnNumber<a name="section7268152661315"></a>
getColumnNumber\(\): number
Obtains the column line number, which starts from 1.
- Return values
<a name="table8583171852312"></a>
<table><thead align="left"><tr id="row1583118122320"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p95841118182314"><a name="p95841118182314"></a><a name="p95841118182314"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p12584111819235"><a name="p12584111819235"></a><a name="p12584111819235"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1058411189235"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p165841118182318"><a name="p165841118182318"></a><a name="p165841118182318"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p185841618162312"><a name="p185841618162312"></a><a name="p185841618162312"></a>Column number obtained.</p>
</td>
</tr>
</tbody>
</table>
### getDepth<a name="section15616143563517"></a>
getDepth\(\): number
Obtains the depth of this element.
- Return values
<a name="table15525115213712"></a>
<table><thead align="left"><tr id="row125251952133718"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p752514520377"><a name="p752514520377"></a><a name="p752514520377"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p145251552143713"><a name="p145251552143713"></a><a name="p145251552143713"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1152518527376"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p15991162995116"><a name="p15991162995116"></a><a name="p15991162995116"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p185251152153715"><a name="p185251152153715"></a><a name="p185251152153715"></a>Depth obtained.</p>
</td>
</tr>
</tbody>
</table>
### getLineNumber<a name="section8712911183819"></a>
getLineNumber\(\): number
Obtains the current line number, starting from 1.
- Return values
<a name="table485342915385"></a>
<table><thead align="left"><tr id="row885302983818"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p1085313295388"><a name="p1085313295388"></a><a name="p1085313295388"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p185319296386"><a name="p185319296386"></a><a name="p185319296386"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row4853102919386"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p108541629123819"><a name="p108541629123819"></a><a name="p108541629123819"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p12854229113810"><a name="p12854229113810"></a><a name="p12854229113810"></a>Line number obtained.</p>
</td>
</tr>
</tbody>
</table>
### getName<a name="section183355915386"></a>
getName\(\): string
Obtains the name of this element.
- Return values
<a name="table1083372573916"></a>
<table><thead align="left"><tr id="row68331025193910"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p2833225153912"><a name="p2833225153912"></a><a name="p2833225153912"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p183362519395"><a name="p183362519395"></a><a name="p183362519395"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row2833172523915"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p2834132533918"><a name="p2834132533918"></a><a name="p2834132533918"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p083452543915"><a name="p083452543915"></a><a name="p083452543915"></a>Element name obtained.</p>
</td>
</tr>
</tbody>
</table>
### getNamespace<a name="section5884344103915"></a>
getNamespace\(\): string
Obtains the namespace of this element.
- Return values
<a name="table555314417409"></a>
<table><thead align="left"><tr id="row145533420401"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p15553046403"><a name="p15553046403"></a><a name="p15553046403"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p1255314454015"><a name="p1255314454015"></a><a name="p1255314454015"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1555313424017"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p175531042409"><a name="p175531042409"></a><a name="p175531042409"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p2055414416400"><a name="p2055414416400"></a><a name="p2055414416400"></a>Namespace obtained.</p>
</td>
</tr>
</tbody>
</table>
### getPrefix<a name="section6425182414016"></a>
getPrefix\(\): string
Obtains the prefix of this element.
- Return values
<a name="table953805664113"></a>
<table><thead align="left"><tr id="row115381356174119"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p653885613412"><a name="p653885613412"></a><a name="p653885613412"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p19538105624118"><a name="p19538105624118"></a><a name="p19538105624118"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row125385562414"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p1538175654111"><a name="p1538175654111"></a><a name="p1538175654111"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p1953965664113"><a name="p1953965664113"></a><a name="p1953965664113"></a>Element prefix obtained.</p>
</td>
</tr>
</tbody>
</table>
### getText<a name="section17411131414518"></a>
getText\(\): string
Obtains the text of the current event.
- Return values
<a name="table1970175444514"></a>
<table><thead align="left"><tr id="row99701054154517"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p697075417456"><a name="p697075417456"></a><a name="p697075417456"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p497017543454"><a name="p497017543454"></a><a name="p497017543454"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row097010542454"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p18970454174511"><a name="p18970454174511"></a><a name="p18970454174511"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p6970954184516"><a name="p6970954184516"></a><a name="p6970954184516"></a>Text content obtained.</p>
</td>
</tr>
</tbody>
</table>
### isEmptyElementTag<a name="section1817544617"></a>
isEmptyElementTag\(\): boolean
Checks whether the current element is empty.
- Return values
<a name="table19505839154618"></a>
<table><thead align="left"><tr id="row3505143984617"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p15505163954616"><a name="p15505163954616"></a><a name="p15505163954616"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p8505113934610"><a name="p8505113934610"></a><a name="p8505113934610"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1505139144620"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p1350583916465"><a name="p1350583916465"></a><a name="p1350583916465"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p11506139134613"><a name="p11506139134613"></a><a name="p11506139134613"></a>Returns <strong id="b695884461016"><a name="b695884461016"></a><a name="b695884461016"></a>true</strong> if the element is empty; returns <strong id="b1774315414113"><a name="b1774315414113"></a><a name="b1774315414113"></a>false</strong> otherwise.</p>
</td>
</tr>
</tbody>
</table>
### isWhitespace<a name="section91661610476"></a>
isWhitespace\(\): boolean
Checks whether the current text event contains only whitespace characters.
- Return values
<a name="table6645101004814"></a>
<table><thead align="left"><tr id="row7645101014811"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p8645510154813"><a name="p8645510154813"></a><a name="p8645510154813"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p146451510184813"><a name="p146451510184813"></a><a name="p146451510184813"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row6645131019485"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p11645161016486"><a name="p11645161016486"></a><a name="p11645161016486"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p20645910194820"><a name="p20645910194820"></a><a name="p20645910194820"></a>Returns <strong id="b2851155413019"><a name="b2851155413019"></a><a name="b2851155413019"></a>true</strong> if the text event contains only whitespace characters; returns <strong id="b16337271114"><a name="b16337271114"></a><a name="b16337271114"></a>false</strong> otherwise.</p>
</td>
</tr>
</tbody>
</table>
### getAttributeCount<a name="section736553519482"></a>
getAttributeCount\(\): number
Obtains the number of attributes for the current start tag.
- Return values
<a name="table18597165219484"></a>
<table><thead align="left"><tr id="row859713527484"><th class="cellrowborder" valign="top" width="29.880000000000003%" id="mcps1.1.3.1.1"><p id="p14597125254813"><a name="p14597125254813"></a><a name="p14597125254813"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="70.12%" id="mcps1.1.3.1.2"><p id="p1459711528485"><a name="p1459711528485"></a><a name="p1459711528485"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row2597135214813"><td class="cellrowborder" valign="top" width="29.880000000000003%" headers="mcps1.1.3.1.1 "><p id="p1059785244818"><a name="p1059785244818"></a><a name="p1059785244818"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="70.12%" headers="mcps1.1.3.1.2 "><p id="p45983522483"><a name="p45983522483"></a><a name="p45983522483"></a>Number of attributes obtained.</p>
</td>
</tr>
</tbody>
</table>
## EventType<a name="section8364114132911"></a>
Enumerates the events.
<a name="table71051154194714"></a>
<table><thead align="left"><tr id="row9105105494718"><th class="cellrowborder" valign="top" width="27.47%" id="mcps1.1.4.1.1"><p id="p510575413474"><a name="p510575413474"></a><a name="p510575413474"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="13.719999999999999%" id="mcps1.1.4.1.2"><p id="p151052542470"><a name="p151052542470"></a><a name="p151052542470"></a>Value</p>
</th>
<th class="cellrowborder" valign="top" width="58.809999999999995%" id="mcps1.1.4.1.3"><p id="p161061541473"><a name="p161061541473"></a><a name="p161061541473"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row13106254164718"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p717845685110"><a name="p717845685110"></a><a name="p717845685110"></a>START_DOCUMENT</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p914153211523"><a name="p914153211523"></a><a name="p914153211523"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p810715420474"><a name="p810715420474"></a><a name="p810715420474"></a>Indicates a start document event.</p>
</td>
</tr>
<tr id="row610785417479"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p117818566513"><a name="p117818566513"></a><a name="p117818566513"></a>END_DOCUMENT</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p15141143210523"><a name="p15141143210523"></a><a name="p15141143210523"></a>1</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p820172175515"><a name="p820172175515"></a><a name="p820172175515"></a>Indicates an end document event.</p>
</td>
</tr>
<tr id="row12107145411474"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p13178165612512"><a name="p13178165612512"></a><a name="p13178165612512"></a>START_TAG</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p414133213520"><a name="p414133213520"></a><a name="p414133213520"></a>2</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p27463438553"><a name="p27463438553"></a><a name="p27463438553"></a>Indicates a start tag event.</p>
</td>
</tr>
<tr id="row1110719544472"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p917885619516"><a name="p917885619516"></a><a name="p917885619516"></a>END_TAG</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p7141113215529"><a name="p7141113215529"></a><a name="p7141113215529"></a>3</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p1279231415617"><a name="p1279231415617"></a><a name="p1279231415617"></a>Indicates an end tag event.</p>
</td>
</tr>
<tr id="row11081454164717"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p12178185612518"><a name="p12178185612518"></a><a name="p12178185612518"></a>TEXT</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p1614116324529"><a name="p1614116324529"></a><a name="p1614116324529"></a>4</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p135559523569"><a name="p135559523569"></a><a name="p135559523569"></a>Indicates a text event.</p>
</td>
</tr>
<tr id="row710825415478"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p11781056175115"><a name="p11781056175115"></a><a name="p11781056175115"></a>CDSECT</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p1141113225212"><a name="p1141113225212"></a><a name="p1141113225212"></a>5</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p28815319573"><a name="p28815319573"></a><a name="p28815319573"></a>Indicates a CDATA section event.</p>
</td>
</tr>
<tr id="row16108115414713"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p4178135613518"><a name="p4178135613518"></a><a name="p4178135613518"></a>COMMENT</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p9141832145218"><a name="p9141832145218"></a><a name="p9141832145218"></a>6</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p11109135404716"><a name="p11109135404716"></a><a name="p11109135404716"></a>Indicates an XML comment event.</p>
</td>
</tr>
<tr id="row1710914548477"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p61796563515"><a name="p61796563515"></a><a name="p61796563515"></a>DOCDECL</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p8141163235220"><a name="p8141163235220"></a><a name="p8141163235220"></a>7</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p5109115444715"><a name="p5109115444715"></a><a name="p5109115444715"></a>Indicates an XML document type declaration event.</p>
</td>
</tr>
<tr id="row1710965434712"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p171791056135119"><a name="p171791056135119"></a><a name="p171791056135119"></a>INSTRUCTION</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p141428328524"><a name="p141428328524"></a><a name="p141428328524"></a>8</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p1685554515718"><a name="p1685554515718"></a><a name="p1685554515718"></a>Indicates an XML processing instruction event.</p>
</td>
</tr>
<tr id="row1511012545475"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p10179456165111"><a name="p10179456165111"></a><a name="p10179456165111"></a>ENTITY_REFERENCE</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p12142183265212"><a name="p12142183265212"></a><a name="p12142183265212"></a>9</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p91101054174716"><a name="p91101054174716"></a><a name="p91101054174716"></a>Indicates an entity reference event.</p>
</td>
</tr>
<tr id="row20989135175118"><td class="cellrowborder" valign="top" width="27.47%" headers="mcps1.1.4.1.1 "><p id="p1417955615511"><a name="p1417955615511"></a><a name="p1417955615511"></a>WHITESPACE</p>
</td>
<td class="cellrowborder" valign="top" width="13.719999999999999%" headers="mcps1.1.4.1.2 "><p id="p191421832195217"><a name="p191421832195217"></a><a name="p191421832195217"></a>10</p>
</td>
<td class="cellrowborder" valign="top" width="58.809999999999995%" headers="mcps1.1.4.1.3 "><p id="p19990155145115"><a name="p19990155145115"></a><a name="p19990155145115"></a>Indicates a whitespace character event.</p>
</td>
</tr>
</tbody>
</table>
zh-cn/application-dev/background-task-management/Readme-CN.md 0 → 100644
浏览文件 @ 5b59ac7a
# 后台任务管理
- 后台任务
- [后台任务概述](background-task-overview.md)
- [后台任务开发指导](background-task-dev-guide.md)
\ No newline at end of file
zh-cn/application-dev/background-task-management/background-task-overview.md
浏览文件 @ 5b59ac7a
# 概述 # 后台任务概述
对于有用户交互的OS来说，资源优先分配给与用户交互的业务进程，换句话说，在支撑OS运行的进程以外，用户能感知到的业务进程优先级最高，所以后台任务管理的范围是用户感知不到的业务进程。 对于有用户交互的OS来说，资源优先分配给与用户交互的业务进程，换句话说，在支撑OS运行的进程以外，用户能感知到的业务进程优先级最高，所以后台任务管理的范围是用户感知不到的业务进程。
......
zh-cn/application-dev/database/Readme-CN.md
浏览文件 @ 5b59ac7a
# 分布式数据服务 # 数据管理
- [分布式数据服务概述](database-mdds-overview.md) - 分布式数据服务
- [分布式数据服务开发指导](database-mdds-guidelines.md) - [分布式数据服务概述](database-mdds-overview.md)
- [分布式数据服务开发指导](database-mdds-guidelines.md)
- 关系型数据库
- [关系型数据库概述](database-relational-overview.md)
- [分布式数据服务开发指导](database-relational-guidelines.md)
- 轻量级数据存储
- [轻量级数据存储概述](database-preference-overview.md)
- [轻量级数据存储开发指导](database-preference-guidelines.md)
zh-cn/application-dev/database/database-preference-guidelines.md 0 → 100644
浏览文件 @ 5b59ac7a
# 轻量级数据存储开发指导
## 场景介绍
轻量级数据存储功能通常用于保存应用的一些常用配置信息，并不适合需要存储大量数据和频繁改变数据的场景。应用的数据保存在文件中，这些文件可以持久化地存储在设备上。需要注意的是，应用访问的实例包含文件所有数据，这些数据会一直加载在设备的内存中，直到应用主动从内存中将其移除前，应用可以通过Storage的API进行数据操作。
## 接口说明
轻量级存储为应用提供key-value键值型的文件数据处理能力，支持应用对数据进行轻量级存储及查询。数据存储形式为键值对，键的类型为字符串型，值的存储数据类型包括数字型、字符型、布尔型。
**创建存储实例**
读取指定文件，将数据加载到Storage实例，即可创建一个存储实例，用于数据操作。
**表1** 轻量级数据存储实例创建接口
| 包名 | 接口名 | 描述 |
| ----------------- | ------------------------------------------- | ------------------------------------------- |
| ohos.data.storage | getStorage(path: string): Promise\<Storage> | 获取文件对应的Storage单实例，用于数据操作。 |
**存入数据**
通过put系列方法，可以增加或修改Storage实例中的数据。
**表2** 轻量级数据存入接口
| 类名 | 接口名 | 描述 |
| ------- | -------------------------------------------------- | ----------------------------------------------- |
| Storage | put(key: string, value: ValueType): Promise\<void> | 支持值为number、string、boolean类型的数据存入。 |
**读取数据**
通过调用get系列方法，可以读取Storage中的数据。
**表3** 轻量级数据读取接口
| 类名 | 接口名 | 描述 |
| ------- | ---------------------------------------------------------- | ----------------------------------------------- |
| Storage | get(key: string, defValue: ValueType): Promise\<ValueType> | 支持获取值为number、string、boolean类型的数据。 |
**数据持久化**
通过执行flush方法，应用可以将缓存的数据再次写回文本文件中进行持久化存储。
**表4** 轻量级数据持久化接口
| 类名 | 接口名 | 描述 |
| ------- | ----------------------- | --------------------------------------- |
| Storage | flush(): Promise\<void> | 将Storage实例通过异步线程回写入文件中。 |
**订阅数据变化**
订阅数据变化需要指定StorageObserver作为回调方法。订阅的key的值发生变更后，当执行flush方法时，StorageObserver被回调。
**表5** 轻量级数据变化订阅接口
| 类名 | 接口名 | 描述 |
| ------- | ------------------------------------------------------------ | -------------- |
| Storage | on(type: 'change', callback: Callback\<StorageObserver>): void | 订阅数据变化。 |
| Storage | off(type: 'change', callback: Callback\<StorageObserver>): void | 注销订阅。 |
**删除数据文件**
通过调用以下两种接口，可以删除数据实例或对应的文件。
**表6** 轻量级数据存储删除接口
| 包名 | 接口名 | 描述 |
| ----------------- | ---------------------------------------------------- | ------------------------------------------------------------ |
| ohos.data.storage | deleteStorage(path: string): Promise\<void> | 从缓存中移除已加载的Storage对象，同时从设备上删除对应的文件。 |
| ohos.data.storage | removeStorageFromCache(path: string): Promise\<void> | 仅从缓存中移除已加载的Storage对象，主要用于释放内存。 |
## 开发步骤
1. 准备工作，导入@ohos.data.storage以及相关的模块到开发环境。
```
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility' // 用于获取文件存储路径
```
2. 获取Storage实例。
读取指定文件，将数据加载到Storage实例，用于数据操作。
```
var context = featureAbility.getContext()
var path = await context.getFilesDir()
let promise = dataStorage.getStorage(path + '/mystore')
```
3. 存入数据。
使用Storage put方法保存数据到缓存的实例中。
```
promise.then((storage) => {
let getPromise = storage.put('startup', 'auto') // 保存数据到缓存的storage示例中。
getPromise.then(() => {
console.info("Put the value of startup successfully.")
}).catch((err) => {
console.info("Put the value of startup failed with err: " + err)
})
}).catch((err) => {
console.info("Get the storage failed")
})
```
4. 读取数据。
使用Storage get方法读取数据。
```
promise.then((storage) => {
let getPromise = storage.get('startup', 'default')
getPromise.then((value) => {
console.info("The value of startup is " + value)
}).catch((err) => {
console.info("Get the value of startup failed with err: " + err)
})
}).catch((err) => {
console.info("Get the storage failed")})
```
5. 数据持久化。
应用存入数据到Storage实例后，可以通过flush或者flushSync方法将Storage实例回写到文件中。
```
storage.flush();
```
6. 订阅数据变化。
应用订阅数据变化需要指定StorageObserver作为回调方法。订阅的key的值发生变更后，当执行flush方法时，StorageObserver被触发回调。不再需要StorageObserver时请注销。
```
promise.then((storage) => {
var observer = function (key) {
console.info("The key of " + key + " changed.")
}
storage.on('change', observer)
storage.putSync('startup', 'auto') // 修改storage存储数据
storage.flushSync() // 触发订阅者回调方法
storage.off('change', observer) // 注销数据变化订阅
}).catch((err) => {
console.info("Get the storage failed")
})
```
7. 删除指定文件。
使用deleteStorage方法从内存中移除指定文件对应的Storage单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。删除后，数据及文件将不可恢复。
```
let promise = dataStorage.deleteStorage(path + '/mystore')
promise.then(() => {
console.info("Deleted successfully.")
}).catch((err) => {
console.info("Deleted failed with err: " + err)})
```
\ No newline at end of file
zh-cn/application-dev/database/database-preference-overview.md 0 → 100644
浏览文件 @ 5b59ac7a
# 轻量级数据存储概述
轻量级数据存储适用于对Key-Value结构的数据进行存取和持久化操作。应用获取某个轻量级存储对象后，该存储对象中的数据将会被缓存在内存中，以便应用获得更快的数据存取速度。应用也可以将缓存的数据再次写回文本文件中进行持久化存储，由于文件读写将产生不可避免的系统资源开销，建议应用减少对持久化文件的读写频率。
## 基本概念
- **Key-Value数据结构**
一种键值结构数据类型。Key是不重复的关键字，Value是数据值。
- **非关系型数据库**
区别于关系数据库，不保证遵循ACID（Atomic、Consistency、Isolation及Durability）特性，不采用关系模型来组织数据，数据之间无关系。
## 运作机制
1. 应用通过指定Storage文件将其中的数据加载到Storage实例，系统会通过静态容器将该实例存储在内存中，同一应用或进程中每个文件仅存在一个Storage实例，直到应用主动从内存中移除该实例或者删除该Storage文件。
2. 应用获取到Storage文件对应的实例后，可以从Storage实例中读取数据，或者将数据存入Storage实例中。通过调用flush或者flushSync方法可以将Storage实例中的数据回写到文件里。
**图1** 轻量级数据存储运作机制
![zh-cn_image_0000001199139454](figures/zh-cn_image_0000001199139454.png)
## 约束与限制
- 因Storage实例会加载到内存中，建议存储的数据不超过一万条，并及时清理不再使用的实例，以便减少非内存开销。
- 数据中的key为string类型，要求非空且字符长度不超过80个。
- 当数据中的value为string类型时，允许为空，字符长度不超过8192个。
\ No newline at end of file
zh-cn/application-dev/database/database-relational-guidelines.md 0 → 100644
浏览文件 @ 5b59ac7a
# 关系型数据库开发指导
## 场景介绍
关系型数据库是在SQLite基础上实现的本地数据操作机制，提供给用户无需编写原生SQL语句就能进行数据增删改查的方法，同时也支持原生SQL语句操作。
## 接口说明
**数据库的创建和删除**
关系型数据库提供了数据库创建方式，以及对应的删除接口，涉及的API如下所示。
**表1** 数据库创建和删除API
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| dataRdb | getRdbStore(config:&nbsp;StoreConfig,&nbsp;version:&nbsp;number,&nbsp;callback:&nbsp;AsyncCallback&lt;RdbStore&gt;):&nbsp;void | 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。<br/>-&nbsp;config：与此RDB存储相关的数据库配置。<br/>-&nbsp;version：数据库版本。<br/>-&nbsp;callback：指定callback回调函数。返回一个RdbStore。 |
| dataRdb | getRdbStore(config:&nbsp;StoreConfig,&nbsp;version:&nbsp;number):&nbsp;Promise&lt;RdbStore&gt; | 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。<br/>-&nbsp;config：与此RDB存储相关的数据库配置。<br/>-&nbsp;version：数据库版本。 |
| dataRdb | deleteRdbStore(name:&nbsp;string,&nbsp;callback:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 删除数据库，结果以callback形式返回。<br/>-&nbsp;name：数据库名称。<br/>-&nbsp;callback：指定callback回调函数。如果数据库已删除，则为true；否则返回false。 |
| dataRdb | deleteRdbStore(name:&nbsp;string):&nbsp;Promise&lt;void&gt; | 使用指定的数据库文件配置删除数据库，结果以Promise形式返回。<br/>-&nbsp;name：数据库名称。 |
**数据库的增删改查**
关系型数据库提供对本地数据增删改查操作的能力，相关API如下所示。
- **新增**
关系型数据库提供了插入数据的接口，通过ValuesBucket输入要存储的数据，通过返回值判断是否插入成功，插入成功时返回最新插入数据所在的行号，失败时则返回-1。
**表2** 数据库插入API
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | insert(name:&nbsp;string,&nbsp;values:&nbsp;ValuesBucket,&nbsp;callback:&nbsp;AsyncCallback&lt;number&gt;):void | 向目标表中插入一行数据，结果以callback形式返回。<br/>-&nbsp;name：指定的目标表名。<br/>-&nbsp;values：表示要插入到表中的数据行。<br/>-&nbsp;callback：指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 |
| RdbStore | insert(name:&nbsp;string,&nbsp;values:&nbsp;ValuesBucket):&nbsp;Promise&lt;number&gt; | 向目标表中插入一行数据，结果以Promise形式返回。<br/>-&nbsp;name：指定的目标表名。<br/>-&nbsp;values：表示要插入到表中的数据行。 |
- **更新**
调用更新接口，传入要更新的数据，并通过RdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败，则返回0。
**表3** 数据库更新API
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | update(values:&nbsp;ValuesBucket,&nbsp;rdbPredicates:&nbsp;RdbPredicates,&nbsp;callback:&nbsp;AsyncCallback&lt;number&gt;):void | 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以callback形式返回。<br/>-&nbsp;values：以ValuesBucket存储的要更新的数据。<br/>-&nbsp;rdbPredicates：表示RdbPredicates的实例对象指定的更新条件。<br/>-&nbsp;callback：指定的callback回调方法。返回受影响的行数。 |
| RdbStore | update(values:&nbsp;ValuesBucket,&nbsp;rdbPredicates:&nbsp;RdbPredicates):&nbsp;Promise | 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以Promise形式返回。<br/>-&nbsp;values：以ValuesBucket存储的要更新的数据。<br/>-&nbsp;rdbPredicates：表示RdbPredicates的实例对象指定的更新条件。 |
- **删除**
调用删除接口，通过RdbPredicates指定删除条件。该接口的返回值表示删除的数据行数，可根据此值判断是否删除成功。如果删除失败，则返回0。
**表4** 数据库删除API
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | delete(rdbPredicates:&nbsp;RdbPredicates,&nbsp;callback:&nbsp;AsyncCallback&lt;number&gt;):void | 根据rdbPredicates的指定实例对象从数据库中删除数据，结果以callback形式返回。<br/>-&nbsp;rdbPredicates：RdbPredicates的实例对象指定的删除条件。<br/>-&nbsp;callback：指定callback回调函数。返回受影响的行数。 |
| RdbStore | delete(rdbPredicates:&nbsp;RdbPredicates):&nbsp;Promise | 根据rdbPredicates的指定实例对象从数据库中删除数据，结果以Promise形式返回。<br/>-&nbsp;rdbPredicates：RdbPredicates的实例对象指定的删除条件。 |
- **查询**
关系型数据库提供了两种查询数据的方式：
- 直接调用查询接口。使用该接口，会将包含查询条件的谓词自动拼接成完整的SQL语句进行查询操作，无需用户传入原生的SQL语句。
- 执行原生的SQL语句进行查询操作。
**表5** 数据库查询API
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | query(rdbPredicates:&nbsp;RdbPredicates,&nbsp;columns:&nbsp;Array,&nbsp;callback:&nbsp;AsyncCallback&lt;ResultSet&gt;):&nbsp;void | 根据指定条件查询数据库中的数据，结果以callback形式返回。<br/>-&nbsp;rdbPredicates：表示RdbPredicates的实例对象指定的查询条件。<br/>-&nbsp;columns：表示要查询的列。如果值为空，则查询应用于所有列。<br/>-&nbsp;callback：指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
| RdbStore | query(rdbPredicates:&nbsp;RdbPredicates,&nbsp;columns:&nbsp;Array):&nbsp;Promise&lt;ResultSet&gt; | 根据指定条件查询数据库中的数据，结果以Promise形式返回。<br/>-&nbsp;rdbPredicates：表示RdbPredicates的实例对象指定的查询条件。<br/>-&nbsp;columns：表示要查询的列。如果值为空，则查询应用于所有列。 |
| RdbStore | querySql(sql:&nbsp;string,&nbsp;bindArgs:&nbsp;Array&lt;ValueType&gt;,&nbsp;callback:&nbsp;AsyncCallback&lt;ResultSet&gt;):void | 根据指定SQL语句查询数据库中的数据，结果以callback形式返回。<br/>-&nbsp;sql：指定要查询的SQL语句。<br/>-&nbsp;bindArgs：SQL语句中参数的值。<br/>-&nbsp;callback：指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
| RdbStore | querySql(sql:&nbsp;string,&nbsp;bindArgs?:&nbsp;Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt; | 根据指定SQL语句查询数据库中的数据，结果以Promise形式返回。<br/>-&nbsp;sql：指定要查询的SQL语句。<br/>-&nbsp;bindArgs：SQL语句中参数的值。 |
**数据库谓词的使用**
关系型数据库提供了用于设置数据库操作条件的谓词RdbPredicates，该类确定RDB中条件表达式的值是true还是false。
**表6** 数据库谓词API
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbPredicates | equalTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | notEqualTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | beginWrap():&nbsp;RdbPredicates | 向谓词添加左括号。<br/>-&nbsp;RdbPredicates：返回带有左括号的谓词。 |
| RdbPredicates | endWrap():&nbsp;RdbPredicates | 向谓词添加右括号。<br/>-&nbsp;RdbPredicates：返回带有右括号的谓词。 |
| RdbPredicates | or():&nbsp;RdbPredicates | 将或条件添加到谓词中。<br/>-&nbsp;RdbPredicates：返回带有或条件的谓词。 |
| RdbPredicates | and():&nbsp;RdbPredicates | 向谓词添加和条件。<br/>-&nbsp;RdbPredicates：返回带有和条件的谓词。 |
| RdbPredicates | contains(field:&nbsp;string,&nbsp;value:&nbsp;string):&nbsp;RdbPredicats | 配置谓词以匹配数据字段为String且value包含指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回带有包含条件的谓词。 |
| RdbPredicates | beginsWith(field:&nbsp;string,&nbsp;value:&nbsp;string):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为String且值以指定字符串开头的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | endsWith(field:&nbsp;string,&nbsp;value:&nbsp;string):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为String且值以指定字符串结尾的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | isNull(field:&nbsp;string):&nbsp;RdbPredicates | 配置谓词以匹配值为null的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | isNotNull(field:&nbsp;string):&nbsp;RdbPredicates | 配置谓词以匹配值不为null的指定字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | like(field:&nbsp;string,&nbsp;value:&nbsp;string):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为String且值类似于指定字符串的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | glob(field:&nbsp;string,&nbsp;value:&nbsp;string):&nbsp;RdbPredicates | 配置RdbPredicates匹配数据字段为String的指定字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | between(field:&nbsp;string,&nbsp;low:&nbsp;ValueType,&nbsp;high:&nbsp;ValueType):&nbsp;RdbPredicates | 将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;low：指示与谓词匹配的最小值。<br/>-&nbsp;high：指示与谓词匹配的最大值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | notBetween(field:&nbsp;string,&nbsp;low:&nbsp;ValueType,&nbsp;high:&nbsp;ValueType):&nbsp;RdbPredicates | 配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;low：指示与谓词匹配的最小值。<br/>-&nbsp;high：指示与谓词匹配的最大值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | greaterThan(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicatesgr | 配置谓词以匹配数据字段为ValueType且值大于指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | lessThan(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为valueType且value小于指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | greaterThanOrEqualTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | lessThanOrEqualTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | orderByAsc(field:&nbsp;string):&nbsp;RdbPredicates | 配置谓词以匹配其值按升序排序的列。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | orderByDesc(field:&nbsp;string):&nbsp;RdbPredicates | 配置谓词以匹配其值按降序排序的列。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | distinct():&nbsp;RdbPredicates | 配置谓词以过滤重复记录并仅保留其中一个。<br/>-&nbsp;RdbPredicates：返回可用于过滤重复记录的谓词。 |
| RdbPredicates | limitAs(value:&nbsp;number):&nbsp;RdbPredicates | 设置最大数据记录数的谓词。<br/>-&nbsp;value：最大数据记录数。<br/>-&nbsp;RdbPredicates：返回可用于设置最大数据记录数的谓词。 |
| RdbPredicates | offsetAs(rowOffset:&nbsp;number):&nbsp;RdbPredicates | 配置RdbPredicates以指定返回结果的起始位置。<br/>-&nbsp;rowOffset：返回结果的起始位置，取值为正整数。<br/>-&nbsp;RdbPredicates：返回具有指定返回结果起始位置的谓词。 |
| RdbPredicates | groupBy(fields:&nbsp;Array&lt;string&gt;):&nbsp;RdbPredicates | 配置RdbPredicates按指定列分组查询结果。<br/>-&nbsp;fields：指定分组依赖的列名。<br/>-&nbsp;RdbPredicates：返回分组查询列的谓词。 |
| RdbPredicates | indexedBy(indexName:&nbsp;string):&nbsp;RdbPredicates | 配置RdbPredicates以指定索引列。<br/>-&nbsp;indexName：索引列的名称。<br/>-&nbsp;RdbPredicates：返回具有指定索引列的RdbPredicates。 |
| RdbPredicates | in(field:&nbsp;string,&nbsp;value:&nbsp;Array&lt;ValueType&gt;):&nbsp;RdbPredicates | 配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：以ValueType型数组形式指定的要匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | notIn(field:&nbsp;string,&nbsp;value:&nbsp;Array&lt;ValueType&gt;):&nbsp;RdbPredicates | 将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：以ValueType型数组形式指定的要匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
**查询结果集的使用**
关系型数据库提供了查询返回的结果集ResultSet，其指向查询结果中的一行数据，供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。
> ![icon-notice.gif](public_sys-resources/icon-notice.gif) **须知：**
> **注：结果集使用完后，请一定要调用close方法显式关闭。**
**表7** 结果集API
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| ResultSet | goTo(offset:number):&nbsp;boolean | 从结果集当前位置移动指定偏移量。 |
| ResultSet | goToRow(position:&nbsp;number):&nbsp;boolean | 将结果集移动到指定位置。 |
| ResultSet | goToNextRow():&nbsp;boolean | 将结果集向后移动一行。 |
| ResultSet | goToPreviousRow():&nbsp;boolean | 将结果集向前移动一行。 |
| ResultSet | getColumnIndex(columnName:&nbsp;string):&nbsp;number | 根据指定的列名获取列索引。 |
| ResultSet | getColumnName(columnIndex:&nbsp;number):&nbsp;string | 根据指定的列索引获取列名。 |
| ResultSet | goToFirstRow():&nbsp;boolean | 判断结果集当前位置是否在第一行。 |
| ResultSet | goToLastRow():&nbsp;boolean | 判断结果集当前位置是否在最后一行。 |
| ResultSet | getString(columnIndex:&nbsp;number):&nbsp;string | 获取当前行指定列的值，以String类型返回。 |
| ResultSet | getBlob(columnIndex:&nbsp;number):&nbsp;Uint8Array | 获取当前行指定列的值，以字节数组形式返回。 |
| ResultSet | getDouble(columnIndex:&nbsp;number):&nbsp;number | 获取当前行指定列的值，以double型返回。 |
| ResultSet | isColumnNull(columnIndex:&nbsp;number):&nbsp;boolean | 检查当前行中指定列的值是否为null。 |
| ResultSet | close():&nbsp;void | 关闭结果集。 |
**数据库更改秘钥**
用户可以对当前数据库进行加密。
数据库的加密仅限于初始使用一个数据库时就进行加密，使用过程中进行秘钥的变更，但不支持取消秘钥。
数据库初始时为加密库，则一直为加密库；初始时为未加密库，则一直为未加密库。
**表8** 数据库更改秘钥
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | changeEncryptKey(newEncryptKey:Uint8Array,&nbsp;callback:&nbsp;AsyncCallback&lt;number&gt;):void; | 数据库更改秘钥接口，通过callback&nbsp;可以异步处理返回结果。返回结果0成功，非0失败。 |
| RdbStore | changeEncryptKey(newEncryptKey:Uint8Array):&nbsp;Promise&lt;number&gt;; | 数据库更改秘钥接口，通过await&nbsp;可以同步处理返回结果。返回结果0成功，非0失败。 |
## 开发步骤
1. 创建数据库。
1. 配置数据库相关信息，包括数据库的名称、存储模式、是否为只读模式等。
2. 初始化数据库表结构和相关数据。
3. 创建数据库。
示例代码如下：
```
import dataRdb from '@ohos.data.rdb';
const CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "name TEXT NOT NULL, " + "age INTEGER, " + "salary REAL, " + "blobType BLOB)";
const STORE_CONFIG = {name: "rdbstore.db",}
let rdbStore = await dataRdb.getRdbStore(STORE_CONFIG, 1);
await rdbStore.executeSql(CREATE_TABLE_TEST);
```
2. 插入数据。
1. 构造要插入的数据，以ValuesBucket形式存储。
2. 调用关系型数据库提供的插入接口。
示例代码如下：
```
var u8 = new Uint8Array([1, 2, 3])
const valueBucket = {"name": "Tom", "age": 18, "salary": 100.5, "blobType": u8,}
let insertPromise = rdbStore.insert("test", valueBucket)
```
3. 查询数据。
1. 构造用于查询的谓词对象，设置查询条件。
2. 调用查询接口查询数据。
3. 调用结果集接口，返回查询结果。
示例代码如下：
```
let predicates = new dataRdb.RdbPredicates("test");
predicates.equalTo("name", "Tom")
let resultSet = await rdbStore.query(predicates)
resultSet.goToFirstRow()
const id = await resultSet.getLong(resultSet.getColumnIndex("id"))
const name = await resultSet.getString(resultSet.getColumnIndex("name"))
const age = await resultSet.getLong(resultSet.getColumnIndex("age"))
const salary = await resultSet.getDouble(resultSet.getColumnIndex("salary"))
const blobType = await resultSet.getBlob(resultSet.getColumnIndex("blobType"))
resultSet.close()
```
zh-cn/application-dev/database/database-relational-overview.md 0 → 100644
浏览文件 @ 5b59ac7a
# 关系型数据库概述
关系型数据库（Relational Database，RDB）是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制，对外提供了一系列的增、删、改、查等接口，也可以直接运行用户输入的SQL语句来满足复杂的场景需要。
## 基本概念
- **关系型数据库**
基于关系模型来管理数据的数据库，以行和列的形式存储数据。
- **谓词**
数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项，主要用来定义数据库的操作条件。
- **结果集**
指用户查询之后的结果集合，可以对数据进行访问。结果集提供了灵活的数据访问方式，可以更方便的拿到用户想要的数据。
- **SQLite数据库**
一款遵守ACID的轻型开源关系型数据库管理系统。
## 运作机制
关系型数据库对外提供通用的操作接口，底层使用SQLite作为持久化存储引擎，支持SQLite具有的所有数据库特性，包括但不限于事务、索引、视图、触发器、外键、参数化查询和预编译SQL语句。
**图1** 关系型数据库运作机制
![how-rdb-works](figures/how-rdb-works.png)
## 默认配置
- 如果不指定数据库的日志模式，那么系统默认日志方式是WAL（Write Ahead Log）模式。
- 如果不指定数据库的落盘模式，那么系统默认落盘方式是FULL模式。
- OpenHarmony数据库使用的共享内存默认大小是2MB。
## 约束与限制
- 数据库中连接池的最大数量是4个，用以管理用户的读操作。
- 为保证数据的准确性，数据库同一时间只能支持一个写操作。
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
浏览文件 @ 5b59ac7a
...@@ -11,9 +11,9 @@ import hiAppEvent from '@ohos.hiAppEvent'; ...@@ -11,9 +11,9 @@ import hiAppEvent from '@ohos.hiAppEvent';
``` ```
## 权限 ## 系统能力
无 SystemCapability.HiviewDFX.HiAppEvent
## hiAppEvent.write ## hiAppEvent.write
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或