Ai
46 Star 180 Fork 4.8K

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.notification.d.ts 64.48 KB
一键复制 编辑 原始数据 按行查看 历史
lzy1299 提交于 2023-12-22 14:01 +08:00 . 事件通知kit化
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762
/*
* Copyright (c) 2021-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AsyncCallback } from './@ohos.base';
import { NotificationActionButton } from './notification/notificationActionButton';
import { NotificationBasicContent } from './notification/notificationContent';
import { NotificationContent } from './notification/notificationContent';
import { NotificationLongTextContent } from './notification/notificationContent';
import { NotificationMultiLineContent } from './notification/notificationContent';
import { NotificationPictureContent } from './notification/notificationContent';
import { NotificationFlags } from './notification/notificationFlags';
import { NotificationFlagStatus } from './notification/notificationFlags';
import { NotificationRequest } from './notification/notificationRequest';
import { DistributedOptions } from './notification/notificationRequest';
import { NotificationSlot } from './notification/notificationSlot';
import { NotificationSorting } from './notification/notificationSorting';
import { NotificationSubscribeInfo } from './notification/notificationSubscribeInfo';
import { NotificationSubscriber } from './notification/notificationSubscriber';
import { SubscribeCallbackData } from './notification/notificationSubscriber';
import { EnabledNotificationCallbackData } from './notification/notificationSubscriber';
import { NotificationTemplate } from './notification/notificationTemplate';
import { NotificationUserInput } from './notification/notificationUserInput';
/**
* Manages notifications.
* <p>Generally, only system applications have permissions on notification subscription and unsubscribe.
* You can specify the content of a notification to be published and the content is carried by
* {@link NotificationRequest}. A notification ID is unique in an application and must be specified
* when using {@link NotificationRequest} to carry the notification content. If a notification
* with this ID has been published and you need to use this ID to publish another notification,
* the original notification will be updated. In addition, the notification ID can be used to cancel
* a notification by calling the {@link #cancel(int)} method.
*
* @namespace notification
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager and ohos.notificationSubscribe/notificationSubscribe
*/
declare namespace notification {
/**
* Publishes a notification.
* <p>If a notification with the same ID has been published by the current application and has not been deleted,
* this method will update the notification.
*
* @param { NotificationRequest } request - notification request
* @param { AsyncCallback<void> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#publish
*/
function publish(request: NotificationRequest, callback: AsyncCallback<void>): void;
/**
* Publishes a notification.
* <p>If a notification with the same ID has been published by the current application and has not been deleted,
* this method will update the notification.
*
* @param { NotificationRequest } request - notification request
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#publish
*/
function publish(request: NotificationRequest): Promise<void>;
/**
* Publishes a notification to the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationRequest } request - Publishes a notification.
* @param { number } userId - of subscriber receiving the notification
* @param { AsyncCallback<void> } callback - Callback method for publishing notifications.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#publish
*/
function publish(request: NotificationRequest, userId: number, callback: AsyncCallback<void>): void;
/**
* Publishes a notification to the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationRequest } request - Publishes a notification.
* @param { number } userId - of subscriber receiving the notification
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#publish
*/
function publish(request: NotificationRequest, userId: number): Promise<void>;
/**
* Cancel a notification with the specified ID.
*
* @param { number } id - of the notification to cancel, which must be unique in the application.
* @param { AsyncCallback<void> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#cancel
*/
function cancel(id: number, callback: AsyncCallback<void>): void;
/**
* Cancel a notification with the specified label and ID.
*
* @param { number } id - ID of the notification to cancel, which must be unique in the application.
* @param { string } label - Label of the notification to cancel.
* @param { AsyncCallback<void> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#cancel
*/
function cancel(id: number, label: string, callback: AsyncCallback<void>): void;
/**
* Cancel a notification with the specified label and ID.
*
* @param { number } id - ID of the notification to cancel, which must be unique in the application.
* @param { string } [label] - Label of the notification to cancel.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#cancel
*/
function cancel(id: number, label?: string): Promise<void>;
/**
* Cancels all notifications of the current application.
*
* @param { AsyncCallback<void> } callback - The specified callback method.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#cancelAll
*/
function cancelAll(callback: AsyncCallback<void>): void;
/**
* Cancels all notifications of the current application.
*
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#cancelAll
*/
function cancelAll(): Promise<void>;
/**
* Creates a notification slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSlot } slot - Indicates the notification slot to be created, which is set by
* {@link NotificationSlot}.This parameter must be specified.
* @param { AsyncCallback<void> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#addSlot
*/
function addSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void;
/**
* Creates a notification slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSlot } slot - Indicates the notification slot to be created, which is set by
* {@link NotificationSlot}.This parameter must be specified.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#addSlot
*/
function addSlot(slot: NotificationSlot): Promise<void>;
/**
* Adds a slot type.
*
* @param { SlotType } type - Slot type to add.
* @param { AsyncCallback<void> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#addSlot
*/
function addSlot(type: SlotType, callback: AsyncCallback<void>): void;
/**
* Adds a slot type.
*
* @param { SlotType } type - Slot type to add.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#addSlot
*/
function addSlot(type: SlotType): Promise<void>;
/**
* Creates a notification slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<NotificationSlot> } slots - Indicates the notification slots to be created, which is set by
* {@link NotificationSlot}.This parameter must be specified.
* @param { AsyncCallback<void> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#addSlots
*/
function addSlots(slots: Array<NotificationSlot>, callback: AsyncCallback<void>): void;
/**
* Creates a notification slot.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<NotificationSlot> } slots - Indicates the notification slots to be created, which is set by
* {@link NotificationSlot}.This parameter must be specified.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#addSlots
*/
function addSlots(slots: Array<NotificationSlot>): Promise<void>;
/**
* Obtains a notification slot of the specified slot type.
*
* @param { SlotType } slotType - Type of the notification slot to obtain.
* @param { AsyncCallback<NotificationSlot> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getSlot
*/
function getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>): void;
/**
* Obtains a notification slot of the specified slot type.
*
* @param { SlotType } slotType - Type of the notification slot to obtain.
* @returns { Promise<NotificationSlot> } Returns the created {@link NotificationSlot}.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getSlot
*/
function getSlot(slotType: SlotType): Promise<NotificationSlot>;
/**
* Obtains all NotificationSlot objects created by the current application.
*
* @param { AsyncCallback<Array<NotificationSlot>> } callback - Returns the result of obtaining all notification
* channels for this application in the form of callback.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getSlots
*/
function getSlots(callback: AsyncCallback<Array<NotificationSlot>>): void;
/**
* Obtains all NotificationSlot objects created by the current application.
*
* @returns { Promise<Array<NotificationSlot>> } Returns all notification slots of this application.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getSlots
*/
function getSlots(): Promise<Array<NotificationSlot>>;
/**
* Removes a NotificationSlot of the specified SlotType created by the current application.
*
* @param { SlotType } slotType - Type of the NotificationSlot to remove.
* @param { AsyncCallback<void> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#removeSlot
*/
function removeSlot(slotType: SlotType, callback: AsyncCallback<void>): void;
/**
* Removes a NotificationSlot of the specified SlotType created by the current application.
*
* @param { SlotType } slotType - The types of notification channels are currently divided into social communication,
* service reminders, content consulting, and other types
* @returns { Promise<void> } Returns all notification slots of this application.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#removeSlot
*/
function removeSlot(slotType: SlotType): Promise<void>;
/**
* Removes all NotificationSlot objects created by the current application.
*
* @param { AsyncCallback<void> } callback - Represents the specified callback method.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#removeAllSlots
*/
function removeAllSlots(callback: AsyncCallback<void>): void;
/**
* Removes all NotificationSlot objects created by the current application.
*
* @returns { Promise<void> } Returns all notification slots of this application.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#removeAllSlots
*/
function removeAllSlots(): Promise<void>;
/**
* Describes NotificationSlot types.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#SlotType
*/
export enum SlotType {
/**
* NotificationSlot of an unknown type.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotType#UNKNOWN_TYPE
*/
UNKNOWN_TYPE = 0,
/**
* NotificationSlot for social communication.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotType#SOCIAL_COMMUNICATION
*/
SOCIAL_COMMUNICATION = 1,
/**
* NotificationSlot for service information.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotType#SERVICE_INFORMATION
*/
SERVICE_INFORMATION = 2,
/**
* NotificationSlot for content information.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotType#CONTENT_INFORMATION
*/
CONTENT_INFORMATION = 3,
/**
* NotificationSlot for other purposes.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotType#OTHER_TYPES
*/
OTHER_TYPES = 0xFFFF
}
/**
* Describes notification content types.
*
* @enum { string }
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotType#ContentType
*/
export enum ContentType {
/**
* Normal text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.ContentType#NOTIFICATION_CONTENT_BASIC_TEXT
*/
NOTIFICATION_CONTENT_BASIC_TEXT,
/**
* Long text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.ContentType#NOTIFICATION_CONTENT_LONG_TEXT
*/
NOTIFICATION_CONTENT_LONG_TEXT,
/**
* Picture-attached notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.ContentType#NOTIFICATION_CONTENT_PICTURE
*/
NOTIFICATION_CONTENT_PICTURE,
/**
* Conversation notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.ContentType#NOTIFICATION_CONTENT_CONVERSATION
*/
NOTIFICATION_CONTENT_CONVERSATION,
/**
* Multi-line text notification.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.ContentType#NOTIFICATION_CONTENT_MULTILINE
*/
NOTIFICATION_CONTENT_MULTILINE
}
/**
* Indicates the level of the slot
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#SlotLevel
*/
export enum SlotLevel {
/**
* Indicates that the notification function is disabled.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotLevel#LEVEL_NONE
*/
LEVEL_NONE = 0,
/**
* Indicates that the notification function is enabled but notification
* icons are not displayed in the status bar, with no banner or prompt tone.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotLevel#LEVEL_MIN
*/
LEVEL_MIN = 1,
/**
* Indicates that the notification function is enabled and notification
* icons are displayed in the status bar, with no banner or prompt tone.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotLevel#LEVEL_LOW
*/
LEVEL_LOW = 2,
/**
* Indicates that the notification function is enabled and notification
* icons are displayed in the status bar, with no banner but with a prompt tone.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotLevel#LEVEL_DEFAULT
*/
LEVEL_DEFAULT = 3,
/**
* Indicates that the notification function is enabled and notification
* icons are displayed in the status bar, with a banner and a prompt tone.
*
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SlotLevel#LEVEL_HIGH
*/
LEVEL_HIGH = 4
}
/**
* subscribe
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - Notification subscription object.
* @param { AsyncCallback<void> } callback - Subscription action callback parameters.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#subscribe
*/
function subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void;
/**
* subscribe
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - Notification subscription object.
* @param { NotificationSubscribeInfo } info - Notification subscription information.
* @param { AsyncCallback<void> } callback - Subscription Action Callback Function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#subscribe
*/
function subscribe(
subscriber: NotificationSubscriber,
info: NotificationSubscribeInfo,
callback: AsyncCallback<void>
): void;
/**
* subscribe
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - Notification subscription object.
* @param { NotificationSubscribeInfo } [info] - Notification subscription information.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#subscribe
*/
function subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): Promise<void>;
/**
* unsubscribe
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - Notification subscription object.
* @param { AsyncCallback<void> } callback - Unsubscribe Action Callback Function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#unsubscribe
*/
function unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void;
/**
* unsubscribe
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - Subscription action callback parameters.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#unsubscribe
*/
function unsubscribe(subscriber: NotificationSubscriber): Promise<void>;
/**
* enableNotification
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { boolean } enable - Enabling state.
* @param { AsyncCallback<void> } callback - Set notification enable callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setNotificationEnable
*/
function enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void;
/**
* enableNotification
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { boolean } enable - Enabling state.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setNotificationEnable
*/
function enableNotification(bundle: BundleOption, enable: boolean): Promise<void>;
/**
* isNotificationEnabled
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { AsyncCallback<boolean> } callback - Get notification enable callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isNotificationEnabled
*/
function isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback<boolean>): void;
/**
* isNotificationEnabled
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @returns { Promise<boolean> } Returns the result of obtaining notification enable status in the form of Promise.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isNotificationEnabled
*/
function isNotificationEnabled(bundle: BundleOption): Promise<boolean>;
/**
* isNotificationEnabled
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<boolean> } callback - Get notification enable callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isNotificationEnabled
*/
function isNotificationEnabled(callback: AsyncCallback<boolean>): void;
/**
* isNotificationEnabled
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<boolean> } Returns the result of obtaining notification enable status in the form of Promise.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isNotificationEnabled
*/
function isNotificationEnabled(): Promise<boolean>;
/**
* Checks whether this application has permission to publish notifications under the user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - userId
* @param { AsyncCallback<boolean> } callback - Get notification enable callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isNotificationEnabled
*/
function isNotificationEnabled(userId: number, callback: AsyncCallback<boolean>): void;
/**
* Checks whether this application has permission to publish notifications under the user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - userId
* @returns { Promise<boolean> } Returns the result of obtaining notification enable status in the form of Promise.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isNotificationEnabled
*/
function isNotificationEnabled(userId: number): Promise<boolean>;
/**
* displayBadge
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { boolean } enable - Enabling state.
* @param { AsyncCallback<void> } callback - Set the corner marker enable callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#displayBadge
*/
function displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void;
/**
* displayBadge
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { boolean } enable - Enabling state.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#displayBadge
*/
function displayBadge(bundle: BundleOption, enable: boolean): Promise<void>;
/**
* isBadgeDisplayed
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { AsyncCallback<boolean> } callback - Set the corner marker enable callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isBadgeDisplayed
*/
function isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback<boolean>): void;
/**
* isBadgeDisplayed
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @returns { Promise<boolean> } Returns the result of obtaining notification enable status in the form of Promise.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isBadgeDisplayed
*/
function isBadgeDisplayed(bundle: BundleOption): Promise<boolean>;
/**
* setSlotByBundle
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { NotificationSlot } slot - Notification channel.
* @param { AsyncCallback<void> } callback - Set notification channel callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setSlotByBundle
*/
function setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback<void>): void;
/**
* setSlotByBundle
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { NotificationSlot } slot - Notification channel.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setSlotByBundle
*/
function setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise<void>;
/**
* getSlotsByBundle
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { AsyncCallback<Array<NotificationSlot>> } callback - Set the corner marker enable callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getSlotsByBundle
*/
function getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array<NotificationSlot>>): void;
/**
* getSlotsByBundle
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @returns { Promise<Array<NotificationSlot>> } Returns the notification channel of the specified application in
* the form of a promise.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getSlotsByBundle
*/
function getSlotsByBundle(bundle: BundleOption): Promise<Array<NotificationSlot>>;
/**
* getSlotNumByBundle
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { AsyncCallback<number> } callback - Set the corner marker enable callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getSlotNumByBundle
*/
function getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback<number>): void;
/**
* getSlotNumByBundle
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @returns { Promise<number> } Returns the number of notification channels for the specified application
* in the form of Promise.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getSlotNumByBundle
*/
function getSlotNumByBundle(bundle: BundleOption): Promise<number>;
/**
* remove
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { NotificationKey } notificationKey - Notification Key Value
* @param { RemoveReason } reason - Reason for notification deletion.
* @param { AsyncCallback<void> } callback - Delete the specified notification callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#remove
*/
function remove(
bundle: BundleOption,
notificationKey: NotificationKey,
reason: RemoveReason,
callback: AsyncCallback<void>
): void;
/**
* remove
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { NotificationKey } notificationKey - Notification Key Value
* @param { RemoveReason } reason - Reason for notification deletion.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#remove
*/
function remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason): Promise<void>;
/**
* remove
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } hashCode - The unique ID of the notification can be obtained through the input parameter
* SubscribeCallbackData of the onConsumer callback to obtain the hashCode in its internal NotificationRequest object
* @param { RemoveReason } reason - Reason for notification deletion.
* @param { AsyncCallback<void> } callback - Delete the specified notification callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#remove
*/
function remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback<void>): void;
/**
* remove
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } hashCode - Notification unique ID.
* @param { RemoveReason } reason - Reason for notification deletion.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#remove
*/
function remove(hashCode: string, reason: RemoveReason): Promise<void>;
/**
* removeAll
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { AsyncCallback<void> } callback - Delete the specified notification callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#removeAll
*/
function removeAll(bundle: BundleOption, callback: AsyncCallback<void>): void;
/**
* removeAll
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<void> } callback - Delete the specified notification callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#removeAll
*/
function removeAll(callback: AsyncCallback<void>): void;
/**
* Remove all notifications under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - userId
* @param { AsyncCallback<void> } callback - Delete the specified notification callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#removeAll
*/
function removeAll(userId: number, callback: AsyncCallback<void>): void;
/**
* Remove all notifications under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - userId
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#removeAll
*/
function removeAll(userId: number): Promise<void>;
/**
* removeAll
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } [bundle] - Specify the package information for the application.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#removeAll
*/
function removeAll(bundle?: BundleOption): Promise<void>;
/**
* Obtains all active notifications in the current system. The caller must have system permissions to
* call this method.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<Array<NotificationRequest>> } callback - Gets the activity notification callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getAllActiveNotifications
*/
function getAllActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void;
/**
* Obtains all active notifications in the current system. The caller must have system permissions to
* call this method.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<Array<NotificationRequest>> } Return in the form of Promise to obtain activity notifications.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getAllActiveNotifications
*/
function getAllActiveNotifications(): Promise<Array<NotificationRequest>>;
/**
* Obtains the number of all active notifications.
*
* @param { AsyncCallback<number> } callback - Callback function to obtain the number of undelete notifications.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getActiveNotificationCount
*/
function getActiveNotificationCount(callback: AsyncCallback<number>): void;
/**
* Obtains the number of all active notifications.
*
* @returns { Promise<number> } Returns the number of undelete notifications for the current application as promise.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getActiveNotificationCount
*/
function getActiveNotificationCount(): Promise<number>;
/**
* Obtains an array of active notifications.
*
* @param { AsyncCallback<Array<NotificationRequest>> } callback - Retrieve the callback function for the current
* application notification list.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getActiveNotifications
*/
function getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void;
/**
* Obtains an array of active notifications.
*
* @returns { Promise<Array<NotificationRequest>> } Return to obtain the current application in the form of Promise.
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getActiveNotifications
*/
function getActiveNotifications(): Promise<Array<NotificationRequest>>;
/**
* Cancel the notification of a specified group for this application.
*
* @param { string } groupName - Notification group name, which needs to be specified through the NotificationRequest
* object when publishing notifications.
* @param { AsyncCallback<void> } callback - Cancel the callback function for notifications under the specified group
* of this application.
* @syscap SystemCapability.Notification.Notification
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#cancelGroup
*/
function cancelGroup(groupName: string, callback: AsyncCallback<void>): void;
/**
* Cancel the notification of a specified group for this application.
*
* @param { string } groupName - Notification group name.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#cancelGroup
*/
function cancelGroup(groupName: string): Promise<void>;
/**
* Delete the notification of a specified group for this application.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { string } groupName - Notification group name.
* @param { AsyncCallback<void> } callback - Delete the specified notification callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#removeGroupByBundle
*/
function removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback<void>): void;
/**
* Delete the notification of a specified group for this application.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Specify the package information for the application.
* @param { string } groupName - Notification group name.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#removeGroupByBundle
*/
function removeGroupByBundle(bundle: BundleOption, groupName: string): Promise<void>;
/**
* Set the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - Disturbance free time option.
* @param { AsyncCallback<void> } callback - Set the undisturbed time callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setDoNotDisturbDate
*/
function setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback<void>): void;
/**
* Set the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - Disturbance free time option.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setDoNotDisturbDate
*/
function setDoNotDisturbDate(date: DoNotDisturbDate): Promise<void>;
/**
* Set the Do Not Disturb date under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - Disturbance free time option.
* @param { number } userId - userId
* @param { AsyncCallback<void> } callback - Set the undisturbed time callback function
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setDoNotDisturbDate
*/
function setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallback<void>): void;
/**
* Set the Do Not Disturb date under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { DoNotDisturbDate } date - Disturbance free time option.
* @param { number } userId - userId
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setDoNotDisturbDate
*/
function setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise<void>;
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<DoNotDisturbDate> } callback - Query the undisturbed time callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getDoNotDisturbDate
*/
function getDoNotDisturbDate(callback: AsyncCallback<DoNotDisturbDate>): void;
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<DoNotDisturbDate> } Return in the form of Promise to obtain the queried uninterrupted time.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getDoNotDisturbDate
*/
function getDoNotDisturbDate(): Promise<DoNotDisturbDate>;
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - userId
* @param { AsyncCallback<DoNotDisturbDate> } callback - Query the undisturbed time callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getDoNotDisturbDate
*/
function getDoNotDisturbDate(userId: number, callback: AsyncCallback<DoNotDisturbDate>): void;
/**
* Obtains the Do Not Disturb date.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - userId
* @returns { Promise<DoNotDisturbDate> } Return in the form of Promise to obtain the queried uninterrupted time.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getDoNotDisturbDate
*/
function getDoNotDisturbDate(userId: number): Promise<DoNotDisturbDate>;
/**
* Obtains whether to support the Do Not Disturb mode.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<boolean> } callback - Check if callback function for anti-interference function is supported.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isSupportDoNotDisturbMode
*/
function supportDoNotDisturbMode(callback: AsyncCallback<boolean>): void;
/**
* Obtains whether to support the Do Not Disturb mode.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<boolean> } Return the result in the form of Promise to obtain whether the anti-interference
* function is supported.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isSupportDoNotDisturbMode
*/
function supportDoNotDisturbMode(): Promise<boolean>;
/**
* Obtains whether the template is supported by the system.
*
* @param { string } templateName - Name of template to be Obtained
* @param { AsyncCallback<boolean> } callback - callback function
* @syscap SystemCapability.Notification.Notification
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isSupportTemplate
*/
function isSupportTemplate(templateName: string, callback: AsyncCallback<boolean>): void;
/**
* Obtains whether the template is supported by the system.
*
* @param { string } templateName - Name of template to be Obtained
* @returns { Promise<boolean> } The Promise method returns the result of whether the template exists.
* @syscap SystemCapability.Notification.Notification
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isSupportTemplate
*/
function isSupportTemplate(templateName: string): Promise<boolean>;
/**
* Request permission to send notification.
*
* @param { AsyncCallback<void> } callback - Application Request Notification Enable Callback Function.
* @syscap SystemCapability.Notification.Notification
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#requestEnableNotification
*/
function requestEnableNotification(callback: AsyncCallback<void>): void;
/**
* Request permission to send notification.
*
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#requestEnableNotification
*/
function requestEnableNotification(): Promise<void>;
/**
* Sets whether the device supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { boolean } enable - support or not.
* @param { AsyncCallback<void> } callback - Set whether the device supports callback functions for distributed notifications.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setDistributedEnable
*/
function enableDistributed(enable: boolean, callback: AsyncCallback<void>): void;
/**
* Sets whether the device supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { boolean } enable - support or not.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setDistributedEnable
*/
function enableDistributed(enable: boolean): Promise<void>;
/**
* Obtains whether the device supports distributed notification.
*
* @param { AsyncCallback<boolean> } callback - Set whether the device supports callback functions for distributed
* notifications.
* @syscap SystemCapability.Notification.Notification
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isDistributedEnabled
*/
function isDistributedEnabled(callback: AsyncCallback<boolean>): void;
/**
* Obtains whether the device supports distributed notification.
*
* @returns { Promise<boolean> } Returns the result of obtaining whether distributed notifications are supported in
* the form of Promise.
* @syscap SystemCapability.Notification.Notification
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isDistributedEnabled
*/
function isDistributedEnabled(): Promise<boolean>;
/**
* Sets whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - Package information for the application.
* @param { boolean } enable - support or not.
* @param { AsyncCallback<void> } callback - Does application support callback functions for distributed notifications.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setDistributedEnableByBundle
*/
function enableDistributedByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void;
/**
* Sets whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - package of application.
* @param { boolean } enable - support or not.
* @returns { Promise<void> } the promise returned by the function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#setDistributedEnableByBundle
*/
function enableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise<void>;
/**
* Obtains whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - package of application.
* @param { AsyncCallback<boolean> } callback - Query whether callback function for distributed notifications
* is supported.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isDistributedEnabledByBundle
*/
function isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback<boolean>): void;
/**
* Obtains whether an application supports distributed notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - package of application.
* @returns { Promise<boolean> } The Promise method returns the result of whether the specified application supports
* distributed notifications.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#isDistributedEnabledByBundle
*/
function isDistributedEnabledByBundle(bundle: BundleOption): Promise<boolean>;
/**
* Obtains the remind modes of the notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<DeviceRemindType> } callback - Get notification reminder callback function.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getDeviceRemindType
*/
function getDeviceRemindType(callback: AsyncCallback<DeviceRemindType>): void;
/**
* Obtains the remind modes of the notification.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @returns { Promise<DeviceRemindType> } The Promise method returns the result of the notification reminder method.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#getDeviceRemindType
*/
function getDeviceRemindType(): Promise<DeviceRemindType>;
/**
* Describes a BundleOption.
*
* @typedef BundleOption
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#BundleOption
*/
export interface BundleOption {
/**
* bundle name.
*
* @type { string }
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#BundleOption
*/
bundle: string;
/**
* user id.
*
* @type { ?number }
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#BundleOption
*/
uid?: number;
}
/**
* Describes a NotificationKey, which can be used to identify a notification.
*
* @typedef NotificationKey
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#NotificationKey
*/
export interface NotificationKey {
/**
* Notify ID.
*
* @type { number }
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#NotificationKey
*/
id: number;
/**
* Notification label.
*
* @type { ?string }
* @syscap SystemCapability.Notification.Notification
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#NotificationKey
*/
label?: string;
}
/**
* The type of the Do Not Disturb.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#DoNotDisturbType
*/
export enum DoNotDisturbType {
/**
* Non do not disturb type notification
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DoNotDisturbType#TYPE_NONE
*/
TYPE_NONE = 0,
/**
* Execute do not disturb once in the set time period (only watch hours and minutes)
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DoNotDisturbType#TYPE_ONCE
*/
TYPE_ONCE = 1,
/**
* Execute do not disturb every day with a set time period (only watch hours and minutes)
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DoNotDisturbType#TYPE_DAILY
*/
TYPE_DAILY = 2,
/**
* Execute in the set time period (specify the time, month, day and hour)
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DoNotDisturbType#TYPE_CLEARLY
*/
TYPE_CLEARLY = 3
}
/**
* Describes a DoNotDisturbDate instance.
*
* @typedef DoNotDisturbDate
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#DoNotDisturbDate
*/
export interface DoNotDisturbDate {
/**
* the type of the Do Not Disturb.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DoNotDisturbDate#type
*/
type: DoNotDisturbType;
/**
* the start time of the Do Not Disturb.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DoNotDisturbDate#begin
*/
begin: Date;
/**
* the end time of the Do Not Disturb.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DoNotDisturbDate#end
*/
end: Date;
}
/**
* The remind type of the notification.
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#DeviceRemindType
*/
export enum DeviceRemindType {
/**
* The device is not in use, no reminder
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DeviceRemindType#IDLE_DONOT_REMIND
*/
IDLE_DONOT_REMIND = 0,
/**
* The device is not in use, remind
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DeviceRemindType#IDLE_REMIND
*/
IDLE_REMIND = 1,
/**
* The device is in use, no reminder
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DeviceRemindType#ACTIVE_DONOT_REMIND
*/
ACTIVE_DONOT_REMIND = 2,
/**
* The device is in use, reminder
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.DeviceRemindType#ACTIVE_REMIND
*/
ACTIVE_REMIND = 3
}
/**
* Notification source type
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager#SourceType
*/
export enum SourceType {
/**
* General notification
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SourceType#TYPE_NORMAL
*/
TYPE_NORMAL = 0,
/**
* Continuous notification
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SourceType#TYPE_CONTINUOUS
*/
TYPE_CONTINUOUS = 1,
/**
* Scheduled notification
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.notificationManager/notificationManager.SourceType#TYPE_TIMER
*/
TYPE_TIMER = 2
}
/**
* Reason for remove a notification
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe#RemoveReason
*/
export enum RemoveReason {
/**
* Notification clicked notification on the status bar.
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe.RemoveReason#CLICK_REASON_REMOVE
*/
CLICK_REASON_REMOVE = 1,
/**
* User dismissal notification on the status bar
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 7
* @deprecated since 9
* @useinstead ohos.notificationSubscribe/notificationSubscribe.RemoveReason#CANCEL_REASON_REMOVE
*/
CANCEL_REASON_REMOVE = 2
}
}
export default notification;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助