Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 1743c481 编写于 作者: X xuzhihao
浏览文件
操作

Bugfix: arkts整改 

Signed-off-by: Nxuzhihao <xuzhihao16@huawei.com>
上级 9e7839e2
隐藏空白更改
内联 并排
Showing with 1020 addition and 756 deletion
en/application-dev/application-models/arkts-ui-widget-event-formextensionability.md
浏览文件 @ 1743c481
......@@ -42,21 +42,18 @@ On the widget page, the **postCardAction** API can be used to trigger a message
import formProvider from '@ohos.app.form.formProvider';
export default class EntryFormAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
onFormEvent(formId: string, message: string) {
// Called when a specified message event defined by the form provider is triggered.
console.info(`FormAbility onEvent, formId = ${formId}, message: ${JSON.stringify(message)}`);
let formData = {
'title':'Title Update Success.', // Matches the widget layout.
'detail':'Detail Update Success.', // Matches the widget layout.
};
let formData = new Map<Object, string>();
formData.set('title', 'Title Update.'); // It matches the widget layout.
formData.set('detail', 'Description update success.'); // It matches the widget layout.
let formInfo = formBindingData.createFormBindingData(formData)
formProvider.updateForm(formId, formInfo).then((data) => {
console.info('FormAbility updateForm success.' + JSON.stringify(data));
}).catch((error) => {
console.error('FormAbility updateForm failed: ' + JSON.stringify(error));
})
}
...
}
```
......
en/application-dev/reference/apis/js-apis-app-form-formBindingData.md
浏览文件 @ 1743c481
......@@ -66,11 +66,14 @@ import fs from '@ohos.file.fs';
try {
let fd = fs.openSync('/path/to/form.png');
let obj = {
'temperature': '21°',
'formImages': { 'image': fd }
};
formBindingData.createFormBindingData(obj);
let createFormBindingDataParam = new Map<Object, string | object>();
let formImagesParam = new Map<Object, object>();
formImagesParam.set('image', fd);
createFormBindingDataParam.set("name", '21°');
createFormBindingDataParam.set('formImages', formImagesParam);
formBindingData.createFormBindingData(createFormBindingDataParam);
} catch (error) {
console.error(`catch error, code: ${error.code}, message: ${error.message}`);
}
......
en/application-dev/reference/apis/js-apis-notificationManager.md
浏览文件 @ 1743c481
......@@ -10,6 +10,7 @@ The **notificationManager** module provides notification management capabilities
```ts
import notificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
```
## notificationManager.publish
......@@ -45,7 +46,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// publish callback
function publishCallback(err) {
function publishCallback(err: Base.BusinessError) {
if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -155,7 +156,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// publish callback
function publishCallback(err) {
function publishCallback(err: Base.BusinessError) {
if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -163,7 +164,7 @@ function publishCallback(err) {
}
}
// User ID
let userId = 1;
let userId: number = 1;
// NotificationRequest object
let notificationRequest: notificationManager.NotificationRequest = {
id: 1,
......@@ -228,7 +229,7 @@ let notificationRequest: notificationManager.NotificationRequest = {
}
};
let userId = 1;
let userId: number = 1;
notificationManager.publish(notificationRequest, userId).then(() => {
console.info("publish success");
......@@ -267,7 +268,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// cancel callback
function cancelCallback(err) {
function cancelCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -341,7 +342,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// cancel callback
function cancelCallback(err) {
function cancelCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -379,7 +380,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// cancel callback
function cancelAllCallback(err) {
function cancelAllCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancelAll failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -449,7 +450,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// addSlot callback
function addSlotCallBack(err) {
function addSlotCallBack(err: Base.BusinessError) {
if (err) {
console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -457,7 +458,7 @@ function addSlotCallBack(err) {
}
}
// NotificationSlot object
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.addSlot(notificationSlot, addSlotCallBack);
......@@ -496,7 +497,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// NotificationSlot object
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.addSlot(notificationSlot).then(() => {
......@@ -534,7 +535,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// addSlot callback
function addSlotCallBack(err) {
function addSlotCallBack(err: Base.BusinessError) {
if (err) {
console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -611,7 +612,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// addSlots callback
function addSlotsCallBack(err) {
function addSlotsCallBack(err: Base.BusinessError) {
if (err) {
console.error(`addSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -619,11 +620,11 @@ function addSlotsCallBack(err) {
}
}
// NotificationSlot object
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
// NotificationSlotArray object
let notificationSlotArray = new Array();
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
notificationSlotArray[0] = notificationSlot;
notificationManager.addSlots(notificationSlotArray, addSlotsCallBack);
......@@ -662,11 +663,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// NotificationSlot object
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
// NotificationSlotArray object
let notificationSlotArray = new Array();
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
notificationSlotArray[0] = notificationSlot;
notificationManager.addSlots(notificationSlotArray).then(() => {
......@@ -703,14 +704,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// getSlot callback
function getSlotCallback(err,data) {
function getSlotCallback(err: Base.BusinessError, data: notificationManager.NotificationSlot) {
if (err) {
console.error(`getSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlot success");
console.info(`getSlot success, data is ${JSON.stringify(data)}`);
}
}
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType, getSlotCallback);
```
......@@ -747,9 +748,10 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType).then((data) => {
console.info("getSlot success, data: " + JSON.stringify(data));
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType).then((data: notificationManager.NotificationSlot) => {
console.info("getSlot success, data: " + JSON.stringify(data));
});
```
......@@ -781,12 +783,12 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// getSlots callback
function getSlotsCallback(err,data) {
if (err) {
console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlots success");
}
function getSlotsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>) {
if (err) {
console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info(`getSlots success, data is ${JSON.stringify(data)}`);
}
}
notificationManager.getSlots(getSlotsCallback);
```
......@@ -818,7 +820,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
notificationManager.getSlots().then((data) => {
notificationManager.getSlots().then((data: Array<notificationManager.NotificationSlot>) => {
console.info("getSlots success, data: " + JSON.stringify(data));
});
```
......@@ -852,15 +854,15 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// removeSlot callback
function removeSlotCallback(err) {
if (err) {
console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("removeSlot success");
}
function removeSlotCallback(err: Base.BusinessError) {
if (err) {
console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("removeSlot success");
}
}
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType,removeSlotCallback);
notificationManager.removeSlot(slotType, removeSlotCallback);
```
## notificationManager.removeSlot
......@@ -890,7 +892,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType).then(() => {
console.info("removeSlot success");
});
......@@ -923,7 +925,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function removeAllCallBack(err) {
function removeAllCallBack(err: Base.BusinessError) {
if (err) {
console.error(`removeAllSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -993,17 +995,17 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function setNotificationEnablenCallback(err) {
function setNotificationEnableCallback(err: Base.BusinessError) {
if (err) {
console.error(`setNotificationEnablenCallback failed, code is ${err.code}, message is ${err.message}`);
console.error(`setNotificationEnableCallback failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setNotificationEnablenCallback success");
console.info("setNotificationEnableCallback success");
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.setNotificationEnable(bundle, false, setNotificationEnablenCallback);
notificationManager.setNotificationEnable(bundle, false, setNotificationEnableCallback);
```
## notificationManager.setNotificationEnable
......@@ -1039,7 +1041,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.setNotificationEnable(bundle, false).then(() => {
......@@ -1080,16 +1082,18 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function isNotificationEnabledCallback(err, data) {
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationEnabled success");
console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback);
```
......@@ -1131,10 +1135,10 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isNotificationEnabled(bundle).then((data) => {
notificationManager.isNotificationEnabled(bundle).then((data: boolean) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -1170,11 +1174,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function isNotificationEnabledCallback(err, data) {
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationEnabled success");
console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
}
}
......@@ -1212,7 +1216,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
notificationManager.isNotificationEnabled().then((data) => {
notificationManager.isNotificationEnabled().then((data: boolean) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -1250,15 +1254,15 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function isNotificationEnabledCallback(err, data) {
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationEnabled success");
console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
}
}
let userId = 1;
let userId: number = 1;
notificationManager.isNotificationEnabled(userId, isNotificationEnabledCallback);
```
......@@ -1301,9 +1305,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let userId = 1;
let userId: number = 1;
notificationManager.isNotificationEnabled(userId).then((data) => {
notificationManager.isNotificationEnabled(userId).then((data: boolean) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -1342,14 +1346,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function displayBadgeCallback(err) {
function displayBadgeCallback(err: Base.BusinessError) {
if (err) {
console.error(`displayBadge failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("displayBadge success");
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.displayBadge(bundle, false, displayBadgeCallback);
......@@ -1388,7 +1392,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.displayBadge(bundle, false).then(() => {
......@@ -1413,7 +1417,7 @@ Checks whether the notification badge is enabled for a specified application. Th
| Name | Type | Mandatory| Description |
| -------- | --------------------- | ---- | ------------------------ |
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | Yes | Bundle of the application. |
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result.|
| callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result.|
**Error codes**
......@@ -1429,14 +1433,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function isBadgeDisplayedCallback(err, data) {
function isBadgeDisplayedCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isBadgeDisplayed success");
console.info(`isBadgeDisplayed success, data is ${JSON.stringify(data)}`);
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
......@@ -1480,10 +1484,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let bundle = {
bundle: "bundleName1",
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isBadgeDisplayed(bundle).then((data) => {
notificationManager.isBadgeDisplayed(bundle).then((data: boolean) => {
console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
});
```
......@@ -1514,7 +1519,8 @@ Sets the notification badge number. This API uses a promise to return the result
**Example**
```ts
let badgeNumber = 10
let badgeNumber: number = 10;
notificationManager.setBadgeNumber(badgeNumber).then(() => {
console.info("displayBadge success");
});
......@@ -1549,7 +1555,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function setBadgeNumberCallback(err) {
function setBadgeNumberCallback(err: Base.BusinessError) {
if (err) {
console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`);
} else {
......@@ -1557,7 +1563,7 @@ function setBadgeNumberCallback(err) {
}
}
let badgeNumber = 10
let badgeNumber: number = 10;
notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback);
```
......@@ -1595,17 +1601,17 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function setSlotByBundleCallback(err) {
function setSlotByBundleCallback(err: Base.BusinessError) {
if (err) {
console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setSlotByBundle success");
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
......@@ -1644,12 +1650,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => {
console.info("setSlotByBundle success");
});
......@@ -1688,14 +1696,14 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function getSlotsByBundleCallback(err, data) {
function getSlotsByBundleCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>) {
if (err) {
console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlotsByBundle success");
console.info(`getSlotsByBundle success, data is ${JSON.stringify(data)}`);
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback);
......@@ -1739,10 +1747,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.getSlotsByBundle(bundle).then((data) => {
notificationManager.getSlotsByBundle(bundle).then((data: Array<notificationManager.NotificationSlot>) => {
console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
});
```
......@@ -1780,16 +1789,18 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function getSlotNumByBundleCallback(err, data) {
function getSlotNumByBundleCallback(err: Base.BusinessError, data: number) {
if (err) {
console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlotNumByBundle success");
console.info(`getSlotNumByBundle success data is ${JSON.stringify(data)}`);
}
}
let bundle = {
bundle: "bundleName1",
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
```
......@@ -1831,10 +1842,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let bundle = {
bundle: "bundleName1",
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.getSlotNumByBundle(bundle).then((data) => {
notificationManager.getSlotNumByBundle(bundle).then((data: number) => {
console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
});
```
......@@ -1869,11 +1881,11 @@ Obtains all active notifications. This API uses an asynchronous callback to retu
**Example**
```ts
function getAllActiveNotificationsCallback(err, data) {
function getAllActiveNotificationsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>) {
if (err) {
console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getAllActiveNotifications success");
console.info(`getAllActiveNotifications success, data is ${JSON.stringify(data)}`);
}
}
......@@ -1911,7 +1923,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
notificationManager.getAllActiveNotifications().then((data) => {
notificationManager.getAllActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
});
```
......@@ -1943,11 +1955,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function getActiveNotificationCountCallback(err, data) {
function getActiveNotificationCountCallback(err: Base.BusinessError, data: number) {
if (err) {
console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getActiveNotificationCount success");
console.info(`getActiveNotificationCount success, data is ${JSON.stringify(data)}`);
}
}
......@@ -1981,7 +1993,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
notificationManager.getActiveNotificationCount().then((data) => {
notificationManager.getActiveNotificationCount().then((data: number) => {
console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
});
```
......@@ -2013,7 +2025,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function getActiveNotificationsCallback(err, data) {
function getActiveNotificationsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>) {
if (err) {
console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2051,7 +2063,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
notificationManager.getActiveNotifications().then((data) => {
notificationManager.getActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
});
```
......@@ -2084,7 +2096,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function cancelGroupCallback(err) {
function cancelGroupCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2092,7 +2104,7 @@ function cancelGroupCallback(err) {
}
}
let groupName = "GroupName";
let groupName: string = "GroupName";
notificationManager.cancelGroup(groupName, cancelGroupCallback);
```
......@@ -2124,7 +2136,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let groupName = "GroupName";
let groupName: string = "GroupName";
notificationManager.cancelGroup(groupName).then(() => {
console.info("cancelGroup success");
});
......@@ -2164,7 +2176,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function removeGroupByBundleCallback(err) {
function removeGroupByBundleCallback(err: Base.BusinessError) {
if (err) {
console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2172,8 +2184,8 @@ function removeGroupByBundleCallback(err) {
}
}
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";
notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
```
......@@ -2211,8 +2223,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";
notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => {
console.info("removeGroupByBundle success");
});
......@@ -2251,7 +2264,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function setDoNotDisturbDateCallback(err) {
function setDoNotDisturbDateCallback(err: Base.BusinessError) {
if (err) {
console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2259,7 +2272,7 @@ function setDoNotDisturbDateCallback(err) {
}
}
let doNotDisturbDate = {
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
......@@ -2300,7 +2313,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let doNotDisturbDate = {
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
......@@ -2346,7 +2359,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function setDoNotDisturbDateCallback(err) {
function setDoNotDisturbDateCallback(err: Base.BusinessError) {
if (err) {
console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2354,13 +2367,13 @@ function setDoNotDisturbDateCallback(err) {
}
}
let doNotDisturbDate = {
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
let userId = 1;
let userId: number = 1;
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
```
......@@ -2399,13 +2412,13 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let doNotDisturbDate = {
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
let userId = 1;
let userId: number = 1;
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
console.info("setDoNotDisturbDate success");
......@@ -2445,11 +2458,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function getDoNotDisturbDateCallback(err,data) {
function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) {
if (err) {
console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDoNotDisturbDate success");
console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
}
}
......@@ -2488,8 +2501,8 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
notificationManager.getDoNotDisturbDate().then((data) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
notificationManager.getDoNotDisturbDate().then((data: notificationManager.DoNotDisturbDate) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
});
```
......@@ -2528,15 +2541,15 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
function getDoNotDisturbDateCallback(err,data) {
function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) {
if (err) {
console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDoNotDisturbDate success");
console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
}
}
let userId = 1;
let userId: number = 1;
notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
```
......@@ -2580,9 +2593,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let userId = 1;
let userId: number = 1;
notificationManager.getDoNotDisturbDate(userId).then((data) => {
notificationManager.getDoNotDisturbDate(userId).then((data: notificationManager.DoNotDisturbDate) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
});
```
......@@ -2617,7 +2630,7 @@ Checks whether DND mode is supported. This API uses an asynchronous callback to
**Example**
```ts
function isSupportDoNotDisturbModeCallback(err,data) {
function isSupportDoNotDisturbModeCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2659,7 +2672,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
notificationManager.isSupportDoNotDisturbMode().then((data) => {
notificationManager.isSupportDoNotDisturbMode().then((data: boolean) => {
console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
});
```
......@@ -2692,8 +2705,8 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
let templateName = 'process';
function isSupportTemplateCallback(err, data) {
let templateName: string = 'process';
function isSupportTemplateCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2737,9 +2750,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
let templateName = 'process';
let templateName: string = 'process';
notificationManager.isSupportTemplate(templateName).then((data) => {
notificationManager.isSupportTemplate(templateName).then((data: boolean) => {
console.info("isSupportTemplate success, data: " + JSON.stringify(data));
});
```
......@@ -2771,7 +2784,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
function requestEnableNotificationCallback(err) {
function requestEnableNotificationCallback(err: Base.BusinessError) {
if (err) {
console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2808,7 +2821,76 @@ notificationManager.requestEnableNotification().then(() => {
});
```
## notificationManager.requestEnableNotification<sup>10+<sup>
requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback\<void\>): void
Requests notification to be enabled for this application in a modal. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Notification.Notification
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------------------------ | ---- |--------------------|
| context | UIAbilityContext | Yes | Ability context bound to the notification dialog box.|
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result. |
**Error codes**
For details about the error codes, see [Notification Error Codes](../errorcodes/errorcode-notification.md).
| ID| Error Message |
| -------- | ----------------------------------- |
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
**Example**
```javascript
function requestEnableNotificationCallback(err) {
if (err) {
console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("requestEnableNotification success");
}
};
notificationManager.requestEnableNotification(globalThis.uicontext, requestEnableNotificationCallback);
```
## notificationManager.requestEnableNotification<sup>10+<sup>
requestEnableNotification(context: UIAbilityContext): Promise\<void\>
Requests notification to be enabled for this application in a modal. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------------------------ | ---- |--------------------|
| context | UIAbilityContext | Yes | Ability context bound to the notification dialog box.|
**Error codes**
For details about the error codes, see [Notification Error Codes](../errorcodes/errorcode-notification.md).
| ID| Error Message |
| -------- | ----------------------------------- |
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
**Example**
```javascript
notificationManager.requestEnableNotification(globalThis.uicontext).then(() => {
console.info("requestEnableNotification success");
});
```
## notificationManager.setDistributedEnable
......@@ -2843,7 +2925,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
function setDistributedEnableCallback(err) {
function setDistributedEnableCallback(err: Base.BusinessError) {
if (err) {
console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2851,7 +2933,7 @@ function setDistributedEnableCallback(err) {
}
};
let enable = true;
let enable: boolean = true;
notificationManager.setDistributedEnable(enable, setDistributedEnableCallback);
```
......@@ -2888,11 +2970,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
let enable = true;
let enable: boolean = true;
notificationManager.setDistributedEnable(enable).then(() => {
console.info("setDistributedEnable success");
});
console.info("setDistributedEnable success");
});
```
......@@ -2924,7 +3006,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
function isDistributedEnabledCallback(err, data) {
function isDistributedEnabledCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2966,7 +3048,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```javascript
notificationManager.isDistributedEnabled()
.then((data) => {
.then((data: boolean) => {
console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -3007,7 +3089,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
function setDistributedEnableByBundleCallback(err) {
function setDistributedEnableByBundleCallback(err: Base.BusinessError) {
if (err) {
console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3015,11 +3097,11 @@ function setDistributedEnableByBundleCallback(err) {
}
};
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
let enable = true
let enable: boolean = true;
notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback);
```
......@@ -3060,11 +3142,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
let enable = true
let enable: boolean = true;
notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => {
console.info("setDistributedEnableByBundle success");
......@@ -3105,7 +3187,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
function isDistributedEnabledByBundleCallback(err, data) {
function isDistributedEnabledByBundleCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isDistributedEnabledByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3113,7 +3195,7 @@ function isDistributedEnabledByBundleCallback(err, data) {
}
};
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
......@@ -3159,11 +3241,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isDistributedEnabledByBundle(bundle).then((data) => {
notificationManager.isDistributedEnabledByBundle(bundle).then((data: boolean) => {
console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
});
```
......@@ -3200,11 +3282,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
function getDeviceRemindTypeCallback(err, data) {
function getDeviceRemindTypeCallback(err: Base.BusinessError, data: notificationManager.DeviceRemindType) {
if (err) {
console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDeviceRemindType success");
console.info(`getDeviceRemindType success, data is ${JSON.stringify(data)}`);
}
};
......@@ -3242,7 +3324,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```javascript
notificationManager.getDeviceRemindType().then((data) => {
notificationManager.getDeviceRemindType().then((data: notificationManager.DeviceRemindType) => {
console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
});
```
......@@ -3288,7 +3370,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// publishAsBundle callback
function callback(err) {
function callback(err: Base.BusinessError) {
if (err) {
console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3296,11 +3378,11 @@ function callback(err) {
}
}
// Bundle name of the application whose notification function is taken over by the reminder agent
let representativeBundle = "com.example.demo";
let representativeBundle: string = "com.example.demo";
// User ID
let userId = 100;
let userId: number = 100;
// NotificationRequest object
let request = {
let request: notificationManager.NotificationRequest = {
id: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
......@@ -3355,11 +3437,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// Bundle name of the application whose notification function is taken over by the reminder agent
let representativeBundle = "com.example.demo";
let representativeBundle: string = "com.example.demo";
// User ID
let userId = 100;
let userId: number = 100;
// NotificationRequest object
let request = {
let request: notificationManager.NotificationRequest = {
id: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
......@@ -3415,7 +3497,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// cancelAsBundle
function cancelAsBundleCallback(err) {
function cancelAsBundleCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3423,9 +3505,9 @@ function cancelAsBundleCallback(err) {
}
}
// Bundle name of the application whose notification function is taken over by the reminder agent
let representativeBundle = "com.example.demo";
let representativeBundle: string = "com.example.demo";
// User ID
let userId = 100;
let userId: number = 100;
notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
```
......@@ -3468,9 +3550,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// Bundle name of the application whose notification function is taken over by the reminder agent
let representativeBundle = "com.example.demo";
let representativeBundle: string = "com.example.demo";
// User ID
let userId = 100;
let userId: number = 100;
notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => {
console.info("cancelAsBundle success");
......@@ -3513,7 +3595,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// setNotificationEnableSlot
function setNotificationEnableSlotCallback(err) {
function setNotificationEnableSlotCallback(err: Base.BusinessError) {
if (err) {
console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3606,11 +3688,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// isNotificationSlotEnabled
function getEnableSlotCallback(err, data) {
function getEnableSlotCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationSlotEnabled success");
console.info(`isNotificationSlotEnabled success, data is ${JSON.stringify(data)}`);
}
};
......@@ -3661,7 +3743,7 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
```ts
// isNotificationSlotEnabled
notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", },
notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data) => {
notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data: boolean) => {
console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -3701,10 +3783,10 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let userId = 100;
let enable = true;
let userId: number = 100;
let enable: boolean = true;
function callback(err) {
function callback(err: Base.BusinessError) {
if (err) {
console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3755,13 +3837,11 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let userId = 100;
let enable = true;
let userId: number = 100;
let enable: boolean = true;
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => {
console.info('setSyncNotificationEnabledWithoutApp success');
}).catch((err) => {
console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
});
```
......@@ -3799,9 +3879,9 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let userId = 100;
let userId: number = 100;
function getSyncNotificationEnabledWithoutAppCallback(err, data) {
function getSyncNotificationEnabledWithoutAppCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err);
} else {
......@@ -3851,11 +3931,10 @@ For details about the error codes, see [Notification Error Codes](../errorcodes/
**Example**
```ts
let userId = 100;
notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => {
console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
}).catch((err) => {
console.info('getSyncNotificationEnabledWithoutApp, err:' + err);
let userId: number = 100;
notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data: boolean) => {
console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
});
```
......@@ -3897,9 +3976,11 @@ try{
function OnCheckNotification(info : notificationManager.NotificationCheckInfo) {
console.info(`====>OnCheckNotification info: ${JSON.stringify(info)}`);
if(info.notificationId == 1){
return { code: 1, message: "testMsg1"}
let result: notificationManager.NotificationCheckResult = { code: 1, message: "testMsg1"};
return result;
} else {
return { code: 0, message: "testMsg0"}
let result: notificationManager.NotificationCheckResult = { code: 0, message: "testMsg0"};
return result;
}
}
```
......
en/application-dev/reference/apis/js-apis-system-notification.md
浏览文件 @ 1743c481
......@@ -50,18 +50,24 @@ Displays a notification.
| options | ShowNotificationOptions | No| Notification title.|
**Example**
```javascript
export default {
show() {
notification.show({
contentTitle: 'title info',
contentText: 'text',
clickAction: {
bundleName: 'com.example.testapp',
abilityName: 'notificationDemo',
uri: '/path/to/notification'
}
});
}
```ts
class NotificationClass {
show: Function
}
let notificationObj: NotificationClass = {
show() {
notification.show({
contentTitle: 'title info',
contentText: 'text',
clickAction: {
bundleName: 'com.example.testapp',
abilityName: 'notificationDemo',
uri: '/path/to/notification'
}
});
}
}
export default notificationObj
```
zh-cn/application-dev/application-models/arkts-ui-widget-event-formextensionability.md
浏览文件 @ 1743c481
......@@ -46,21 +46,18 @@
import formProvider from '@ohos.app.form.formProvider';
export default class EntryFormAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
onFormEvent(formId: string, message: string) {
// Called when a specified message event defined by the form provider is triggered.
console.info(`FormAbility onEvent, formId = ${formId}, message: ${JSON.stringify(message)}`);
let formData = {
'title': 'Title Update.', // 和卡片布局中对应
'detail': 'Description update success.', // 和卡片布局中对应
};
let formData = new Map<Object, string>();
formData.set('title', 'Title Update.'); // 和卡片布局中对应
formData.set('detail', 'Description update success.'); // 和卡片布局中对应
let formInfo = formBindingData.createFormBindingData(formData)
formProvider.updateForm(formId, formInfo).then((data) => {
console.info('FormAbility updateForm success.' + JSON.stringify(data));
}).catch((error) => {
console.error('FormAbility updateForm failed: ' + JSON.stringify(error));
})
}
...
}
```
......
zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md
浏览文件 @ 1743c481
......@@ -66,12 +66,17 @@ import fs from '@ohos.file.fs';
try {
let fd = fs.openSync('/path/to/form.png');
let obj = {
'temperature': '21°',
'formImages': { 'image': fd }
};
formBindingData.createFormBindingData(obj);
let createFormBindingDataParam = new Map<Object, string | object>();
let formImagesParam = new Map<Object, object>();
formImagesParam.set('image', fd);
createFormBindingDataParam.set("name", '21°');
createFormBindingDataParam.set('formImages', formImagesParam);
formBindingData.createFormBindingData(createFormBindingDataParam);
} catch (error) {
console.error(`catch error, code: ${error.code}, message: ${error.message}`);
let code = (error as Base.BusinessError).code;
let message = (error as Base.BusinessError).message;
console.error(`catch error, code: ${code}, message: ${message}`);
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md
浏览文件 @ 1743c481
......@@ -46,18 +46,19 @@ onAddForm(want: Want): formBindingData.FormBindingData
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData';
import Want from '@ohos.app.ability.Want';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onAddForm(want) {
onAddForm(want: Want) {
console.log(`FormExtensionAbility onAddForm, want: ${want.abilityName}`);
let dataObj1 = {
temperature: '11c',
'time': '11:00'
};
let dataObj1 = new Map<Object, string>();
dataObj1.set('temperature', '11c');
dataObj1.set('time', '11:00');
let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1;
}
};
}
```
## onCastToNormalForm
......@@ -80,7 +81,7 @@ onCastToNormalForm(formId: string): void
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onCastToNormalForm(formId) {
onCastToNormalForm(formId: string) {
console.log(`FormExtensionAbility onCastToNormalForm, formId: ${formId}`);
}
};
......@@ -108,16 +109,18 @@ import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onUpdateForm(formId) {
onUpdateForm(formId: string) {
console.log(`FormExtensionAbility onUpdateForm, formId: ${formId}`);
class createFormBindingDataParam {
temperature: string
time: string
}
let obj2 = formBindingData.createFormBindingData({
temperature: '22c',
time: '22:00'
});
} as createFormBindingDataParam);
formProvider.updateForm(formId, obj2).then((data) => {
console.log(`FormExtensionAbility context updateForm, data: ${data}`);
}).catch((error) => {
console.error(`Operation updateForm failed. Cause: ${error}`);
});
}
};
......@@ -144,13 +147,24 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider';
// 由于arkTs中无Object.keys，且无法使用for..in...
// 若报arkTs问题，请将此方法单独抽离至一个ts文件中并暴露，在需要用到的ets文件中引入使用
function getObjKeys(obj: Object): string[] {
let keys = Object.keys(obj);
return keys;
}
export default class MyFormExtensionAbility extends FormExtensionAbility {
onChangeFormVisibility(newStatus) {
console.log(`FormExtensionAbility onChangeFormVisibility, newStatus: ${newStatus}`);
class createFormBindingDataParam {
temperature: string
time: string
}
let obj2 = formBindingData.createFormBindingData({
temperature: '22c',
time: '22:00'
});
} as createFormBindingDataParam);
for (let key in newStatus) {
console.log(`FormExtensionAbility onChangeFormVisibility, key: ${key}, value= ${newStatus[key]}`);
......@@ -185,7 +199,7 @@ onFormEvent(formId: string, message: string): void
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
onFormEvent(formId: string, message: string) {
console.log(`FormExtensionAbility onFormEvent, formId: ${formId}, message: ${message}`);
}
};
......@@ -211,7 +225,7 @@ onRemoveForm(formId: string): void
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onRemoveForm(formId) {
onRemoveForm(formId: string) {
console.log(`FormExtensionAbility onRemoveForm, formId: ${formId}`);
}
};
......@@ -235,9 +249,10 @@ onConfigurationUpdate(newConfig: Configuration): void;
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import { Configuration } from '@ohos.app.ability.Configuration';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onConfigurationUpdate(config) {
onConfigurationUpdate(config: Configuration) {
console.log(`onConfigurationUpdate, config: ${JSON.stringify(config)}`);
}
};
......@@ -262,9 +277,10 @@ onAcquireFormState?(want: Want): formInfo.FormState;
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formInfo from '@ohos.app.form.formInfo';
import Want from '@ohos.app.ability.Want';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onAcquireFormState(want) {
onAcquireFormState(want: Want) {
console.log(`FormExtensionAbility onAcquireFormState, want: ${want}`);
return formInfo.FormState.UNKNOWN;
}
......@@ -299,11 +315,11 @@ onShareForm?(formId: string): { [key: string]: Object }
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onShareForm(formId) {
onShareForm(formId: string) {
console.log(`FormExtensionAbility onShareForm, formId: ${formId}`);
let wantParams = {
'temperature': '20',
'time': '2022-8-8 09:59',
'time': '2022-8-8 09:59',s
};
return wantParams;
}
......@@ -338,7 +354,7 @@ onAcquireFormData?(formId: string): { [key: string]: Object }
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onAcquireFormData(formId) {
onAcquireFormData(formId: string) {
console.log('FormExtensionAbility onAcquireFormData, formId: ${formId}');
let wantParams = {
'temperature': '20',
......
zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md
浏览文件 @ 1743c481
......@@ -11,6 +11,7 @@ formHost模块提供了卡片使用方相关接口的能力，包括对使用方
```ts
import formHost from '@ohos.app.form.formHost';
import Base from '@ohos.base';
```
## deleteForm
......@@ -51,8 +52,8 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
formHost.deleteForm(formId, (error) => {
let formId: string = '12400633174999288';
formHost.deleteForm(formId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
} else {
......@@ -108,11 +109,11 @@ deleteForm(formId: string): Promise&lt;void&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.deleteForm(formId).then(() => {
console.log('formHost deleteForm success');
}).catch((error) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}).catch((error: Base.BusinessError) => {
console.error('formHost deleteForm, error: ${JSON.stringify(error)}');
});
} catch(error) {
console.error(`catch error, code: ${error.code}, message: ${error.message}`);
......@@ -157,8 +158,8 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
formHost.releaseForm(formId, (error) => {
let formId: string = '12400633174999288';
formHost.releaseForm(formId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -207,8 +208,8 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
formHost.releaseForm(formId, true, (error) => {
let formId: string = '12400633174999288';
formHost.releaseForm(formId, true, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -262,10 +263,10 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.releaseForm(formId, true).then(() => {
console.log('formHost releaseForm success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -311,8 +312,8 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
formHost.requestForm(formId, (error) => {
let formId: string = '12400633174999288';
formHost.requestForm(formId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -365,10 +366,10 @@ requestForm(formId: string): Promise&lt;void&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.requestForm(formId).then(() => {
console.log('formHost requestForm success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -415,8 +416,8 @@ castToNormalForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
formHost.castToNormalForm(formId, (error) => {
let formId: string = '12400633174999288';
formHost.castToNormalForm(formId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -469,10 +470,10 @@ castToNormalForm(formId: string): Promise&lt;void&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.castToNormalForm(formId).then(() => {
console.log('formHost castTempForm success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -516,8 +517,8 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
import formHost from '@ohos.app.form.formHost';
try {
let formId = ['12400633174999288'];
formHost.notifyVisibleForms(formId, (error) => {
let formId: string[] = ['12400633174999288'];
formHost.notifyVisibleForms(formId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -568,10 +569,10 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = ['12400633174999288'];
let formId: string[] = ['12400633174999288'];
formHost.notifyVisibleForms(formId).then(() => {
console.log('formHost notifyVisibleForms success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -615,8 +616,8 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo
import formHost from '@ohos.app.form.formHost';
try {
let formId = ['12400633174999288'];
formHost.notifyInvisibleForms(formId, (error) => {
let formId: string[] = ['12400633174999288'];
formHost.notifyInvisibleForms(formId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -667,10 +668,10 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = ['12400633174999288'];
let formId: string[] = ['12400633174999288'];
formHost.notifyInvisibleForms(formId).then(() => {
console.log('formHost notifyInvisibleForms success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -715,8 +716,8 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void&
import formHost from '@ohos.app.form.formHost';
try {
let formId = ['12400633174999288'];
formHost.enableFormsUpdate(formId, (error) => {
let formId: string[] = ['12400633174999288'];
formHost.enableFormsUpdate(formId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -768,10 +769,10 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = ['12400633174999288'];
let formId: string[] = ['12400633174999288'];
formHost.enableFormsUpdate(formId).then(() => {
console.log('formHost enableFormsUpdate success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -817,8 +818,8 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
import formHost from '@ohos.app.form.formHost';
try {
let formId = ['12400633174999288'];
formHost.disableFormsUpdate(formId, (error) => {
let formId: string[] = ['12400633174999288'];
formHost.disableFormsUpdate(formId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -871,10 +872,10 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formId = ['12400633174999288'];
let formId: string[] = ['12400633174999288'];
formHost.disableFormsUpdate(formId).then(() => {
console.log('formHost disableFormsUpdate success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -911,7 +912,7 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void
import formHost from '@ohos.app.form.formHost';
try {
formHost.isSystemReady((error, data) => {
formHost.isSystemReady((error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -951,7 +952,7 @@ import formHost from '@ohos.app.form.formHost';
try {
formHost.isSystemReady().then(() => {
console.log('formHost isSystemReady success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -992,13 +993,14 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;):
```ts
import formHost from '@ohos.app.form.formHost';
import formInfo from '@ohos.app.form.formInfo';
try {
formHost.getAllFormsInfo((error, data) => {
formHost.getAllFormsInfo((error: Base.BusinessError, data: formInfo.FormInfo[]) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
} else {
console.log('formHost getAllFormsInfo, data: ${JSON.stringify(data)}');
console.log(`formHost getAllFormsInfo, data: ${JSON.stringify(data)}`);
}
});
} catch(error) {
......@@ -1038,11 +1040,12 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;
```ts
import formHost from '@ohos.app.form.formHost';
import formInfo from '@ohos.app.form.formInfo';
try {
formHost.getAllFormsInfo().then((data) => {
console.log('formHost getAllFormsInfo data: ${JSON.stringify(data)}');
}).catch((error) => {
formHost.getAllFormsInfo().then((data: formInfo.FormInfo[]) => {
console.log(`formHost getAllFormsInfo data: ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -1085,13 +1088,14 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo
```ts
import formHost from '@ohos.app.form.formHost';
import formInfo from '@ohos.app.form.formInfo';
try {
formHost.getFormsInfo('com.example.ohos.formjsdemo', (error, data) => {
formHost.getFormsInfo('com.example.ohos.formjsdemo', (error: Base.BusinessError, data: formInfo.FormInfo[]) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
} else {
console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
console.log(`formHost getFormsInfo, data: ${JSON.stringify(data)}`);
}
});
} catch(error) {
......@@ -1135,9 +1139,10 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;
```ts
import formHost from '@ohos.app.form.formHost';
import formInfo from '@ohos.app.form.formInfo';
try {
formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error, data) => {
formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error: Base.BusinessError, data: formInfo.FormInfo[]) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
} else {
......@@ -1190,11 +1195,12 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI
```ts
import formHost from '@ohos.app.form.formHost';
import formInfo from '@ohos.app.form.formInfo';
try {
formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data) => {
console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
}).catch((error) => {
formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data: formInfo.FormInfo[]) => {
console.log(`formHost getFormsInfo, data: ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -1238,12 +1244,12 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb
import formHost from '@ohos.app.form.formHost';
try {
let formIds = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds, (error, data) => {
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds, (error: Base.BusinessError, data: number) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
} else {
console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}');
console.log(`formHost deleteInvalidForms, data: ${JSON.stringify(data)}`);
}
});
} catch(error) {
......@@ -1292,10 +1298,10 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;
import formHost from '@ohos.app.form.formHost';
try {
let formIds = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds).then((data) => {
console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}');
}).catch((error) => {
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds).then((data: number) => {
console.log(`formHost deleteInvalidForms, data: ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -1338,8 +1344,10 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
```ts
import formHost from '@ohos.app.form.formHost';
import Want from '@ohos.app.ability.Want';
import formInfo from '@ohos.app.form.formInfo';
let want = {
let want: Want = {
'deviceId': '',
'bundleName': 'ohos.samples.FormApplication',
'abilityName': 'FormAbility',
......@@ -1350,11 +1358,11 @@ let want = {
}
};
try {
formHost.acquireFormState(want, (error, data) => {
formHost.acquireFormState(want, (error:Base.BusinessError, data: formInfo.FormStateInfo) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
} else {
console.log('formHost acquireFormState, data: ${JSON.stringify(data)}');
console.log(`formHost acquireFormState, data: ${JSON.stringify(data)}`);
}
});
} catch(error) {
......@@ -1402,8 +1410,10 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;
```ts
import formHost from '@ohos.app.form.formHost';
import Want from '@ohos.app.ability.Want';
import formInfo from '@ohos.app.form.formInfo';
let want = {
let want: Want = {
'deviceId': '',
'bundleName': 'ohos.samples.FormApplication',
'abilityName': 'FormAbility',
......@@ -1414,9 +1424,9 @@ let want = {
}
};
try {
formHost.acquireFormState(want).then((data) => {
console.log('formHost acquireFormState, data: ${JSON.stringify(data)}');
}).catch((error) => {
formHost.acquireFormState(want).then((data: formInfo.FormStateInfo) => {
console.log(`formHost acquireFormState, data: ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -1453,10 +1463,9 @@ on(type: 'formUninstall', callback: Callback&lt;string&gt;): void
```ts
import formHost from '@ohos.app.form.formHost';
let callback = function(formId) {
console.log('formHost on formUninstall, formId: ${formId}');
}
formHost.on('formUninstall', callback);
formHost.on('formUninstall', (formId: string) => {
console.log(`formHost on formUninstall, formId: ${formId}`);
});
```
## off('formUninstall')
......@@ -1488,10 +1497,9 @@ off(type: 'formUninstall', callback?: Callback&lt;string&gt;): void
```ts
import formHost from '@ohos.app.form.formHost';
let callback = function(formId) {
console.log('formHost on formUninstall, formId: ${formId}');
}
formHost.off('formUninstall', callback);
formHost.off('formUninstall', (formId: string) => {
console.log(`formHost on formUninstall, formId: ${formId}`);
});
```
## notifyFormsVisible
......@@ -1531,9 +1539,9 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A
```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
try {
formHost.notifyFormsVisible(formIds, true, (error) => {
formHost.notifyFormsVisible(formIds, true, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -1585,11 +1593,11 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt
```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
try {
formHost.notifyFormsVisible(formIds, true).then(() => {
console.log('formHost notifyFormsVisible success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -1634,9 +1642,9 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c
```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
try {
formHost.notifyFormsEnableUpdate(formIds, true, (error) => {
formHost.notifyFormsEnableUpdate(formIds, true, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -1688,11 +1696,11 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean):
```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
try {
formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
console.log('formHost notifyFormsEnableUpdate success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -1736,10 +1744,10 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback&lt;void&gt;)
```ts
import formHost from '@ohos.app.form.formHost';
let formId = '12400633174999288';
let deviceId = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2';
let formId: string = '12400633174999288';
let deviceId: string = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2';
try {
formHost.shareForm(formId, deviceId, (error) => {
formHost.shareForm(formId, deviceId, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -1791,12 +1799,12 @@ shareForm(formId: string, deviceId: string): Promise&lt;void&gt;
```ts
import formHost from '@ohos.app.form.formHost';
let formId = '12400633174999288';
let deviceId = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2';
let formId: string = '12400633174999288';
let deviceId: string = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2';
try {
formHost.shareForm(formId, deviceId).then(() => {
console.log('formHost shareForm success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -1840,9 +1848,9 @@ notifyFormsPrivacyProtected(formIds: Array\<string>, isProtected: boolean, callb
```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
try {
formHost.notifyFormsPrivacyProtected(formIds, true, (error) => {
formHost.notifyFormsPrivacyProtected(formIds, true, (error: Base.BusinessError) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
}
......@@ -1891,11 +1899,11 @@ notifyFormsPrivacyProtected(formIds: Array\<string\>, isProtected: boolean): Pro
```ts
import formHost from '@ohos.app.form.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
try {
formHost.notifyFormsPrivacyProtected(formIds, true).then(() => {
console.log('formHost notifyFormsPrivacyProtected success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......@@ -1937,13 +1945,13 @@ acquireFormData(formId: string, callback: AsyncCallback<{[key: string]: Object}>
```ts
import formHost from '@ohos.app.form.formHost';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
try {
formHost.acquireFormData(formId, (error, data) => {
if (error) {
console.error(`error, code: ${error.code}, message: ${error.message}`);
} else {
console.log('formHost acquireFormData, data: ${JSON.stringify(data)}');
console.log(`formHost acquireFormData, data: ${JSON.stringify(data)}`);
}
});
} catch(error) {
......@@ -1989,11 +1997,11 @@ acquireFormData(formId: string): Promise<{[key: string]: Object}>;
```ts
import formHost from '@ohos.app.form.formHost';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
try {
formHost.acquireFormData(formId).then((data) => {
console.log('formHost acquireFormData success' + data);
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`error, code: ${error.code}, message: ${error.message}`);
});
} catch(error) {
......
zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md
浏览文件 @ 1743c481
......@@ -9,6 +9,7 @@ FormProvider模块提供了卡片提供方相关接口的能力，开发者在
```ts
import formProvider from '@ohos.app.form.formProvider';
import Base from '@ohos.base';
```
## setFormNextRefreshTime
......@@ -45,9 +46,9 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l
**示例：**
```ts
let formId = '12400633174999288';
let formId: string = '12400633174999288';
try {
formProvider.setFormNextRefreshTime(formId, 5, (error) => {
formProvider.setFormNextRefreshTime(formId, 5, (error: Base.BusinessError) => {
if (error) {
console.error(`callback error, code: ${error.code}, message: ${error.message})`);
return;
......@@ -98,11 +99,11 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt;
**示例：**
```ts
let formId = '12400633174999288';
let formId: string = '12400633174999288';
try {
formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log(`formProvider setFormNextRefreshTime success`);
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`promise error, code: ${error.code}, message: ${error.message})`);
});
} catch (error) {
......@@ -145,10 +146,17 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
```ts
import formBindingData from '@ohos.app.form.formBindingData';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
try {
let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
formProvider.updateForm(formId, obj, (error) => {
class createFormBindingDataParamType {
temperature: string
time: string
}
let obj = formBindingData.createFormBindingData({
temperature:'22c',
time:'22:00'
} as createFormBindingDataParamType);
formProvider.updateForm(formId, obj, (error: Base.BusinessError) => {
if (error) {
console.error(`callback error, code: ${error.code}, message: ${error.message})`);
return;
......@@ -200,12 +208,19 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
```ts
import formBindingData from '@ohos.app.form.formBindingData';
let formId = '12400633174999288';
let obj = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' });
let formId: string = '12400633174999288';
class createFormBindingDataParamType {
temperature: string
time: string
}
let obj = formBindingData.createFormBindingData({
temperature:'22c',
time:'22:00'
} as createFormBindingDataParamType);
try {
formProvider.updateForm(formId, obj).then(() => {
console.log(`formProvider updateForm success`);
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`promise error, code: ${error.code}, message: ${error.message})`);
});
} catch (error) {
......@@ -247,7 +262,7 @@ try {
console.error(`callback error, code: ${error.code}, message: ${error.message})`);
return;
}
console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}');
console.log(`formProvider getFormsInfo, data: ${JSON.stringify(data)}`);
});
} catch (error) {
console.error(`catch error, code: ${error.code}, message: ${error.message})`);
......@@ -294,7 +309,7 @@ try {
console.error(`callback error, code: ${error.code}, message: ${error.message})`);
return;
}
console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}');
console.log(`formProvider getFormsInfo, data: ${JSON.stringify(data)}`);
});
} catch (error) {
console.error(`catch error, code: ${error.code}, message: ${error.message})`);
......@@ -342,9 +357,9 @@ const filter: formInfo.FormInfoFilter = {
moduleName: 'entry'
};
try {
formProvider.getFormsInfo(filter).then((data) => {
console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}');
}).catch((error) => {
formProvider.getFormsInfo(filter).then((data: formInfo.FormInfo[]) => {
console.log(`formProvider getFormsInfo, data: ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`promise error, code: ${error.code}, message: ${error.message})`);
});
} catch (error) {
......@@ -386,8 +401,9 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData,
```ts
import formBindingData from '@ohos.app.form.formBindingData';
import Want from '@ohos.app.ability.Want';
let want = {
let want: Want = {
abilityName: 'FormAbility',
parameters: {
'ohos.extra.param.key.form_dimension': 2,
......@@ -396,8 +412,15 @@ let want = {
}
};
try {
let obj = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' });
formProvider.requestPublishForm(want, obj, (error, data) => {
class createFormBindingDataParamType {
temperature: string
time: string
}
let obj = formBindingData.createFormBindingData({
temperature:'22c',
time:'22:00'
} as createFormBindingDataParamType);
formProvider.requestPublishForm(want, obj, (error: Base.BusinessError, data: string) => {
if (error) {
console.error(`callback error, code: ${error.code}, message: ${error.message})`);
return;
......@@ -441,7 +464,9 @@ requestPublishForm(want: Want, callback: AsyncCallback&lt;string&gt;): void
**示例：**
```ts
let want = {
import Want from '@ohos.app.ability.Want';
let want: Want = {
abilityName: 'FormAbility',
parameters: {
'ohos.extra.param.key.form_dimension': 2,
......@@ -450,12 +475,12 @@ let want = {
}
};
try {
formProvider.requestPublishForm(want, (error, data) => {
formProvider.requestPublishForm(want, (error: Base.BusinessError, data: string) => {
if (error) {
console.error(`callback error, code: ${error.code}, message: ${error.message})`);
return;
}
console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}');
console.log(`formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}`);
});
} catch (error) {
console.error(`catch error, code: ${error.code}, message: ${error.message})`);
......@@ -500,7 +525,9 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
**示例：**
```ts
let want = {
import Want from '@ohos.app.ability.Want';
let want: Want = {
abilityName: 'FormAbility',
parameters: {
'ohos.extra.param.key.form_dimension': 2,
......@@ -509,9 +536,9 @@ let want = {
}
};
try {
formProvider.requestPublishForm(want).then((data) => {
console.log('formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}');
}).catch((error) => {
formProvider.requestPublishForm(want).then((data: string) => {
console.log(`formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`promise error, code: ${error.code}, message: ${error.message})`);
});
} catch (error) {
......@@ -549,13 +576,15 @@ isRequestPublishFormSupported(callback: AsyncCallback&lt;boolean&gt;): void
**示例：**
```ts
import Want from '@ohos.app.ability.Want';
try {
formProvider.isRequestPublishFormSupported((error, isSupported) => {
formProvider.isRequestPublishFormSupported((error: Base.BusinessError, isSupported: boolean) => {
if (error) {
console.error(`callback error, code: ${error.code}, message: ${error.message})`);
} else {
if (isSupported) {
var want = {
let want: Want = {
abilityName: 'FormAbility',
parameters: {
'ohos.extra.param.key.form_dimension': 2,
......@@ -564,12 +593,12 @@ try {
}
};
try {
formProvider.requestPublishForm(want, (error, data) => {
formProvider.requestPublishForm(want, (error: Base.BusinessError, data: string) => {
if (error) {
console.error(`callback error, code: ${error.code}, message: ${error.message})`);
return;
}
console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}');
console.log(`formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}`);
});
} catch (error) {
console.error(`catch error, code: ${error.code}, message: ${error.message})`);
......@@ -611,10 +640,12 @@ isRequestPublishFormSupported(): Promise&lt;boolean&gt;
**示例：**
```ts
import Want from '@ohos.app.ability.Want';
try {
formProvider.isRequestPublishFormSupported().then((isSupported) => {
formProvider.isRequestPublishFormSupported().then((isSupported: boolean) => {
if (isSupported) {
var want = {
let want: Want = {
abilityName: 'FormAbility',
parameters: {
'ohos.extra.param.key.form_dimension': 2,
......@@ -623,16 +654,16 @@ try {
}
};
try {
formProvider.requestPublishForm(want).then((data) => {
console.log('formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}');
}).catch((error) => {
formProvider.requestPublishForm(want).then((data: string) => {
console.log(`formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`promise error, code: ${error.code}, message: ${error.message})`);
});
} catch (error) {
console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}
}
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error(`promise error, code: ${error.code}, message: ${error.message})`);
});
} catch (error) {
......
zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md
浏览文件 @ 1743c481
......@@ -53,11 +53,13 @@ import fs from '@ohos.file.fs';
try {
let fd = fs.openSync('/path/to/form.png');
let obj = {
'temperature': '21°',
'formImages': { 'image': fd }
};
formBindingData.createFormBindingData(obj);
let createFormBindingDataParam = new Map<Object, string | object>();
let formImagesParam = new Map<Object, object>();
formImagesParam.set('image', fd);
createFormBindingDataParam.set("name", '21°');
createFormBindingDataParam.set('formImages', formImagesParam);
formBindingData.createFormBindingData(createFormBindingDataParam);
} catch (error) {
console.error('catch error, error: ${JSON.stringify(error)}');
}
......
zh-cn/application-dev/reference/apis/js-apis-application-formHost.md
浏览文件 @ 1743c481
......@@ -12,6 +12,7 @@ formHost模块提供了卡片使用方相关接口的能力，包括对使用方
```ts
import formHost from '@ohos.application.formHost';
import Base from '@ohos.base';
```
## deleteForm
......@@ -36,7 +37,7 @@ deleteForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.deleteForm(formId, (error, data) => {
if (error.code) {
console.error('formHost deleteForm, error: ${JSON.stringify(error)}');
......@@ -71,10 +72,10 @@ deleteForm(formId: string): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.deleteForm(formId).then(() => {
console.log('formHost deleteForm success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost deleteForm, error: ${JSON.stringify(error)}');
});
```
......@@ -101,8 +102,8 @@ releaseForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
formHost.releaseForm(formId, (error, data) => {
let formId: string = '12400633174999288';
formHost.releaseForm(formId, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost releaseForm, error: ${JSON.stringify(error)}');
} else {
......@@ -134,8 +135,8 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback&lt;
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
formHost.releaseForm(formId, true, (error, data) => {
let formId: string = '12400633174999288';
formHost.releaseForm(formId, true, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost releaseForm, error: ${JSON.stringify(error)}');
} else {
......@@ -172,10 +173,10 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.releaseForm(formId, true).then(() => {
console.log('formHost releaseForm success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost releaseForm, error: ${JSON.stringify(error)}');
});
```
......@@ -202,8 +203,8 @@ requestForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
formHost.requestForm(formId, (error, data) => {
let formId: string = '12400633174999288';
formHost.requestForm(formId, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost requestForm, error: ${JSON.stringify(error)}');
}
......@@ -237,10 +238,10 @@ requestForm(formId: string): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.requestForm(formId).then(() => {
console.log('formHost requestForm success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost requestForm, error: ${JSON.stringify(error)}');
});
```
......@@ -267,8 +268,8 @@ castTempForm(formId: string, callback: AsyncCallback&lt;void&gt;): void
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
formHost.castTempForm(formId, (error, data) => {
let formId: string = '12400633174999288';
formHost.castTempForm(formId, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost castTempForm, error: ${JSON.stringify(error)}');
}
......@@ -302,10 +303,10 @@ castTempForm(formId: string): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.castTempForm(formId).then(() => {
console.log('formHost castTempForm success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost castTempForm, error: ${JSON.stringify(error)}');
});
```
......@@ -332,8 +333,8 @@ notifyVisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
```ts
import formHost from '@ohos.application.formHost';
let formId = ['12400633174999288'];
formHost.notifyVisibleForms(formId, (error, data) => {
let formId: string[] = ['12400633174999288'];
formHost.notifyVisibleForms(formId, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost notifyVisibleForms, error: ${JSON.stringify(error)}');
}
......@@ -367,10 +368,10 @@ notifyVisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = ['12400633174999288'];
let formId: string[] = ['12400633174999288'];
formHost.notifyVisibleForms(formId).then(() => {
console.log('formHost notifyVisibleForms success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost notifyVisibleForms, error: ${JSON.stringify(error)}');
});
```
......@@ -397,8 +398,8 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;vo
```ts
import formHost from '@ohos.application.formHost';
let formId = ['12400633174999288'];
formHost.notifyInvisibleForms(formId, (error, data) => {
let formId: string[] = ['12400633174999288'];
formHost.notifyInvisibleForms(formId, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost notifyInvisibleForms, error: ${JSON.stringify(error)}');
}
......@@ -432,10 +433,10 @@ notifyInvisibleForms(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = ['12400633174999288'];
let formId: string[] = ['12400633174999288'];
formHost.notifyInvisibleForms(formId).then(() => {
console.log('formHost notifyInvisibleForms success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost notifyInvisibleForms, error: ${JSON.stringify(error)}');
});
```
......@@ -462,8 +463,8 @@ enableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void&
```ts
import formHost from '@ohos.application.formHost';
let formId = ['12400633174999288'];
formHost.enableFormsUpdate(formId, (error, data) => {
let formId: string[] = ['12400633174999288'];
formHost.enableFormsUpdate(formId, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost enableFormsUpdate, error: ${JSON.stringify(error)}');
}
......@@ -497,10 +498,10 @@ enableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = ['12400633174999288'];
let formId: string[] = ['12400633174999288'];
formHost.enableFormsUpdate(formId).then(() => {
console.log('formHost enableFormsUpdate success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost enableFormsUpdate, error: ${JSON.stringify(error)}');
});
```
......@@ -527,8 +528,8 @@ disableFormsUpdate(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;void
```ts
import formHost from '@ohos.application.formHost';
let formId = ['12400633174999288'];
formHost.disableFormsUpdate(formId, (error, data) => {
let formId: string[] = ['12400633174999288'];
formHost.disableFormsUpdate(formId, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost disableFormsUpdate, error: ${JSON.stringify(error)}');
}
......@@ -562,10 +563,10 @@ disableFormsUpdate(formIds: Array&lt;string&gt;): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = ['12400633174999288'];
let formId: string[] = ['12400633174999288'];
formHost.disableFormsUpdate(formId).then(() => {
console.log('formHost disableFormsUpdate success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost disableFormsUpdate, error: ${JSON.stringify(error)}');
});
```
......@@ -589,8 +590,8 @@ isSystemReady(callback: AsyncCallback&lt;void&gt;): void
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
formHost.isSystemReady((error, data) => {
let formId: string = '12400633174999288';
formHost.isSystemReady((error: Base.BusinessError) => {
if (error.code) {
console.error('formHost isSystemReady, error: ${JSON.stringify(error)}');
}
......@@ -616,10 +617,10 @@ isSystemReady(): Promise&lt;void&gt;
```ts
import formHost from '@ohos.application.formHost';
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formHost.isSystemReady().then(() => {
console.log('formHost isSystemReady success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost isSystemReady, error: ${JSON.stringify(error)}');
});
```
......@@ -644,8 +645,9 @@ getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;):
```ts
import formHost from '@ohos.application.formHost';
import formInfo from '@ohos.app.form.formInfo';
formHost.getAllFormsInfo((error, data) => {
formHost.getAllFormsInfo((error: Base.BusinessError, data: formInfo.FormInfo[]) => {
if (error.code) {
console.error('formHost getAllFormsInfo, error: ${JSON.stringify(error)}');
} else {
......@@ -674,10 +676,11 @@ getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;
```ts
import formHost from '@ohos.application.formHost';
import formInfo from '@ohos.app.form.formInfo';
formHost.getAllFormsInfo().then((data) => {
formHost.getAllFormsInfo().then((data: formInfo.FormInfo[]) => {
console.log('formHost getAllFormsInfo data: ${JSON.stringify(data)}');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('formHost getAllFormsInfo, error: ${JSON.stringify(error)}');
});
```
......@@ -703,12 +706,13 @@ getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.Fo
```ts
import formHost from '@ohos.application.formHost';
import formInfo from '@ohos.app.form.formInfo';
formHost.getFormsInfo('com.example.ohos.formjsdemo', (error, data) => {
formHost.getFormsInfo('com.example.ohos.formjsdemo', (error: Base.BusinessError, data: formInfo.FormInfo[]) => {
if (error.code) {
console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}');
console.error(`formHost getFormsInfo, error: ${JSON.stringify(error)}`);
} else {
console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
console.log(`formHost getFormsInfo, data: ${JSON.stringify(data)}`);
}
});
```
......@@ -735,8 +739,9 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;
```ts
import formHost from '@ohos.application.formHost';
import formInfo from '@ohos.app.form.formInfo';
formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error, data) => {
formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry', (error: Base.BusinessError, data: formInfo.FormInfo[]) => {
if (error.code) {
console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}');
} else {
......@@ -773,10 +778,10 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formI
```ts
import formHost from '@ohos.application.formHost';
formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data) => {
console.log('formHost getFormsInfo, data: ${JSON.stringify(data)}');
}).catch((error) => {
console.error('formHost getFormsInfo, error: ${JSON.stringify(error)}');
formHost.getFormsInfo('com.example.ohos.formjsdemo', 'entry').then((data: formInfo.FormInfo[]) => {
console.log(`formHost getFormsInfo, data: ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`formHost getFormsInfo, error: ${JSON.stringify(error)}`);
});
```
......@@ -802,12 +807,12 @@ deleteInvalidForms(formIds: Array&lt;string&gt;, callback: AsyncCallback&lt;numb
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds, (error, data) => {
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds, (error: Base.BusinessError, data: number) => {
if (error.code) {
console.error('formHost deleteInvalidForms, error: ${JSON.stringify(error)}');
console.error(`formHost deleteInvalidForms, error: ${JSON.stringify(error)}`);
} else {
console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}');
console.log(`formHost deleteInvalidForms, data: ${JSON.stringify(data)}`);
}
});
```
......@@ -839,11 +844,11 @@ deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds).then((data) => {
console.log('formHost deleteInvalidForms, data: ${JSON.stringify(data)}');
}).catch((error) => {
console.error('formHost deleteInvalidForms, error: ${JSON.stringify(error)}');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
formHost.deleteInvalidForms(formIds).then((data: number) => {
console.log(`formHost deleteInvalidForms, data: ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`formHost deleteInvalidForms, error: ${JSON.stringify(error)}`);
});
```
......@@ -868,8 +873,10 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
```ts
import formHost from '@ohos.application.formHost';
import Want from '@ohos.app.ability.Want';
import formInfo from '@ohos.app.form.formInfo';
let want = {
let want: Want = {
'deviceId': '',
'bundleName': 'ohos.samples.FormApplication',
'abilityName': 'FormAbility',
......@@ -879,11 +886,11 @@ let want = {
'ohos.extra.param.key.form_dimension': 2
}
};
formHost.acquireFormState(want, (error, data) => {
formHost.acquireFormState(want, (error:Base.BusinessError, data: formInfo.FormStateInfo) => {
if (error.code) {
console.error('formHost acquireFormState, error: ${JSON.stringify(error)}');
console.error(`formHost acquireFormState, error: ${JSON.stringify(error)}`);
} else {
console.log('formHost acquireFormState, data: ${JSON.stringify(data)}');
console.log(`formHost acquireFormState, data: ${JSON.stringify(data)}`);
}
});
```
......@@ -914,8 +921,10 @@ acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;
```ts
import formHost from '@ohos.application.formHost';
import Want from '@ohos.app.ability.Want';
import formInfo from '@ohos.app.form.formInfo';
let want = {
let want: Want = {
'deviceId': '',
'bundleName': 'ohos.samples.FormApplication',
'abilityName': 'FormAbility',
......@@ -925,10 +934,10 @@ let want = {
'ohos.extra.param.key.form_dimension': 2
}
};
formHost.acquireFormState(want).then((data) => {
console.log('formHost acquireFormState, data: ${JSON.stringify(data)}');
}).catch((error) => {
console.error('formHost acquireFormState, error: ${JSON.stringify(error)}');
formHost.acquireFormState(want).then((data: formInfo.FormStateInfo) => {
console.log(`formHost acquireFormState, data: ${JSON.stringify(data)}`);
}).catch((error: Base.BusinessError) => {
console.error(`formHost acquireFormState, error: ${JSON.stringify(error)}`);
});
```
......@@ -952,10 +961,9 @@ on(type: 'formUninstall', callback: Callback&lt;string&gt;): void
```ts
import formHost from '@ohos.application.formHost';
let callback = function(formId) {
console.log('formHost on formUninstall, formId: ${formId}');
};
formHost.on('formUninstall', callback);
formHost.on('formUninstall', (formId: string) => {
console.log(`formHost on formUninstall, formId: ${formId}`);
});
```
## off('formUninstall')
......@@ -978,10 +986,9 @@ off(type: 'formUninstall', callback?: Callback&lt;string&gt;): void
```ts
import formHost from '@ohos.application.formHost';
let callback = function(formId) {
console.log('formHost on formUninstall, formId: ${formId}');
};
formHost.off('formUninstall', callback);
formHost.off('formUninstall', (formId: string) => {
console.log(`formHost on formUninstall, formId: ${formId}`);
});
```
## notifyFormsVisible
......@@ -1007,10 +1014,10 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean, callback: A
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsVisible(formIds, true, (error, data) => {
let formIds: string[]= new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsVisible(formIds, true, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost notifyFormsVisible, error: ${JSON.stringify(error)}');
console.error(`formHost notifyFormsVisible, error: ${JSON.stringify(error)}`);
}
});
```
......@@ -1043,11 +1050,11 @@ notifyFormsVisible(formIds: Array&lt;string&gt;, isVisible: boolean): Promise&lt
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsVisible(formIds, true).then(() => {
console.log('formHost notifyFormsVisible success');
}).catch((error) => {
console.error('formHost notifyFormsVisible, error: ${JSON.stringify(error)}');
}).catch((error: Base.BusinessError) => {
console.error(`formHost notifyFormsVisible, error: ${JSON.stringify(error)}`);
});
```
......@@ -1074,8 +1081,8 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean, c
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => {
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsEnableUpdate(formIds, true, (error: Base.BusinessError) => {
if (error.code) {
console.error('formHost notifyFormsEnableUpdate, error: ${JSON.stringify(error)}');
}
......@@ -1110,10 +1117,10 @@ notifyFormsEnableUpdate(formIds: Array&lt;string&gt;, isEnableUpdate: boolean):
```ts
import formHost from '@ohos.application.formHost';
let formIds = new Array('12400633174999288', '12400633174999289');
let formIds: string[] = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
console.log('formHost notifyFormsEnableUpdate success');
}).catch((error) => {
console.error('formHost notifyFormsEnableUpdate, error: ${JSON.stringify(error)}');
}).catch((error: Base.BusinessError) => {
console.error(`formHost notifyFormsEnableUpdate, error: ${JSON.stringify(error)}`);
});
```
zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md
浏览文件 @ 1743c481
......@@ -10,6 +10,7 @@ FormProvider模块提供了卡片提供方相关接口的能力，开发者在
```ts
import formProvider from '@ohos.application.formProvider';
import Base from '@ohos.base'
```
## setFormNextRefreshTime
......@@ -31,8 +32,8 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l
**示例：**
```ts
let formId = '12400633174999288';
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
let formId: string = '12400633174999288';
formProvider.setFormNextRefreshTime(formId, 5, (error: Base.BusinessError) => {
if (error.code) {
console.error('formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}');
}
......@@ -63,11 +64,11 @@ setFormNextRefreshTime(formId: string, minute: number): Promise&lt;void&gt;
**示例：**
```ts
let formId = '12400633174999288';
let formId: string = '12400633174999288';
formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log('formProvider setFormNextRefreshTime success');
}).catch((error) => {
console.error('formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}');
}).catch((error: Base.BusinessError) => {
console.error(`formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}`);
});
```
......@@ -93,10 +94,17 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
import formBindingData from '@ohos.app.form.formBindingData';
let formId = '12400633174999288';
let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
formProvider.updateForm(formId, obj, (error, data) => {
class createBindingDataType {
temperature: string
time: string
};
let obj = formBindingData.createFormBindingData({
temperature:'22c',
time:'22:00'
} as createBindingDataType);
formProvider.updateForm(formId, obj, (error: Base.BusinessError) => {
if (error.code) {
console.error('formProvider updateForm, error: ${JSON.stringify(error)}');
console.error(`formProvider updateForm, error: ${JSON.stringify(error)}`);
}
});
```
......@@ -127,12 +135,19 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
```ts
import formBindingData from '@ohos.application.formBindingData';
let formId = '12400633174999288';
let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
let formId: string = '12400633174999288';
class createBindingDataType {
temperature: string
time: string
};
let obj = formBindingData.createFormBindingData({
temperature:'22c',
time:'22:00'
} as createBindingDataType);
formProvider.updateForm(formId, obj).then(() => {
console.log('formProvider updateForm success');
}).catch((error) => {
console.error('formProvider updateForm, error: ${JSON.stringify(error)}');
}).catch((error: Base.BusinessError) => {
console.error(`formProvider updateForm, error: ${JSON.stringify(error)}`);
});
```
......
zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md
浏览文件 @ 1743c481
......@@ -13,6 +13,7 @@ FormExtensionContext模块提供FormExtensionAbility具有的接口和能力。
```ts
import common from '@ohos.app.ability.common';
import Base from '@ohos.base';
```
## FormExtensionContext.startAbility
......@@ -49,12 +50,13 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import Want from '@ohos.app.ability.Want';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
onFormEvent(formId: string, message: string) {
// 当触发卡片message事件时，执行startAbility
console.log('FormExtensionAbility onFormEvent, formId: ${formId}, message:${message}');
let want = {
console.log(`FormExtensionAbility onFormEvent, formId: ${formId}, message:${message}`);
let want: Want = {
deviceId: '',
bundleName: 'com.example.formstartability',
abilityName: 'EntryAbility',
......@@ -62,7 +64,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
'message': message
}
};
this.context.startAbility(want, (error) => {
this.context.startAbility(want, (error: Base.BusinessError) => {
if (error) {
console.error('FormExtensionContext startAbility, error:${JSON.stringify(error)}');
} else {
......@@ -112,12 +114,13 @@ startAbility(want: Want): Promise&lt;void&gt;
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import Want from '@ohos.app.ability.Want';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
onFormEvent(formId: string, message: string) {
// 当触发卡片message事件时，执行startAbility
console.log('FormExtensionAbility onFormEvent, formId:${formId}, message:${message}');
let want = {
console.log(`FormExtensionAbility onFormEvent, formId:${formId}, message:${message}`);
let want: Want = {
deviceId: '',
bundleName: 'com.example.formstartability',
abilityName: 'EntryAbility',
......@@ -127,7 +130,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
};
this.context.startAbility(want).then(() => {
console.info('StartAbility Success');
}).catch((error) => {
}).catch((error: Base.BusinessError) => {
console.error('StartAbility failed');
});
}
......@@ -164,7 +167,6 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000053 | The ability is not on the top of the UI. |
......@@ -176,41 +178,44 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
**示例：**
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
let commRemote = null;
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
// 当触发卡片message事件时，执行connectServiceExtensionAbility
console.log(`FormExtensionAbility onFormEvent, formId:${formId}, message:${message}`);
let want = {
deviceId: '',
bundleName: 'com.example.formstartability',
abilityName: 'EntryAbility',
parameters: {
'message': message
}
};
let options = {
onConnect(elementName, remote) {
commRemote = remote; // remote 用于与ServiceExtensionAbility进行通信
console.log('----------- onConnect -----------');
},
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.error('----------- onFailed -----------') }
};
let connection = null;
try {
connection = this.context.connectServiceExtensionAbility(want, options);
} catch (paramError) {
// 处理入参错误异常
console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`);
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import Want from '@ohos.app.ability.Want';
import rpc from '@ohos.rpc';
import common from '@ohos.app.ability.common';
let commRemote: rpc.IRemoteObject | null = null;
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId: string, message: string) {
// 当触发卡片message事件时，执行connectServiceExtensionAbility
console.log(`FormExtensionAbility onFormEvent, formId:${formId}, message:${message}`);
let want: Want = {
deviceId: '',
bundleName: 'com.example.formstartability',
abilityName: 'EntryAbility',
parameters: {
'message': message
}
};
let options: common.ConnectOptions = {
onConnect(elementName, remote) {
commRemote = remote; // remote 用于与ServiceExtensionAbility进行通信
console.log('----------- onConnect -----------');
},
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.error('----------- onFailed -----------') }
};
let connection: number | null = null;
try {
connection = this.context.connectServiceExtensionAbility(want, options);
} catch (paramError) {
// 处理入参错误异常
console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`);
}
};
```
}
};
```
## FormExtensionContext.disconnectServiceExtensionAbility<sup>10+</sup>
......@@ -240,36 +245,38 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback&lt;
**示例：**
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import rpc from '@ohos.rpc';
import common from '@ohos.app.ability.common';
// commRemote为onConnect回调内返回的remote对象，此处定义为null无任何实际意义，仅作示例
let commRemote = null;
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
// 实际使用时，connection为connectServiceExtensionAbility中的返回值，此处定义为1无任何实际意义，仅作示例
let connection = 1;
// commRemote为onConnect回调内返回的remote对象，此处定义为null无任何实际意义，仅作示例
let commRemote: rpc.IRemoteObject | null = null;
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId: string, message: string) {
// 实际使用时，connection为connectServiceExtensionAbility中的返回值，此处定义为1无任何实际意义，仅作示例
let connection: number = 1;
try {
this.context.disconnectServiceExtensionAbility(connection, (error) => {
commRemote = null;
if (error.code) {
// 处理业务逻辑错误
console.error(
`disconnectServiceExtensionAbility failed, error.code: ${error.code}, error.message: ${error.message}`);
return;
}
// 执行正常业务
console.log('disconnectServiceExtensionAbility succeed');
});
} catch (paramError) {
try {
this.context.disconnectServiceExtensionAbility(connection, (error: Base.BusinessError) => {
commRemote = null;
// 处理入参错误异常
console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`);
}
if (error.code) {
// 处理业务逻辑错误
console.error(
`disconnectServiceExtensionAbility failed, error.code: ${error.code}, error.message: ${error.message}`);
return;
}
// 执行正常业务
console.log('disconnectServiceExtensionAbility succeed');
});
} catch (paramError) {
commRemote = null;
// 处理入参错误异常
console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`);
}
};
```
}
};
```
## FormExtensionContext.disconnectServiceExtensionAbility<sup>10+</sup>
......@@ -304,34 +311,36 @@ disconnectServiceExtensionAbility(connection: number): Promise&lt;void&gt;;
**示例：**
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
// commRemote为onConnect回调内返回的remote对象，此处定义为null无任何实际意义，仅作示例
let commRemote = null;
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) {
// 实际使用时，connection为connectServiceExtensionAbility中的返回值，此处定义为1无任何实际意义，仅作示例
let connection = 1;
try {
this.context.disconnectServiceExtensionAbility(connection)
.then((data) => {
commRemote = null;
// 执行正常业务
console.log('disconnectServiceExtensionAbility succeed');
})
.catch((error) => {
commRemote = null;
// 处理业务逻辑错误
console.error(
`disconnectServiceExtensionAbility failed, error.code: ${error.code}, error.message: ${error.message}`);
});
} catch (paramError) {
commRemote = null;
// 处理入参错误异常
console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`);
}
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import rpc from '@ohos.rpc';
import common from '@ohos.app.ability.common';
// commRemote为onConnect回调内返回的remote对象，此处定义为null无任何实际意义，仅作示例
let commRemote: rpc.IRemoteObject | null = null;
export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId: string, message: string) {
// 实际使用时，connection为connectServiceExtensionAbility中的返回值，此处定义为1无任何实际意义，仅作示例
let connection: number = 1;
try {
this.context.disconnectServiceExtensionAbility(connection)
.then(() => {
commRemote = null;
// 执行正常业务
console.log('disconnectServiceExtensionAbility succeed');
})
.catch((error: Base.BusinessError) => {
commRemote = null;
// 处理业务逻辑错误
console.error(
`disconnectServiceExtensionAbility failed, error.code: ${error.code}, error.message: ${error.message}`);
});
} catch (paramError) {
commRemote = null;
// 处理入参错误异常
console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`);
}
};
```
}
};
```
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md
浏览文件 @ 1743c481
......@@ -28,7 +28,7 @@ import missionManager from '@ohos.app.ability.missionManager';
**示例：**
```ts
import ElementName from '@ohos.bundle';
import ElementName from '@ohos.bundle.bundleManager';
import image from '@ohos.multimedia.image';
import missionManager from '@ohos.app.ability.missionManager';
......
zh-cn/application-dev/reference/apis/js-apis-notificationManager.md
浏览文件 @ 1743c481
......@@ -10,6 +10,7 @@
```ts
import notificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
```
## notificationManager.publish
......@@ -45,7 +46,7 @@ publish(request: NotificationRequest, callback: AsyncCallback\<void\>): void
```ts
//publish回调
function publishCallback(err) {
function publishCallback(err: Base.BusinessError) {
if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -155,7 +156,7 @@ publish(request: NotificationRequest, userId: number, callback: AsyncCallback\<v
```ts
// publish回调
function publishCallback(err) {
function publishCallback(err: Base.BusinessError) {
if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -163,7 +164,7 @@ function publishCallback(err) {
}
}
// 用户ID
let userId = 1;
let userId: number = 1;
// 通知Request对象
let notificationRequest: notificationManager.NotificationRequest = {
id: 1,
......@@ -228,7 +229,7 @@ let notificationRequest: notificationManager.NotificationRequest = {
}
};
let userId = 1;
let userId: number = 1;
notificationManager.publish(notificationRequest, userId).then(() => {
console.info("publish success");
......@@ -267,7 +268,7 @@ cancel(id: number, label: string, callback: AsyncCallback\<void\>): void
```ts
// cancel回调
function cancelCallback(err) {
function cancelCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -341,7 +342,7 @@ cancel(id: number, callback: AsyncCallback\<void\>): void
```ts
// cancel回调
function cancelCallback(err) {
function cancelCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -379,7 +380,7 @@ cancelAll(callback: AsyncCallback\<void\>): void
```ts
// cancel回调
function cancelAllCallback(err) {
function cancelAllCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancelAll failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -449,7 +450,7 @@ addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>): void
```ts
// addslot回调
function addSlotCallBack(err) {
function addSlotCallBack(err: Base.BusinessError) {
if (err) {
console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -457,7 +458,7 @@ function addSlotCallBack(err) {
}
}
// 通知slot对象
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.addSlot(notificationSlot, addSlotCallBack);
......@@ -496,7 +497,7 @@ addSlot(slot: NotificationSlot): Promise\<void\>
```ts
// 通知slot对象
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.addSlot(notificationSlot).then(() => {
......@@ -534,7 +535,7 @@ addSlot(type: SlotType, callback: AsyncCallback\<void\>): void
```ts
// addslot回调
function addSlotCallBack(err) {
function addSlotCallBack(err: Base.BusinessError) {
if (err) {
console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -611,7 +612,7 @@ addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>): voi
```ts
// addSlots回调
function addSlotsCallBack(err) {
function addSlotsCallBack(err: Base.BusinessError) {
if (err) {
console.error(`addSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -619,11 +620,11 @@ function addSlotsCallBack(err) {
}
}
// 通知slot对象
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
// 通知slot array 对象
let notificationSlotArray = new Array();
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
notificationSlotArray[0] = notificationSlot;
notificationManager.addSlots(notificationSlotArray, addSlotsCallBack);
......@@ -662,11 +663,11 @@ addSlots(slots: Array\<NotificationSlot\>): Promise\<void\>
```ts
// 通知slot对象
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
// 通知slot array 对象
let notificationSlotArray = new Array();
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
notificationSlotArray[0] = notificationSlot;
notificationManager.addSlots(notificationSlotArray).then(() => {
......@@ -703,14 +704,14 @@ getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>): void
```ts
// getSlot回调
function getSlotCallback(err,data) {
function getSlotCallback(err: Base.BusinessError, data: notificationManager.NotificationSlot) {
if (err) {
console.error(`getSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlot success");
console.info(`getSlot success, data is ${JSON.stringify(data)}`);
}
}
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType, getSlotCallback);
```
......@@ -747,9 +748,10 @@ getSlot(slotType: SlotType): Promise\<NotificationSlot\>
**示例：**
```ts
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType).then((data) => {
console.info("getSlot success, data: " + JSON.stringify(data));
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType).then((data: notificationManager.NotificationSlot) => {
console.info("getSlot success, data: " + JSON.stringify(data));
});
```
......@@ -781,12 +783,12 @@ getSlots(callback: AsyncCallback\<Array\<NotificationSlot>>): void
```ts
// getSlots回调
function getSlotsCallback(err,data) {
if (err) {
console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlots success");
}
function getSlotsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>) {
if (err) {
console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info(`getSlots success, data is ${JSON.stringify(data)}`);
}
}
notificationManager.getSlots(getSlotsCallback);
```
......@@ -818,7 +820,7 @@ getSlots(): Promise\<Array\<NotificationSlot>>
**示例：**
```ts
notificationManager.getSlots().then((data) => {
notificationManager.getSlots().then((data: Array<notificationManager.NotificationSlot>) => {
console.info("getSlots success, data: " + JSON.stringify(data));
});
```
......@@ -852,15 +854,15 @@ removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>): void
```ts
// removeSlot回调
function removeSlotCallback(err) {
if (err) {
console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("removeSlot success");
}
function removeSlotCallback(err: Base.BusinessError) {
if (err) {
console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("removeSlot success");
}
}
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType,removeSlotCallback);
notificationManager.removeSlot(slotType, removeSlotCallback);
```
## notificationManager.removeSlot
......@@ -890,7 +892,7 @@ removeSlot(slotType: SlotType): Promise\<void\>
**示例：**
```ts
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType).then(() => {
console.info("removeSlot success");
});
......@@ -923,7 +925,7 @@ removeAllSlots(callback: AsyncCallback\<void\>): void
**示例：**
```ts
function removeAllCallBack(err) {
function removeAllCallBack(err: Base.BusinessError) {
if (err) {
console.error(`removeAllSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -993,17 +995,17 @@ setNotificationEnable(bundle: BundleOption, enable: boolean, callback: AsyncCall
**示例：**
```ts
function setNotificationEnablenCallback(err) {
function setNotificationEnableCallback(err: Base.BusinessError) {
if (err) {
console.error(`setNotificationEnablenCallback failed, code is ${err.code}, message is ${err.message}`);
console.error(`setNotificationEnableCallback failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setNotificationEnablenCallback success");
console.info("setNotificationEnableCallback success");
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.setNotificationEnable(bundle, false, setNotificationEnablenCallback);
notificationManager.setNotificationEnable(bundle, false, setNotificationEnableCallback);
```
## notificationManager.setNotificationEnable
......@@ -1039,7 +1041,7 @@ setNotificationEnable(bundle: BundleOption, enable: boolean): Promise\<void\>
**示例：**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.setNotificationEnable(bundle, false).then(() => {
......@@ -1080,16 +1082,18 @@ isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>):
**示例：**
```ts
function isNotificationEnabledCallback(err, data) {
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationEnabled success");
console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback);
```
......@@ -1131,10 +1135,10 @@ isNotificationEnabled(bundle: BundleOption): Promise\<boolean\>
**示例：**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isNotificationEnabled(bundle).then((data) => {
notificationManager.isNotificationEnabled(bundle).then((data: boolean) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -1170,11 +1174,11 @@ isNotificationEnabled(callback: AsyncCallback\<boolean\>): void
**示例：**
```ts
function isNotificationEnabledCallback(err, data) {
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationEnabled success");
console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
}
}
......@@ -1212,7 +1216,7 @@ isNotificationEnabled(): Promise\<boolean\>
**示例：**
```ts
notificationManager.isNotificationEnabled().then((data) => {
notificationManager.isNotificationEnabled().then((data: boolean) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -1250,15 +1254,15 @@ isNotificationEnabled(userId: number, callback: AsyncCallback\<boolean\>): void
**示例：**
```ts
function isNotificationEnabledCallback(err, data) {
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationEnabled success");
console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
}
}
let userId = 1;
let userId: number = 1;
notificationManager.isNotificationEnabled(userId, isNotificationEnabledCallback);
```
......@@ -1301,9 +1305,9 @@ isNotificationEnabled(userId: number): Promise\<boolean\>
**示例：**
```ts
let userId = 1;
let userId: number = 1;
notificationManager.isNotificationEnabled(userId).then((data) => {
notificationManager.isNotificationEnabled(userId).then((data: boolean) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -1342,14 +1346,14 @@ displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<voi
**示例：**
```ts
function displayBadgeCallback(err) {
function displayBadgeCallback(err: Base.BusinessError) {
if (err) {
console.error(`displayBadge failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("displayBadge success");
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.displayBadge(bundle, false, displayBadgeCallback);
......@@ -1388,7 +1392,7 @@ displayBadge(bundle: BundleOption, enable: boolean): Promise\<void\>
**示例：**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.displayBadge(bundle, false).then(() => {
......@@ -1413,7 +1417,7 @@ isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------ |
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是 | 指定应用的包信息。 |
| callback | AsyncCallback\<void\> | 是 | 获取角标使能状态回调函数。 |
| callback | AsyncCallback\<boolean\> | 是 | 获取角标使能状态回调函数。 |
**错误码：**
......@@ -1429,14 +1433,14 @@ isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>): void
**示例：**
```ts
function isBadgeDisplayedCallback(err, data) {
function isBadgeDisplayedCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isBadgeDisplayed success");
console.info(`isBadgeDisplayed success, data is ${JSON.stringify(data)}`);
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
......@@ -1480,10 +1484,11 @@ isBadgeDisplayed(bundle: BundleOption): Promise\<boolean\>
**示例：**
```ts
let bundle = {
bundle: "bundleName1",
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isBadgeDisplayed(bundle).then((data) => {
notificationManager.isBadgeDisplayed(bundle).then((data: boolean) => {
console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
});
```
......@@ -1514,7 +1519,8 @@ setBadgeNumber(badgeNumber: number): Promise\<void\>
**示例：**
```ts
let badgeNumber = 10
let badgeNumber: number = 10;
notificationManager.setBadgeNumber(badgeNumber).then(() => {
console.info("displayBadge success");
});
......@@ -1549,7 +1555,7 @@ setBadgeNumber(badgeNumber: number, callback: AsyncCallback\<void\>): void
**示例：**
```ts
function setBadgeNumberCallback(err) {
function setBadgeNumberCallback(err: Base.BusinessError) {
if (err) {
console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`);
} else {
......@@ -1557,7 +1563,7 @@ function setBadgeNumberCallback(err) {
}
}
let badgeNumber = 10
let badgeNumber: number = 10;
notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback);
```
......@@ -1595,17 +1601,17 @@ setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCal
**示例：**
```ts
function setSlotByBundleCallback(err) {
function setSlotByBundleCallback(err: Base.BusinessError) {
if (err) {
console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setSlotByBundle success");
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
......@@ -1644,12 +1650,14 @@ setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise\<void\>
**示例：**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
let notificationSlot = {
let notificationSlot: notificationManager.NotificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => {
console.info("setSlotByBundle success");
});
......@@ -1688,14 +1696,14 @@ getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback\<Array\<Notificat
**示例：**
```ts
function getSlotsByBundleCallback(err, data) {
function getSlotsByBundleCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>) {
if (err) {
console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlotsByBundle success");
console.info(`getSlotsByBundle success, data is ${JSON.stringify(data)}`);
}
}
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback);
......@@ -1739,10 +1747,11 @@ getSlotsByBundle(bundle: BundleOption): Promise\<Array\<NotificationSlot>>
**示例：**
```ts
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.getSlotsByBundle(bundle).then((data) => {
notificationManager.getSlotsByBundle(bundle).then((data: Array<notificationManager.NotificationSlot>) => {
console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
});
```
......@@ -1780,16 +1789,18 @@ getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>): voi
**示例：**
```ts
function getSlotNumByBundleCallback(err, data) {
function getSlotNumByBundleCallback(err: Base.BusinessError, data: number) {
if (err) {
console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlotNumByBundle success");
console.info(`getSlotNumByBundle success data is ${JSON.stringify(data)}`);
}
}
let bundle = {
bundle: "bundleName1",
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
```
......@@ -1831,10 +1842,11 @@ getSlotNumByBundle(bundle: BundleOption): Promise\<number\>
**示例：**
```ts
let bundle = {
bundle: "bundleName1",
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.getSlotNumByBundle(bundle).then((data) => {
notificationManager.getSlotNumByBundle(bundle).then((data: number) => {
console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
});
```
......@@ -1869,11 +1881,11 @@ getAllActiveNotifications(callback: AsyncCallback\<Array\<NotificationRequest>>)
**示例：**
```ts
function getAllActiveNotificationsCallback(err, data) {
function getAllActiveNotificationsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>) {
if (err) {
console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getAllActiveNotifications success");
console.info(`getAllActiveNotifications success, data is ${JSON.stringify(data)}`);
}
}
......@@ -1911,7 +1923,7 @@ getAllActiveNotifications(): Promise\<Array\<[NotificationRequest](js-apis-inner
**示例：**
```ts
notificationManager.getAllActiveNotifications().then((data) => {
notificationManager.getAllActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
});
```
......@@ -1943,11 +1955,11 @@ getActiveNotificationCount(callback: AsyncCallback\<number\>): void
**示例：**
```ts
function getActiveNotificationCountCallback(err, data) {
function getActiveNotificationCountCallback(err: Base.BusinessError, data: number) {
if (err) {
console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getActiveNotificationCount success");
console.info(`getActiveNotificationCount success, data is ${JSON.stringify(data)}`);
}
}
......@@ -1981,7 +1993,7 @@ getActiveNotificationCount(): Promise\<number\>
**示例：**
```ts
notificationManager.getActiveNotificationCount().then((data) => {
notificationManager.getActiveNotificationCount().then((data: number) => {
console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
});
```
......@@ -2013,7 +2025,7 @@ getActiveNotifications(callback: AsyncCallback\<Array\<NotificationRequest>>): v
**示例：**
```ts
function getActiveNotificationsCallback(err, data) {
function getActiveNotificationsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>) {
if (err) {
console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2051,7 +2063,7 @@ getActiveNotifications(): Promise\<Array\<[NotificationRequest](js-apis-inner-no
**示例：**
```ts
notificationManager.getActiveNotifications().then((data) => {
notificationManager.getActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
});
```
......@@ -2084,7 +2096,7 @@ cancelGroup(groupName: string, callback: AsyncCallback\<void\>): void
**示例：**
```ts
function cancelGroupCallback(err) {
function cancelGroupCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2092,7 +2104,7 @@ function cancelGroupCallback(err) {
}
}
let groupName = "GroupName";
let groupName: string = "GroupName";
notificationManager.cancelGroup(groupName, cancelGroupCallback);
```
......@@ -2124,7 +2136,7 @@ cancelGroup(groupName: string): Promise\<void\>
**示例：**
```ts
let groupName = "GroupName";
let groupName: string = "GroupName";
notificationManager.cancelGroup(groupName).then(() => {
console.info("cancelGroup success");
});
......@@ -2164,7 +2176,7 @@ removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCall
**示例：**
```ts
function removeGroupByBundleCallback(err) {
function removeGroupByBundleCallback(err: Base.BusinessError) {
if (err) {
console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2172,8 +2184,8 @@ function removeGroupByBundleCallback(err) {
}
}
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";
notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
```
......@@ -2211,8 +2223,9 @@ removeGroupByBundle(bundle: BundleOption, groupName: string): Promise\<void\>
**示例：**
```ts
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";
notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => {
console.info("removeGroupByBundle success");
});
......@@ -2251,7 +2264,7 @@ setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>): vo
**示例：**
```ts
function setDoNotDisturbDateCallback(err) {
function setDoNotDisturbDateCallback(err: Base.BusinessError) {
if (err) {
console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2259,7 +2272,7 @@ function setDoNotDisturbDateCallback(err) {
}
}
let doNotDisturbDate = {
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
......@@ -2300,7 +2313,7 @@ setDoNotDisturbDate(date: DoNotDisturbDate): Promise\<void\>
**示例：**
```ts
let doNotDisturbDate = {
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
......@@ -2346,7 +2359,7 @@ setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallb
**示例：**
```ts
function setDoNotDisturbDateCallback(err) {
function setDoNotDisturbDateCallback(err: Base.BusinessError) {
if (err) {
console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2354,13 +2367,13 @@ function setDoNotDisturbDateCallback(err) {
}
}
let doNotDisturbDate = {
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
let userId = 1;
let userId: number = 1;
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
```
......@@ -2399,13 +2412,13 @@ setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise\<void\>
**示例：**
```ts
let doNotDisturbDate = {
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
let userId = 1;
let userId: number = 1;
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
console.info("setDoNotDisturbDate success");
......@@ -2445,11 +2458,11 @@ getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>): void
**示例：**
```ts
function getDoNotDisturbDateCallback(err,data) {
function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) {
if (err) {
console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDoNotDisturbDate success");
console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
}
}
......@@ -2488,8 +2501,8 @@ getDoNotDisturbDate(): Promise\<DoNotDisturbDate\>
**示例：**
```ts
notificationManager.getDoNotDisturbDate().then((data) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
notificationManager.getDoNotDisturbDate().then((data: notificationManager.DoNotDisturbDate) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
});
```
......@@ -2528,15 +2541,15 @@ getDoNotDisturbDate(userId: number, callback: AsyncCallback\<DoNotDisturbDate\>)
**示例：**
```ts
function getDoNotDisturbDateCallback(err,data) {
function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) {
if (err) {
console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDoNotDisturbDate success");
console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
}
}
let userId = 1;
let userId: number = 1;
notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
```
......@@ -2580,9 +2593,9 @@ getDoNotDisturbDate(userId: number): Promise\<DoNotDisturbDate\>
**示例：**
```ts
let userId = 1;
let userId: number = 1;
notificationManager.getDoNotDisturbDate(userId).then((data) => {
notificationManager.getDoNotDisturbDate(userId).then((data: notificationManager.DoNotDisturbDate) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
});
```
......@@ -2617,7 +2630,7 @@ notificationManager.getDoNotDisturbDate(userId).then((data) => {
**示例：**
```ts
function isSupportDoNotDisturbModeCallback(err,data) {
function isSupportDoNotDisturbModeCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2659,7 +2672,7 @@ isSupportDoNotDisturbMode(): Promise\<boolean\>
**示例：**
```ts
notificationManager.isSupportDoNotDisturbMode().then((data) => {
notificationManager.isSupportDoNotDisturbMode().then((data: boolean) => {
console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
});
```
......@@ -2692,8 +2705,8 @@ isSupportTemplate(templateName: string, callback: AsyncCallback\<boolean\>): voi
**示例：**
```javascript
let templateName = 'process';
function isSupportTemplateCallback(err, data) {
let templateName: string = 'process';
function isSupportTemplateCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2737,9 +2750,9 @@ isSupportTemplate(templateName: string): Promise\<boolean\>
**示例：**
```javascript
let templateName = 'process';
let templateName: string = 'process';
notificationManager.isSupportTemplate(templateName).then((data) => {
notificationManager.isSupportTemplate(templateName).then((data: boolean) => {
console.info("isSupportTemplate success, data: " + JSON.stringify(data));
});
```
......@@ -2771,7 +2784,7 @@ requestEnableNotification(callback: AsyncCallback\<void\>): void
**示例：**
```javascript
function requestEnableNotificationCallback(err) {
function requestEnableNotificationCallback(err: Base.BusinessError) {
if (err) {
console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2808,7 +2821,76 @@ notificationManager.requestEnableNotification().then(() => {
});
```
## notificationManager.requestEnableNotification<sup>10+<sup>
requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback\<void\>): void
应用请求通知使能模态弹窗（Callback形式）。
**系统能力**：SystemCapability.Notification.Notification
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- |--------------------|
| context | UIAbilityContext | 是 | 通知弹窗绑定Ability的上下文。 |
| callback | AsyncCallback\<void\> | 是 | 应用请求通知使能的回调函数。 |
**错误码：**
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)。
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
**示例：**
```javascript
function requestEnableNotificationCallback(err) {
if (err) {
console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("requestEnableNotification success");
}
};
notificationManager.requestEnableNotification(globalThis.uicontext, requestEnableNotificationCallback);
```
## notificationManager.requestEnableNotification<sup>10+<sup>
requestEnableNotification(context: UIAbilityContext): Promise\<void\>
应用请求通知使能模态弹窗（Promise形式）。
**系统能力**：SystemCapability.Notification.Notification
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- |--------------------|
| context | UIAbilityContext | 是 | 通知弹窗绑定Ability的上下文。 |
**错误码：**
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)。
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
**示例：**
```javascript
notificationManager.requestEnableNotification(globalThis.uicontext).then(() => {
console.info("requestEnableNotification success");
});
```
## notificationManager.setDistributedEnable
......@@ -2843,7 +2925,7 @@ setDistributedEnable(enable: boolean, callback: AsyncCallback\<void\>): void
**示例：**
```javascript
function setDistributedEnableCallback(err) {
function setDistributedEnableCallback(err: Base.BusinessError) {
if (err) {
console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2851,7 +2933,7 @@ function setDistributedEnableCallback(err) {
}
};
let enable = true;
let enable: boolean = true;
notificationManager.setDistributedEnable(enable, setDistributedEnableCallback);
```
......@@ -2888,11 +2970,11 @@ setDistributedEnable(enable: boolean): Promise\<void>
**示例：**
```javascript
let enable = true;
let enable: boolean = true;
notificationManager.setDistributedEnable(enable).then(() => {
console.info("setDistributedEnable success");
});
console.info("setDistributedEnable success");
});
```
......@@ -2924,7 +3006,7 @@ isDistributedEnabled(callback: AsyncCallback\<boolean>): void
**示例：**
```javascript
function isDistributedEnabledCallback(err, data) {
function isDistributedEnabledCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -2966,7 +3048,7 @@ isDistributedEnabled(): Promise\<boolean>
```javascript
notificationManager.isDistributedEnabled()
.then((data) => {
.then((data: boolean) => {
console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -3007,7 +3089,7 @@ setDistributedEnableByBundle(bundle: BundleOption, enable: boolean, callback: As
**示例：**
```javascript
function setDistributedEnableByBundleCallback(err) {
function setDistributedEnableByBundleCallback(err: Base.BusinessError) {
if (err) {
console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3015,11 +3097,11 @@ function setDistributedEnableByBundleCallback(err) {
}
};
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
let enable = true
let enable: boolean = true;
notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback);
```
......@@ -3060,11 +3142,11 @@ setDistributedEnableByBundle(bundle: BundleOption, enable: boolean): Promise\<vo
**示例：**
```javascript
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
let enable = true
let enable: boolean = true;
notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => {
console.info("setDistributedEnableByBundle success");
......@@ -3105,7 +3187,7 @@ isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback\<bool
**示例：**
```javascript
function isDistributedEnabledByBundleCallback(err, data) {
function isDistributedEnabledByBundleCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isDistributedEnabledByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3113,7 +3195,7 @@ function isDistributedEnabledByBundleCallback(err, data) {
}
};
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
......@@ -3159,11 +3241,11 @@ isDistributedEnabledByBundle(bundle: BundleOption): Promise\<boolean>
**示例：**
```javascript
let bundle = {
let bundle: notificationManager.BundleOption = {
bundle: "bundleName1",
};
notificationManager.isDistributedEnabledByBundle(bundle).then((data) => {
notificationManager.isDistributedEnabledByBundle(bundle).then((data: boolean) => {
console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
});
```
......@@ -3200,11 +3282,11 @@ getDeviceRemindType(callback: AsyncCallback\<DeviceRemindType\>): void
**示例：**
```javascript
function getDeviceRemindTypeCallback(err, data) {
function getDeviceRemindTypeCallback(err: Base.BusinessError, data: notificationManager.DeviceRemindType) {
if (err) {
console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDeviceRemindType success");
console.info(`getDeviceRemindType success, data is ${JSON.stringify(data)}`);
}
};
......@@ -3242,7 +3324,7 @@ getDeviceRemindType(): Promise\<DeviceRemindType\>
**示例：**
```javascript
notificationManager.getDeviceRemindType().then((data) => {
notificationManager.getDeviceRemindType().then((data: notificationManager.DeviceRemindType) => {
console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
});
```
......@@ -3288,7 +3370,7 @@ publishAsBundle(request: NotificationRequest, representativeBundle: string, user
```ts
//publishAsBundle回调
function callback(err) {
function callback(err: Base.BusinessError) {
if (err) {
console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3296,11 +3378,11 @@ function callback(err) {
}
}
// 被代理应用的包名
let representativeBundle = "com.example.demo";
let representativeBundle: string = "com.example.demo";
// 用户ID
let userId = 100;
let userId: number = 100;
// NotificationRequest对象
let request = {
let request: notificationManager.NotificationRequest = {
id: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
......@@ -3355,11 +3437,11 @@ publishAsBundle(request: NotificationRequest, representativeBundle: string, user
```ts
// 被代理应用的包名
let representativeBundle = "com.example.demo";
let representativeBundle: string = "com.example.demo";
// 用户ID
let userId = 100;
let userId: number = 100;
// NotificationRequest对象
let request = {
let request: notificationManager.NotificationRequest = {
id: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
......@@ -3415,7 +3497,7 @@ cancelAsBundle(id: number, representativeBundle: string, userId: number, callbac
```ts
// cancelAsBundle
function cancelAsBundleCallback(err) {
function cancelAsBundleCallback(err: Base.BusinessError) {
if (err) {
console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3423,9 +3505,9 @@ function cancelAsBundleCallback(err) {
}
}
// 被代理应用的包名
let representativeBundle = "com.example.demo";
let representativeBundle: string = "com.example.demo";
// 用户ID
let userId = 100;
let userId: number = 100;
notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
```
......@@ -3468,9 +3550,9 @@ cancelAsBundle(id: number, representativeBundle: string, userId: number): Promis
```ts
// 被代理应用的包名
let representativeBundle = "com.example.demo";
let representativeBundle: string = "com.example.demo";
// 用户ID
let userId = 100;
let userId: number = 100;
notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => {
console.info("cancelAsBundle success");
......@@ -3513,7 +3595,7 @@ setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean,
```ts
// setNotificationEnableSlot
function setNotificationEnableSlotCallback(err) {
function setNotificationEnableSlotCallback(err: Base.BusinessError) {
if (err) {
console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3606,11 +3688,11 @@ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncC
```ts
// isNotificationSlotEnabled
function getEnableSlotCallback(err, data) {
function getEnableSlotCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationSlotEnabled success");
console.info(`isNotificationSlotEnabled success, data is ${JSON.stringify(data)}`);
}
};
......@@ -3661,7 +3743,7 @@ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise\<boolea
```ts
// isNotificationSlotEnabled
notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", },
notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data) => {
notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data: boolean) => {
console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data));
});
```
......@@ -3701,10 +3783,10 @@ setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback:
**示例：**
```ts
let userId = 100;
let enable = true;
let userId: number = 100;
let enable: boolean = true;
function callback(err) {
function callback(err: Base.BusinessError) {
if (err) {
console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
} else {
......@@ -3755,13 +3837,11 @@ setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise\<
**示例：**
```ts
let userId = 100;
let enable = true;
let userId: number = 100;
let enable: boolean = true;
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => {
console.info('setSyncNotificationEnabledWithoutApp success');
}).catch((err) => {
console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
});
```
......@@ -3799,9 +3879,9 @@ getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback\<bo
**示例：**
```ts
let userId = 100;
let userId: number = 100;
function getSyncNotificationEnabledWithoutAppCallback(err, data) {
function getSyncNotificationEnabledWithoutAppCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err);
} else {
......@@ -3851,11 +3931,10 @@ getSyncNotificationEnabledWithoutApp(userId: number): Promise\<boolean>
**示例：**
```ts
let userId = 100;
notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => {
console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
}).catch((err) => {
console.info('getSyncNotificationEnabledWithoutApp, err:' + err);
let userId: number = 100;
notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data: boolean) => {
console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
});
```
......@@ -3897,9 +3976,11 @@ try{
function OnCheckNotification(info : notificationManager.NotificationCheckInfo) {
console.info(`====>OnCheckNotification info: ${JSON.stringify(info)}`);
if(info.notificationId == 1){
return { code: 1, message: "testMsg1"}
let result: notificationManager.NotificationCheckResult = { code: 1, message: "testMsg1"};
return result;
} else {
return { code: 0, message: "testMsg0"}
let result: notificationManager.NotificationCheckResult = { code: 0, message: "testMsg0"};
return result;
}
}
```
......
zh-cn/application-dev/reference/apis/js-apis-system-notification.md
浏览文件 @ 1743c481
......@@ -50,18 +50,24 @@ show(options?: ShowNotificationOptions): void
| options | ShowNotificationOptions | 否 | 通知标题。 |
**示例：**
```javascript
export default {
show() {
notification.show({
contentTitle: 'title info',
contentText: 'text',
clickAction: {
bundleName: 'com.example.testapp',
abilityName: 'notificationDemo',
uri: '/path/to/notification'
}
});
}
```ts
class NotificationClass {
show: Function
}
let notificationObj: NotificationClass = {
show() {
notification.show({
contentTitle: 'title info',
contentText: 'text',
clickAction: {
bundleName: 'com.example.testapp',
abilityName: 'notificationDemo',
uri: '/path/to/notification'
}
});
}
}
export default notificationObj
```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或