diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md index 610cea86fa55077627a85f0492d8c752a5529722..3f1f7eb38f6719edd884a508cc96523f9479ab3b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -61,7 +61,7 @@ getController(): InputMethodController | 错误码ID | 错误信息 | | -------- | ------------------------------ | -| 12800006 | Input method controller error. | +| 12800006 | input method controller error. | **示例:** @@ -89,7 +89,7 @@ getSetting(): InputMethodSetting | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800007 | Input method settings extension error. | +| 12800007 | settings extension error. | **示例:** @@ -120,8 +120,8 @@ switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolea | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800005 | Configuration persisting error. | -| 12800008 | Input method manager service error. | +| 12800005 | configuration persisting error. | +| 12800008 | input method manager service error. | **示例:** @@ -170,8 +170,8 @@ switchInputMethod(target: InputMethodProperty): Promise<boolean> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800005 | Configuration persisting error. | -| 12800008 | Input method manager service error. | +| 12800005 | configuration persisting error. | +| 12800008 | input method manager service error. | **示例:** @@ -235,8 +235,8 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallb | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800005 | Configuration persisting error. | -| 12800008 | Input method manager service error. | +| 12800005 | configuration persisting error. | +| 12800008 | input method manager service error. | **示例:** @@ -296,8 +296,8 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean& | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800005 | Configuration persisting error. | -| 12800008 | Input method manager service error. | +| 12800005 | configuration persisting error. | +| 12800008 | input method manager service error. | **示例:** @@ -371,8 +371,8 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800005 | Configuration persisting error. | -| 12800008 | Input method manager service error. | +| 12800005 | configuration persisting error. | +| 12800008 | input method manager service error. | **示例:** @@ -425,8 +425,8 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800005 | Configuration persisting error. | -| 12800008 | Input method manager service error. | +| 12800005 | configuration persisting error. | +| 12800008 | input method manager service error. | **示例:** @@ -676,8 +676,8 @@ attach(showKeyboard: boolean, textConfig: TextConfig, callback: AsyncCallback< | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -730,8 +730,8 @@ attach(showKeyboard: boolean, textConfig: TextConfig): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -775,9 +775,9 @@ showTextInput(callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -813,9 +813,9 @@ showTextInput(): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -851,9 +851,9 @@ hideTextInput(callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -891,9 +891,9 @@ hideTextInput(): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -925,8 +925,8 @@ detach(callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -960,8 +960,8 @@ detach(): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -996,9 +996,9 @@ setCallingWindow(windowId: number, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -1045,9 +1045,9 @@ setCallingWindow(windowId: number): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -1087,9 +1087,9 @@ updateCursor(cursorInfo: CursorInfo, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -1135,9 +1135,9 @@ updateCursor(cursorInfo: CursorInfo): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -1176,9 +1176,9 @@ changeSelection(text: string, start: number, end: number, callback: AsyncCallbac | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -1224,9 +1224,9 @@ changeSelection(text: string, start: number, end: number): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -1263,9 +1263,9 @@ updateAttribute(attribute: InputAttribute, callback: AsyncCallback<void>): | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -1309,9 +1309,9 @@ updateAttribute(attribute: InputAttribute): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | -| 12800009 | Input method client is detached. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | +| 12800009 | input method client is detached. | **示例:** @@ -1349,8 +1349,8 @@ stopInputSession(callback: AsyncCallback<boolean>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -1394,8 +1394,8 @@ stopInputSession(): Promise<boolean> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -1439,8 +1439,8 @@ showSoftKeyboard(callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -1478,8 +1478,8 @@ showSoftKeyboard(): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -1515,8 +1515,8 @@ hideSoftKeyboard(callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -1554,8 +1554,8 @@ hideSoftKeyboard(): Promise<void> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800003 | Input method client error. | -| 12800008 | Input method manager service error. | +| 12800003 | input method client error. | +| 12800008 | input method manager service error. | **示例:** @@ -1658,7 +1658,7 @@ on(type: 'insertText', callback: (text: string) => void): void; | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800009 | Input method client is detached. | +| 12800009 | input method client is detached. | **示例:** @@ -1713,7 +1713,7 @@ on(type: 'deleteLeft' | 'deleteRight', callback: (length: number) => void): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800009 | Input method client is detached. | +| 12800009 | input method client is detached. | **示例:** @@ -1777,7 +1777,7 @@ on(type: 'sendKeyboardStatus', callback: (keyBoardStatus: KeyboardStatus) => voi | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800009 | Input method client is detached. | +| 12800009 | input method client is detached. | **示例:** @@ -1832,7 +1832,7 @@ on(type: 'sendFunctionKey', callback: (functionKey: FunctionKey) => void): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800009 | Input method client is detached. | +| 12800009 | input method client is detached. | **示例:** @@ -1887,7 +1887,7 @@ on(type: 'moveCursor', callback: (direction: Direction) => void): void | 错误码ID | 错误信息 | | -------- | -------------------------------- | -| 12800009 | Input method client is detached. | +| 12800009 | input method client is detached. | **示例:** @@ -1942,7 +1942,7 @@ on(type: 'handleExtendAction', callback: (action: ExtendAction) => void): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800009 | Input method client is detached. | +| 12800009 | input method client is detached. | **示例:** @@ -2179,8 +2179,8 @@ listInputMethodSubtype(inputMethodProperty: InputMethodProperty, callback: Async | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800001 | Package manager error. | -| 12800008 | Input method manager service error. | +| 12800001 | package manager error. | +| 12800008 | input method manager service error. | **示例:** @@ -2228,8 +2228,8 @@ listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise<Arr | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800001 | Package manager error. | -| 12800008 | Input method manager service error. | +| 12800001 | package manager error. | +| 12800008 | input method manager service error. | **示例:** @@ -2269,8 +2269,8 @@ listCurrentInputMethodSubtype(callback: AsyncCallback<Array<InputMethodSub | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800001 | Package manager error. | -| 12800008 | Input method manager service error. | +| 12800001 | package manager error. | +| 12800008 | input method manager service error. | **示例:** @@ -2308,8 +2308,8 @@ listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800001 | Package manager error. | -| 12800008 | Input method manager service error. | +| 12800001 | package manager error. | +| 12800008 | input method manager service error. | **示例:** @@ -2348,8 +2348,8 @@ getInputMethods(enable: boolean, callback: AsyncCallback<Array<InputMethod | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800001 | Package manager error. | -| 12800008 | Input method manager service error. | +| 12800001 | package manager error. | +| 12800008 | input method manager service error. | **示例:** @@ -2389,8 +2389,8 @@ getInputMethods(enable: boolean): Promise<Array<InputMethodProperty>> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800001 | Package manager error. | -| 12800008 | Input method manager service error. | +| 12800001 | package manager error. | +| 12800008 |input method manager service error. | **返回值:** @@ -2432,7 +2432,7 @@ showOptionalInputMethods(callback: AsyncCallback<boolean>): void | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800008 | Input method manager service error. | +| 12800008 | input method manager service error. | **示例:** @@ -2470,7 +2470,7 @@ showOptionalInputMethods(): Promise<boolean> | 错误码ID | 错误信息 | | -------- | -------------------------------------- | -| 12800008 | Input method manager service error. | +| 12800008 | input method manager service error. | **示例:** diff --git a/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md b/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md index 0220c4fa811d9f5d8a646171e75ccab8b98be744..8a06421c1de1b3fe0df129fc464bafad636dd50e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md @@ -18,22 +18,20 @@ import reminderAgentManager from'@ohos.reminderAgentManager'; ## reminderAgentManager.publishReminder -```ts publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback\): void -``` 发布一个后台代理提醒,使用回调的方式实现异步调用,该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 -**需要权限**: `ohos.permission.PUBLISH_AGENT_REMINDER` +**需要权限**: ohos.permission.PUBLISH_AGENT_REMINDER -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 | - | callback | AsyncCallback\ | 是 | 异步回调,返回当前发布的提醒的id。 | + | callback | AsyncCallback\ | 是 | 异步回调,返回当前发布的提醒的id。 | **错误码:** @@ -67,15 +65,13 @@ try { ## reminderAgentManager.publishReminder -```ts publishReminder(reminderReq: ReminderRequest): Promise\ -``` 发布一个后台代理提醒,使用`Promise`的方式实现异步调用,该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 -**需要权限**: `ohos.permission.PUBLISH_AGENT_REMINDER` +**需要权限**: ohos.permission.PUBLISH_AGENT_REMINDER -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: | 参数名 | 类型 | 必填 | 说明 | @@ -85,7 +81,7 @@ publishReminder(reminderReq: ReminderRequest): Promise\ **返回值**: | 类型 | 说明 | | -------- | -------- | - | Promise\ | 返回提醒的id。 | + | Promise\ | 返回提醒的id。 | **错误码:** @@ -117,20 +113,18 @@ try { ## reminderAgentManager.cancelReminder -```ts cancelReminder(reminderId: number, callback: AsyncCallback\): void -``` 取消指定id的提醒,使用回调的方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | reminderId | number | 是 | 目标提醒的id号。 | -| callback | AsyncCallback\ | 是 | 异步回调。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **错误码:** @@ -160,13 +154,11 @@ try { ## reminderAgentManager.cancelReminder -```ts cancelReminder(reminderId: number): Promise\ -``` -取消指定id的提醒,使用`Promise`方式实现异步调用。 +取消指定id的提醒,使用Promise方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: @@ -178,7 +170,7 @@ cancelReminder(reminderId: number): Promise\ | 类型 | 说明 | | -------- | -------- | -| PPromise\ | Promise类型异步回调。 | +| PPromise\ | Promise类型异步回调。 | **错误码:** @@ -205,20 +197,18 @@ try { ## reminderAgentManager.getValidReminders -```ts -getValidReminders(callback: AsyncCallback\>): void +getValidReminders(callback: AsyncCallback>): void -``` 获取当前应用已设置的所有有效(未过期)的提醒,使用回调方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback\\> | 是 | 异步回调,返回当前应用已设置的所有有效(未过期)的提醒。 | +| callback | AsyncCallback\> | 是 | 异步回调,返回当前应用已设置的所有有效(未过期)的提醒。 | **错误码:** @@ -267,19 +257,17 @@ try { ## reminderAgentManager.getValidReminders -```ts getValidReminders(): Promise\> -``` 获取当前应用已设置的所有有效(未过期)的提醒,使用Promise方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **返回值**: | 类型 | 说明 | | -------- | -------- | -| Promise\\> | 返回当前应用已设置的所有有效(未过期)的提醒。 | +| Promise\> | 返回当前应用已设置的所有有效(未过期)的提醒。 | **错误码:** @@ -327,19 +315,17 @@ try { ## reminderAgentManager.cancelAllReminders -```ts cancelAllReminders(callback: AsyncCallback\): void -``` 取消当前应用所有的提醒,使用回调的方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback\ | 是 | 异步回调。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **错误码:** @@ -368,19 +354,17 @@ try { ## reminderAgentManager.cancelAllReminders -```ts cancelAllReminders(): Promise\ -``` 取消当前应用所有的提醒,使用Promise方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **返回值**: | 类型 | 说明 | | -------- | -------- | -| Promise\ | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **错误码:** @@ -407,20 +391,18 @@ try { ## reminderAgentManager.addNotificationSlot -```ts addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback\): void -``` 添加一个NotificationSlot,使用回调的方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification\.slot实例,仅支持设置其type属性。 | -| callback | AsyncCallback\ | 是 | 异步回调。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **示例**: @@ -446,13 +428,11 @@ try { ## reminderAgentManager.addNotificationSlot -```ts addNotificationSlot(slot: NotificationSlot): Promise\ -``` 添加一个NotificationSlot,使用Promise方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: @@ -464,7 +444,7 @@ addNotificationSlot(slot: NotificationSlot): Promise\ | 类型 | 说明 | | -------- | -------- | -| Promise\ | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **示例**: @@ -488,20 +468,18 @@ try { ## reminderAgentManager.removeNotificationSlot -```ts removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback\): void -``` 删除目标NotificationSlot,使用回调的方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification\.slot的类型。 | -| callback | AsyncCallback\ | 是 | 异步回调。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **示例**: @@ -524,13 +502,11 @@ try { ## reminderAgentManager.removeNotificationSlot -```ts removeNotificationSlot(slotType: notification.SlotType): Promise\ -``` 删除目标NotificationSlot,使用Promise方式实现异步调用。 -**系统能力**: `SystemCapability.Notification.ReminderAgent` +**系统能力**: SystemCapability.Notification.ReminderAgent **参数**: @@ -542,7 +518,7 @@ removeNotificationSlot(slotType: notification.SlotType): Promise\ | 类型 | 说明 | | -------- | -------- | -| Promise\ | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **示例**: @@ -564,22 +540,20 @@ try { 按钮的类型。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` - -**系统接口**: ACTION_BUTTON_TYPE_CUSTOM为系统接口,三方应用不支持调用。 +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 值 | 说明 | | -------- | -------- | -------- | | ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 | | ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 | -| ACTION_BUTTON_TYPE_CUSTOM10+ | 2 | 表示自定义的按钮。(系统接口) | +| ACTION_BUTTON_TYPE_CUSTOM10+ | 2 | 表示自定义的按钮。
-**系统接口**: 系统接口,三方应用不支持调用。 | ## ReminderType 提醒的类型。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 值 | 说明 | | -------- | -------- | -------- | @@ -592,37 +566,35 @@ try { 用于设置弹出的提醒通知信息上显示的按钮类型和标题。 -**系统接口**: wantAgent为系统接口,三方应用不支持调用。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | title | string | 是 | 按钮显示的标题。 | | type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 | -| wantAgent10+ | [WantAgent](#wantagent) | 否 | 点击按钮跳转的ability信息。(系统接口) | +| wantAgent10+ | [WantAgent](#wantagent) | 否 | 点击按钮跳转的ability信息。
-**系统接口**: 系统接口,三方应用不支持调用。 | ## WantAgent 跳转目标的ability信息。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent -**系统接口**: uri为系统接口,三方应用不支持调用。 | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | pkgName | string | 是 | 指明跳转的目标包名。 | | abilityName | string | 是 | 指明跳转的目标ability名称。 | -| uri10+ | string | 否 | 指明跳转目标的uri信息。(系统接口) | +| uri10+ | string | 否 | 指明跳转目标的uri信息。
-**系统接口**: 系统接口,三方应用不支持调用。 | ## MaxScreenWantAgent 全屏显示提醒到达时自动拉起的目标ability信息,该接口预留。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -634,7 +606,7 @@ try { 提醒实例对象,用于设置提醒类型、响铃时长等具体信息。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -661,13 +633,13 @@ ReminderRequestCalendar extends ReminderRequest 日历实例对象,用于设置提醒的时间。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 | -| repeatMonths | Array\ | 否 | 指明重复提醒的月份。 | -| repeatDays | Array\ | 否 | 指明重复提醒的日期。 | +| repeatMonths | Array\ | 否 | 指明重复提醒的月份。 | +| repeatDays | Array\ | 否 | 指明重复提醒的日期。 | ## ReminderRequestAlarm @@ -676,13 +648,13 @@ ReminderRequestAlarm extends ReminderRequest 闹钟实例对象,用于设置提醒的时间。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | hour | number | 是 | 指明提醒的目标时刻。 | | minute | number | 是 | 指明提醒的目标分钟。 | -| daysOfWeek | Array\ | 否 | 指明每周哪几天需要重复提醒。范围为周一到周末,对应数字为1到7。 | +| daysOfWeek | Array\ | 否 | 指明每周哪几天需要重复提醒。范围为周一到周末,对应数字为1到7。 | ## ReminderRequestTimer @@ -691,7 +663,7 @@ ReminderRequestTimer extends ReminderRequest 倒计时实例对象,用于设置提醒的时间。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -702,7 +674,7 @@ ReminderRequestTimer extends ReminderRequest 用于日历类提醒设置时指定时间信息。 -**系统能力**:`SystemCapability.Notification.ReminderAgent` +**系统能力**:SystemCapability.Notification.ReminderAgent | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-request.md b/zh-cn/application-dev/reference/apis/js-apis-request.md index e2924180fc57ffe4753ac2b2d017d37e3b938bb2..a577bbe8edb3d38f237592b1aff5e2d0f4cabcd8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -98,7 +98,7 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask> | 错误码ID | 错误信息 | | -------- | -------- | - | 13400002 | Bad file path. | + | 13400002 | bad file path. | **示例:** @@ -146,7 +146,7 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l | 错误码ID | 错误信息 | | -------- | -------- | - | 13400002 | Bad file path. | + | 13400002 | bad file path. | **示例:** @@ -677,9 +677,9 @@ downloadFile(context: BaseContext, config: DownloadConfig): Promise<DownloadT | 错误码ID | 错误信息 | | -------- | -------- | - | 13400001 | File operation error. | - | 13400002 | Bad file path. | - | 13400003 | Task manager service error. | + | 13400001 | file operation error. | + | 13400002 | bad file path. | + | 13400003 | task manager service error. | **示例:** @@ -721,9 +721,9 @@ downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallba | 错误码ID | 错误信息 | | -------- | -------- | - | 13400001 | File operation error. | - | 13400002 | Bad file path. | - | 13400003 | Task manager service error. | + | 13400001 | file operation error. | + | 13400002 | bad file path. | + | 13400003 | task manager service error. | **示例:** @@ -1673,17 +1673,17 @@ resume(callback: AsyncCallback<void>): void **系统能力**: SystemCapability.MiscServices.Download -| 名称 | 类型 | 说明 | +| 名称 | 类型 |必填 | 说明 | | -------- | ------ |---------------- | -| downloadId | number | 下载任务ID。 | -| failedReason | number | 下载失败原因,可以是任何[下载任务的错误码](#下载任务的错误码)常量。 | -| fileName | string | 下载的文件名。 | -| filePath | string | 存储文件的URI。 | -| pausedReason | number | 会话暂停的原因,可以是任何[下载任务暂停原因](#下载任务暂停原因)常量。 | -| status | number | 下载状态码,可以是任何[下载任务状态码](#下载任务状态码)常量。 | -| targetURI | string | 下载文件的URI。 | -| downloadTitle | string | 下载任务名称。 | -| downloadTotalBytes | number | 下载的文件的总大小(int bytes)。 | -| description | string | 待下载任务的描述信息。 | -| downloadedBytes | number | 实时下载大小(int  bytes)。 | +| downloadId | number |是 | 下载任务ID。 | +| failedReason | number|是 | 下载失败原因,可以是任何[下载任务的错误码](#下载任务的错误码)常量。 | +| fileName | string |是| 下载的文件名。 | +| filePath | string |是| 存储文件的URI。 | +| pausedReason | number |是| 会话暂停的原因,可以是任何[下载任务暂停原因](#下载任务暂停原因)常量。 | +| status | number |是| 下载状态码,可以是任何[下载任务状态码](#下载任务状态码)常量。 | +| targetURI | string |是| 下载文件的URI。 | +| downloadTitle | string |是| 下载任务名称。 | +| downloadTotalBytes | number |是| 下载的文件的总大小(int bytes)。 | +| description | string |是| 待下载任务的描述信息。 | +| downloadedBytes | number |是| 实时下载大小(int  bytes)。 | \ No newline at end of file