mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2025-04-09 00:01:50 +00:00

Signed-off-by: z30053788 <zhaobaoxin1@huawei.com> Change-Id: Ib563cfd6a2933c71546407bb0fc622fef6e9ebf2
122 lines
2.7 KiB
TypeScript
122 lines
2.7 KiB
TypeScript
/*
|
|
* 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 Some states and flags for notifications
|
|
* @kit NotificationKit
|
|
*/
|
|
|
|
/**
|
|
* The status of the notification flag.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The status of the notification flag.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @since 11
|
|
*/
|
|
export enum NotificationFlagStatus {
|
|
/**
|
|
* notification flag default value
|
|
*
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* notification flag default value
|
|
*
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @since 11
|
|
*/
|
|
TYPE_NONE = 0,
|
|
|
|
/**
|
|
* notification flag open
|
|
*
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* notification flag open
|
|
*
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @since 11
|
|
*/
|
|
TYPE_OPEN = 1,
|
|
|
|
/**
|
|
* notification flag close
|
|
*
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* notification flag close
|
|
*
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @since 11
|
|
*/
|
|
TYPE_CLOSE = 2
|
|
}
|
|
|
|
/**
|
|
* Describes a NotificationFlags instance.
|
|
*
|
|
* @typedef NotificationFlags
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @since 8
|
|
*/
|
|
export interface NotificationFlags {
|
|
/**
|
|
* Whether to enable sound reminder.
|
|
*
|
|
* @type { ?NotificationFlagStatus }
|
|
* @readonly
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @since 8
|
|
*/
|
|
readonly soundEnabled?: NotificationFlagStatus;
|
|
|
|
/**
|
|
* Whether to enable vibration reminder.
|
|
*
|
|
* @type { ?NotificationFlagStatus }
|
|
* @readonly
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @since 8
|
|
*/
|
|
readonly vibrationEnabled?: NotificationFlagStatus;
|
|
|
|
/**
|
|
* Read-only the prompt entry information allowed by the current channel.
|
|
*
|
|
* @type { ?number }
|
|
* @readonly
|
|
* @syscap SystemCapability.Notification.Notification
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
readonly reminderFlags?: number;
|
|
}
|