提交 18e35ec4 编写于 作者: R rcy-hw

update api and user guide

Signed-off-by: Nrcy-hw <renchunyang@huawei.com>
上级 d3147837
...@@ -29,7 +29,7 @@ Publishes an agent-powered reminder. This API uses an asynchronous callback to r ...@@ -29,7 +29,7 @@ Publishes an agent-powered reminder. This API uses an asynchronous callback to r
| callback | AsyncCallback&lt;number&gt; | Yes| Asynchronous callback used to return the published reminder's ID.| | callback | AsyncCallback&lt;number&gt; | Yes| Asynchronous callback used to return the published reminder's ID.|
**Example** **Example**
``` ```js
let timer = { let timer = {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER, reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 10 triggerTimeInSeconds: 10
...@@ -59,7 +59,7 @@ Publishes an agent-powered reminder. This API uses a promise callback to return ...@@ -59,7 +59,7 @@ Publishes an agent-powered reminder. This API uses a promise callback to return
| Promise&lt;number&gt; | Promise used to return the published reminder's ID.| | Promise&lt;number&gt; | Promise used to return the published reminder's ID.|
**Example** **Example**
``` ```js
let timer = { let timer = {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER, reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 10 triggerTimeInSeconds: 10
...@@ -87,7 +87,7 @@ Cancels the reminder with the specified ID. This API uses an asynchronous callba ...@@ -87,7 +87,7 @@ Cancels the reminder with the specified ID. This API uses an asynchronous callba
**Example** **Example**
``` ```js
reminderAgent.cancelReminder(1, (err, data) => { reminderAgent.cancelReminder(1, (err, data) => {
console.log("cancelReminder callback"); console.log("cancelReminder callback");
}); });
...@@ -116,7 +116,7 @@ Cancels the reminder with the specified ID. This API uses a promise to return th ...@@ -116,7 +116,7 @@ Cancels the reminder with the specified ID. This API uses a promise to return th
**Example** **Example**
``` ```js
reminderAgent.cancelReminder(1).then(() => { reminderAgent.cancelReminder(1).then(() => {
console.log("cancelReminder promise"); console.log("cancelReminder promise");
}); });
...@@ -139,7 +139,7 @@ Obtains all valid (not yet expired) reminders set by the current application. Th ...@@ -139,7 +139,7 @@ Obtains all valid (not yet expired) reminders set by the current application. Th
**Example** **Example**
``` ```js
reminderAgent.getValidReminders((err, reminders) => { reminderAgent.getValidReminders((err, reminders) => {
console.log("getValidReminders length = " + reminders.length); console.log("getValidReminders length = " + reminders.length);
for (let i = 0; i < reminders.length; i++) { for (let i = 0; i < reminders.length; i++) {
...@@ -183,7 +183,7 @@ Obtains all valid (not yet expired) reminders set by the current application. Th ...@@ -183,7 +183,7 @@ Obtains all valid (not yet expired) reminders set by the current application. Th
**Example** **Example**
``` ```js
reminderAgent.getValidReminders().then((reminders) => { reminderAgent.getValidReminders().then((reminders) => {
console.log("getValidReminders length = " + reminders.length); console.log("getValidReminders length = " + reminders.length);
for (let i = 0; i < reminders.length; i++) { for (let i = 0; i < reminders.length; i++) {
...@@ -227,7 +227,7 @@ Cancels all reminders set by the current application. This API uses an asynchron ...@@ -227,7 +227,7 @@ Cancels all reminders set by the current application. This API uses an asynchron
**Example** **Example**
``` ```js
reminderAgent.cancelAllReminders((err, data) =>{ reminderAgent.cancelAllReminders((err, data) =>{
console.log("cancelAllReminders callback") console.log("cancelAllReminders callback")
}) })
...@@ -250,7 +250,7 @@ Cancels all reminders set by the current application. This API uses a promise to ...@@ -250,7 +250,7 @@ Cancels all reminders set by the current application. This API uses a promise to
**Example** **Example**
``` ```js
reminderAgent.cancelAllReminders().then(() => { reminderAgent.cancelAllReminders().then(() => {
console.log("cancelAllReminders promise") console.log("cancelAllReminders promise")
}) })
...@@ -274,7 +274,7 @@ Adds a reminder notification slot. This API uses an asynchronous callback to ret ...@@ -274,7 +274,7 @@ Adds a reminder notification slot. This API uses an asynchronous callback to ret
**Example** **Example**
``` ```js
let mySlot = { let mySlot = {
type: 3, type: 3,
sound: "/sdcard/music2.mp3" sound: "/sdcard/music2.mp3"
...@@ -307,7 +307,7 @@ Adds a reminder notification slot. This API uses a promise to return the result. ...@@ -307,7 +307,7 @@ Adds a reminder notification slot. This API uses a promise to return the result.
**Example** **Example**
``` ```js
let mySlot = { let mySlot = {
type: 3, type: 3,
sound: "/sdcard/music2.mp3" sound: "/sdcard/music2.mp3"
...@@ -335,7 +335,7 @@ Removes a notification slot of a specified type. This API uses an asynchronous c ...@@ -335,7 +335,7 @@ Removes a notification slot of a specified type. This API uses an asynchronous c
**Example** **Example**
``` ```js
reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) => { reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) => {
console.log("removeNotificationSlot callback"); console.log("removeNotificationSlot callback");
}); });
...@@ -364,7 +364,7 @@ Removes a notification slot of a specified type. This API uses a promise to retu ...@@ -364,7 +364,7 @@ Removes a notification slot of a specified type. This API uses a promise to retu
**Example** **Example**
``` ```js
reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() => { reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() => {
console.log("removeNotificationSlot promise"); console.log("removeNotificationSlot promise");
}); });
......
...@@ -29,7 +29,7 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback&lt;number& ...@@ -29,7 +29,7 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback&lt;number&
| callback | AsyncCallback&lt;number&gt; | 是 | 异步回调,返回当前发布的提醒的reminderId。 | | callback | AsyncCallback&lt;number&gt; | 是 | 异步回调,返回当前发布的提醒的reminderId。 |
**示例** **示例**
``` ```js
let timer = { let timer = {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER, reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 10 triggerTimeInSeconds: 10
...@@ -59,7 +59,7 @@ publishReminder(reminderReq: ReminderRequest): Promise&lt;number&gt; ...@@ -59,7 +59,7 @@ publishReminder(reminderReq: ReminderRequest): Promise&lt;number&gt;
| Promise&lt;number&gt; | 返回提醒的reminderId。 | | Promise&lt;number&gt; | 返回提醒的reminderId。 |
**示例** **示例**
``` ```js
let timer = { let timer = {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER, reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 10 triggerTimeInSeconds: 10
...@@ -87,7 +87,7 @@ cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -87,7 +87,7 @@ cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void
**示例** **示例**
``` ```js
reminderAgent.cancelReminder(1, (err, data) => { reminderAgent.cancelReminder(1, (err, data) => {
console.log("cancelReminder callback"); console.log("cancelReminder callback");
}); });
...@@ -116,7 +116,7 @@ cancelReminder(reminderId: number): Promise&lt;void&gt; ...@@ -116,7 +116,7 @@ cancelReminder(reminderId: number): Promise&lt;void&gt;
**示例** **示例**
``` ```js
reminderAgent.cancelReminder(1).then(() => { reminderAgent.cancelReminder(1).then(() => {
console.log("cancelReminder promise"); console.log("cancelReminder promise");
}); });
...@@ -139,7 +139,7 @@ getValidReminders(callback: AsyncCallback&lt;Array&lt;ReminderRequest&gt;&gt;): ...@@ -139,7 +139,7 @@ getValidReminders(callback: AsyncCallback&lt;Array&lt;ReminderRequest&gt;&gt;):
**示例** **示例**
``` ```js
reminderAgent.getValidReminders((err, reminders) => { reminderAgent.getValidReminders((err, reminders) => {
console.log("getValidReminders length = " + reminders.length); console.log("getValidReminders length = " + reminders.length);
for (let i = 0; i < reminders.length; i++) { for (let i = 0; i < reminders.length; i++) {
...@@ -183,7 +183,7 @@ getValidReminders(): Promise&lt;Array&lt;ReminderRequest&gt;&gt; ...@@ -183,7 +183,7 @@ getValidReminders(): Promise&lt;Array&lt;ReminderRequest&gt;&gt;
**示例** **示例**
``` ```js
reminderAgent.getValidReminders().then((reminders) => { reminderAgent.getValidReminders().then((reminders) => {
console.log("getValidReminders length = " + reminders.length); console.log("getValidReminders length = " + reminders.length);
for (let i = 0; i < reminders.length; i++) { for (let i = 0; i < reminders.length; i++) {
...@@ -227,7 +227,7 @@ cancelAllReminders(callback: AsyncCallback&lt;void&gt;): void ...@@ -227,7 +227,7 @@ cancelAllReminders(callback: AsyncCallback&lt;void&gt;): void
**示例** **示例**
``` ```js
reminderAgent.cancelAllReminders((err, data) =>{ reminderAgent.cancelAllReminders((err, data) =>{
console.log("cancelAllReminders callback") console.log("cancelAllReminders callback")
}) })
...@@ -250,7 +250,7 @@ cancelAllReminders(): Promise&lt;void&gt; ...@@ -250,7 +250,7 @@ cancelAllReminders(): Promise&lt;void&gt;
**示例** **示例**
``` ```js
reminderAgent.cancelAllReminders().then(() => { reminderAgent.cancelAllReminders().then(() => {
console.log("cancelAllReminders promise") console.log("cancelAllReminders promise")
}) })
...@@ -274,7 +274,7 @@ addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback&lt;void&gt;) ...@@ -274,7 +274,7 @@ addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback&lt;void&gt;)
**示例** **示例**
``` ```js
let mySlot = { let mySlot = {
type: 3, type: 3,
sound: "/sdcard/music2.mp3" sound: "/sdcard/music2.mp3"
...@@ -307,7 +307,7 @@ addNotificationSlot(slot: NotificationSlot): Promise&lt;void&gt; ...@@ -307,7 +307,7 @@ addNotificationSlot(slot: NotificationSlot): Promise&lt;void&gt;
**示例** **示例**
``` ```js
let mySlot = { let mySlot = {
type: 3, type: 3,
sound: "/sdcard/music2.mp3" sound: "/sdcard/music2.mp3"
...@@ -335,7 +335,7 @@ removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback& ...@@ -335,7 +335,7 @@ removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback&
**示例** **示例**
``` ```js
reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) => { reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) => {
console.log("removeNotificationSlot callback"); console.log("removeNotificationSlot callback");
}); });
...@@ -364,7 +364,7 @@ removeNotificationSlot(slotType: notification.SlotType): Promise&lt;void&gt; ...@@ -364,7 +364,7 @@ removeNotificationSlot(slotType: notification.SlotType): Promise&lt;void&gt;
**示例** **示例**
``` ```js
reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() => { reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() => {
console.log("removeNotificationSlot promise"); console.log("removeNotificationSlot promise");
}); });
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册