46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

Create your Gitee Account
Explore and code with more than 13.5 million developers,Free private repositories !:)
Sign up
文件
Clone or Download
@ohos.notificationSubscribe.d.ts 27.18 KB
Copy Edit Raw Blame History
185******37 authored 21 days ago . update
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645
/*
* Copyright (c) 2022-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.
*/
/**
* @file
* @kit NotificationKit
*/
import { AsyncCallback } from './@ohos.base';
import { BundleOption as _BundleOption } from './notification/NotificationCommonDef';
import { NotificationSubscribeInfo as _NotificationSubscribeInfo } from './notification/notificationSubscribeInfo';
import { NotificationSubscriber as _NotificationSubscriber } from './notification/notificationSubscriber';
import { SubscribeCallbackData as _SubscribeCallbackData } from './notification/notificationSubscriber';
import { EnabledNotificationCallbackData as _EnabledNotificationCallbackData } from './notification/notificationSubscriber';
/*** if arkts 1.1 */
import type { BadgeNumberCallbackData as _BadgeNumberCallbackData } from './notification/notificationSubscriber';
/*** endif */
/*** if arkts 1.2 */
import type { BadgeNumberCallbackData as _BadgeNumberCallbackData } from './notification/notificationSubscriber';
/*** endif */
/**
* @namespace notificationSubscribe
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace notificationSubscribe {
/**
* Describes a NotificationKey, which can be used to identify a notification.
*
* @typedef NotificationKey
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface NotificationKey {
/**
* Notify ID.
*
* @type { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
id: number;
/**
* Notification label.
*
* @type { ?string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
label?: string;
}
/**
* Reason for remove a notification
*
* @enum { number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export enum RemoveReason {
/**
* Notification clicked notification on the status bar
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
CLICK_REASON_REMOVE = 1,
/**
* User dismissal notification on the status bar
*
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
CANCEL_REASON_REMOVE = 2
}
/**
* Subscribe to notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - The notification subscriber.
* @param { AsyncCallback<void> } callback - The callback of subscribe.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void;
/**
* Subscribe self notifications.
*
* @param { NotificationSubscriber } subscriber - The notification subscriber.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 11
*/
function subscribeSelf(subscriber: NotificationSubscriber): Promise<void>;
/**
* Subscribe to notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - The notification subscriber.
* @param { NotificationSubscribeInfo } info - The notification subscribe info.
* @param { AsyncCallback<void> } callback - The callback of subscribe.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function subscribe(
subscriber: NotificationSubscriber,
info: NotificationSubscribeInfo,
callback: AsyncCallback<void>
): void;
/**
* Subscribe to notifications
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - The notification subscriber.
* @param { NotificationSubscribeInfo } [info] - The notification subscribe info.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600012 - No memory space.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): Promise<void>;
/**
* Unsubscribe notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - The notification subscriber.
* @param { AsyncCallback<void> } callback - The callback of unsubscribe.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Unsubscribe notifications.
*
* @param { NotificationSubscriber } subscriber - The notification subscriber.
* @param { AsyncCallback<void> } callback - The callback of unsubscribe.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
function unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void;
/**
* Unsubscribe notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { NotificationSubscriber } subscriber - The notification subscriber.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
/**
* Unsubscribe notifications.
*
* @param { NotificationSubscriber } subscriber - The notification subscriber.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
function unsubscribe(subscriber: NotificationSubscriber): Promise<void>;
/**
* Remove notification based on BundleOption and NotificationKey.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { NotificationKey } notificationKey - The notification key.
* @param { RemoveReason } reason - The remove reason.
* @param { AsyncCallback<void> } callback - The callback of remove.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function remove(
bundle: BundleOption,
notificationKey: NotificationKey,
reason: RemoveReason,
callback: AsyncCallback<void>
): void;
/**
* Remove notification based on BundleOption and NotificationKey.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { NotificationKey } notificationKey - The notification key.
* @param { RemoveReason } reason - The remove reason.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason): Promise<void>;
/**
* Remove notification based on hashCode.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } hashCode - The hashCode.
* @param { RemoveReason } reason - The remove reason.
* @param { AsyncCallback<void> } callback - The callback of remove.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback<void>): void;
/**
* Remove notifications based on hashCodes.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<String> } hashCodes - The hashCode array.
* @param { RemoveReason } reason - The remove reason.
* @param { AsyncCallback<void> } callback - The callback of remove.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
function remove(hashCodes: Array<String>, reason: RemoveReason, callback: AsyncCallback<void>): void;
/**
* Remove notification based on hashCode.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } hashCode - The hashCode.
* @param { RemoveReason } reason - The remove reason.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600007 - The notification does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
function remove(hashCode: string, reason: RemoveReason): Promise<void>;
/**
* Remove notifications based on hashCodes.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { Array<String> } hashCodes - The hashCode array.
* @param { RemoveReason } reason - The remove reason.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'10', '1.2':'20'}
* @arkts 1.1&1.2
*/
function remove(hashCodes: Array<String>, reason: RemoveReason): Promise<void>;
/**
* RemoveAll all notifications based on BundleOption.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } bundle - The bundle option.
* @param { AsyncCallback<void> } callback - The callback of removeAll.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function removeAll(bundle: BundleOption, callback: AsyncCallback<void>): void;
/**
* RemoveAll all notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { AsyncCallback<void> } callback - The callback of removeAll.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function removeAll(callback: AsyncCallback<void>): void;
/**
* Remove all notifications under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @param { AsyncCallback<void> } callback - The callback of removeAll.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function removeAll(userId: number, callback: AsyncCallback<void>): void;
/**
* Remove all notifications under the specified user.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { number } userId - The userId.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 1600008 - The user does not exist.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function removeAll(userId: number): Promise<void>;
/**
* RemoveAll all notifications.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { BundleOption } [bundle] - The bundle option.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600001 - Internal error.
* @throws { BusinessError } 1600002 - Marshalling or unmarshalling error.
* @throws { BusinessError } 1600003 - Failed to connect to the service.
* @throws { BusinessError } 17700001 - The specified bundle name was not found.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 9
*/
function removeAll(bundle?: BundleOption): Promise<void>;
/**
* Trigger notification cross-device operation.
*
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @param { string } [hashcode] - The notification identifier.
* @param { OperationInfo } [operationInfo] - The interactive information.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system application to call the interface.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 1600010 - Distributed operation failed.
* @throws { BusinessError } 1600021 - Distributed operation timed out.
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
function distributeOperation(hashcode: string, operationInfo?: OperationInfo): Promise<void>;
/**
* Information on cross-device notification interactions
*
* @typedef OperationInfo
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
export interface OperationInfo {
/**
* action button name
*
* @type { ?string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
actionName?: string;
/**
* user input.
*
* @type { ?string }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'18', '1.2':'20'}
* @arkts 1.1&1.2
*/
userInput?: string;
/**
* action operation type
*
* @type { ?number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
operationType?: number;
/**
* action button index
*
* @type { ?number }
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since 20
* @arkts 1.1&1.2
*/
buttonIndex?: number;
}
/**
* Describes a bundleOption in a notification.
*
* @typedef { _BundleOption } BundleOption
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type BundleOption = _BundleOption;
/**
* Sets filter criteria of publishers for subscribing to desired notifications.
*
* @typedef { _NotificationSubscribeInfo } NotificationSubscribeInfo
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationSubscribeInfo = _NotificationSubscribeInfo;
/**
* Provides methods that will be called back when the subscriber receives a new notification or
* a notification is canceled.
*
* @typedef { _NotificationSubscriber } NotificationSubscriber
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type NotificationSubscriber = _NotificationSubscriber;
/**
* Provides methods that will be called back when the subscriber receives a new notification or
* a notification is canceled.
*
* @typedef { _SubscribeCallbackData } SubscribeCallbackData
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type SubscribeCallbackData = _SubscribeCallbackData;
/**
* Describes the properties of the application that the permission to send notifications has changed.
*
* @typedef { _EnabledNotificationCallbackData } EnabledNotificationCallbackData
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'9', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type EnabledNotificationCallbackData = _EnabledNotificationCallbackData;
/**
* Describes the badge number of the application has changed.
*
* @typedef { _BadgeNumberCallbackData } BadgeNumberCallbackData
* @syscap SystemCapability.Notification.Notification
* @systemapi
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
export type BadgeNumberCallbackData = _BadgeNumberCallbackData;
}
export default notificationSubscribe;
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

Search