/*
 * Copyright (c) 2021 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 SensorServiceKit
 */

import { AsyncCallback, Callback } from './@ohos.base';

/**
 * This module provides the capability to control motor vibration.
 *
 * @namespace vibrator
 * @syscap SystemCapability.Sensors.MiscDevice
 * @since 8
 */
/**
 * This module provides the capability to control motor vibration.
 *
 * @namespace vibrator
 * @syscap SystemCapability.Sensors.MiscDevice
 * @atomicservice
 * @since arkts {'1.1':'11', '1.2':'20'}
 * @arkts 1.1&1.2
 */
declare namespace vibrator {
  /**
   * The trigger motor vibrates for a specified length of time.
   *
   * @permission ohos.permission.VIBRATE
   * @param { number } duration Indicate the duration of the motor vibration.
   * @param { AsyncCallback<void> } callback The callback of vibrate.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   * @deprecated since 9
   * @useinstead vibrator#startVibration
   */
  function vibrate(duration: number, callback?: AsyncCallback<void>): void;

  /**
   * The trigger motor vibrates for a specified length of time.
   *
   * @permission ohos.permission.VIBRATE
   * @param { number } duration Indicate the duration of the motor vibration.
   * @returns { Promise<void> } Promise used to return the result.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   * @deprecated since 9
   * @useinstead vibrator#startVibration
   */
  function vibrate(duration: number): Promise<void>;

  /**
   * The trigger motor vibrates for the specified effect of the preset.
   *
   * @permission ohos.permission.VIBRATE
   * @param { EffectId } effectId Indicate the specified effect of the preset, {@code EffectId}.
   * @returns { Promise<void> } Promise used to return the result.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   * @deprecated since 9
   * @useinstead vibrator#startVibration
   */
  function vibrate(effectId: EffectId): Promise<void>;

  /**
   * The trigger motor vibrates for the specified effect of the preset.
   *
   * @permission ohos.permission.VIBRATE
   * @param { EffectId } effectId Indicate the specified effect of the preset, {@code EffectId}.
   * @param { AsyncCallback<void> } callback The callback of vibrate.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   * @deprecated since 9
   * @useinstead vibrator#startVibration
   */
  function vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void;

  /**
   * Trigger vibrator vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibrateEffect } effect - Indicate vibrate effect, {@code VibrateEffect}.
   * @param { VibrateAttribute } attribute - Indicate vibrate attribute, {@code VibrateAttribute}.
   * @param { AsyncCallback<void> } callback - The callback of startVibration.
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @throws { BusinessError } 801 - Capability not supported.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  /**
   * Trigger vibrator vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibrateEffect } effect - Indicate vibrate effect, {@code VibrateEffect}
   * @param { VibrateAttribute } attribute - Indicate vibrate attribute, {@code VibrateAttribute}
   * @param { AsyncCallback<void> } callback - The callback of startVibration
   * @throws { BusinessError } 201 - Permission denied
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @throws { BusinessError } 801 - Capability not supported
   * @throws { BusinessError } 14600101 - Device operation failed
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since arkts {'1.1':'11', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  function startVibration(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback<void>): void;

  /**
   * Trigger vibrator vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibrateEffect } effect - Indicate vibrate effect, {@code VibrateEffect}.
   * @param { VibrateAttribute } attribute - Indicate vibrate attribute, {@code VibrateAttribute}.
   * @returns { Promise<void> } Promise used to return the result.
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @throws { BusinessError } 801 - Capability not supported.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  /**
   * Trigger vibrator vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibrateEffect } effect - Indicate vibrate effect, {@code VibrateEffect}.
   * @param { VibrateAttribute } attribute - Indicate vibrate attribute, {@code VibrateAttribute}.
   * @returns { Promise<void> } Promise used to return the result.
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @throws { BusinessError } 801 - Capability not supported.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since arkts {'1.1':'11', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  function startVibration(effect: VibrateEffect, attribute: VibrateAttribute): Promise<void>;

  /**
   * Stop the vibrator from vibrating.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibratorStopMode } stopMode - Indicate the stop mode in which the motor vibrates, {@code VibratorStopMode}.
   * @returns { Promise<void> } Promise used to return the result.
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  function stopVibration(stopMode: VibratorStopMode): Promise<void>;

  /**
   * Stop the vibrator from vibrating.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibratorStopMode } stopMode - Indicate the stop mode in which the motor vibrates, {@code VibratorStopMode}.
   * @param { AsyncCallback<void> } callback - The callback of stopVibration.
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  function stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback<void>): void;

  /**
   * Stop any type of vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @param { AsyncCallback<void> } callback - The callback of stopVibration.
   * @throws { BusinessError } 201 - Permission denied.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 10
   */
  /**
   * Stop any type of vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @param { AsyncCallback<void> } callback - The callback of stopVibration.
   * @throws { BusinessError } 201 - Permission denied.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since 11
   */
  function stopVibration(callback: AsyncCallback<void>): void;

  /**
   * Stop any type of vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @returns { Promise<void> } Promise used to return the result.
   * @throws { BusinessError } 201 - Permission denied.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 10
   */
  /**
   * Stop any type of vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @returns { Promise<void> } Promise used to return the result.
   * @throws { BusinessError } 201 - Permission denied.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since 11
   */
  function stopVibration(): Promise<void>;

  /**
   * Stop any type of vibration.
   *
   * @permission ohos.permission.VIBRATE
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since 12
   */
  function stopVibrationSync(): void;

  /**
   * Stop the vibrator on the specified device. When all parameters are set to default, stop all local vibrators.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibratorInfoParam } [param] - Indicate the device and vibrator information that needs to be controlled,
   * <br> {@code VibratorInfoParam}.
   * @returns { Promise<void> } Promise used to return the result.
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 19
   */
  function stopVibration(param?: VibratorInfoParam): Promise<void>;

  /**
   * Whether the preset vibration effect is supported.
   *
   * @param { string } effectId Indicate the specified effect of the preset, {@code EffectId}.
   * @param { AsyncCallback<boolean> } callback The callback of isSupportEffect.
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'10', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  function isSupportEffect(effectId: string, callback: AsyncCallback<boolean>): void;

  /**
   * Whether the preset vibration effect is supported.
   *
   * @param { string } effectId Indicate the specified effect of the preset, {@code EffectId}.
   * @returns { Promise<boolean> } Promise used to return the result.
   * @throws { BusinessError } 201 - Permission denied.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'10', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  function isSupportEffect(effectId: string): Promise<boolean>;

  /**
   * Whether the preset vibration effect is supported.
   *
   * @param { string } effectId Indicate the specified effect of the preset, {@code EffectId}.
   * @returns { boolean } Returns whether the effect is supported.
   * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
   * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 12
   */
  function isSupportEffectSync(effectId: string): boolean;

  /**
   * Get effect information by device ID and vibrator ID.
   *
   * @param { string } effectId - The effect type to query.
   * @param { VibratorInfoParam } [param] - Indicate the device and vibrator information that needs to be controlled,
   * <br> {@code VibratorInfoParam}. By default, query local vibrators.
   * @returns { EffectInfo } Returns information about the specified effect.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 19
   */
  function getEffectInfoSync(effectId: string, param?: VibratorInfoParam): EffectInfo;

  /**
  * The information includes Indicates whether the effect is supported.
  *
  * @interface EffectInfo
  * @syscap SystemCapability.Sensors.MiscDevice
  * @since 19
  */
  interface EffectInfo {
    /**
     * Indicates whether the effect is supported, true means supported, false means not supported.
     *
     * @type { boolean }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    isEffectSupported: boolean;
  }

  /**
   * Stop the motor from vibrating.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibratorStopMode } stopMode Indicate the stop mode in which the motor vibrates, {@code VibratorStopMode}.
   * @returns { Promise<void> } Promise used to return the result.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   * @deprecated since 9
   * @useinstead vibrator#stopVibration
   */
  function stop(stopMode: VibratorStopMode): Promise<void>;

  /**
   * Stop the motor from vibrating.
   *
   * @permission ohos.permission.VIBRATE
   * @param { VibratorStopMode } stopMode Indicate the stop mode in which the motor vibrates, {@code VibratorStopMode}.
   * @param { AsyncCallback<void> } callback The callback of stop.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   * @deprecated since 9
   * @useinstead vibrator#stopVibration
   */
  function stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;

  /**
   * Whether the high-definition haptic is supported.
   *
   * @returns { boolean } Returns whether the high-definition haptic is supported.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 12
   */
  function isHdHapticSupported(): boolean;

  /**
   * Preset vibration effect string.
   * 
   * @enum { string }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   */
  enum EffectId {
  /**
   * Describes the vibration effect of the vibrator when a user adjusts the timer.
   *
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   */
    EFFECT_CLOCK_TIMER = 'haptic.clock.timer'
  }

  /**
   * Simple and universal vibration effects.
   * 
   * @enum { string }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 12
   */
  enum HapticFeedback {
    /**
     * Describes the soft vibration effect of the vibrator.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 12
     */
    EFFECT_SOFT = 'haptic.effect.soft',

    /**
     * Describes the hard vibration effect of the vibrator.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 12
     */
    EFFECT_HARD = 'haptic.effect.hard',

    /**
     * Describes the sharp vibration effect of the vibrator.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 12
     */
    EFFECT_SHARP = 'haptic.effect.sharp',

    /**
     * Describes the vibration effect of the successful notice.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    EFFECT_NOTICE_SUCCESS = 'haptic.notice.success',

    /**
     * Describes the vibration effect of the failed notice.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    EFFECT_NOTICE_FAILURE = 'haptic.notice.fail',

    /**
     * Describes the vibration effect of the warning notice.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    EFFECT_NOTICE_WARNING = 'haptic.notice.warning'
  }

  /**
   * Vibrator vibration stop mode.
   *
   * @enum { string }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   */
  enum VibratorStopMode {
  /**
   * Indicates the mode of stopping a one-shot vibration effect.
   *
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   */
    VIBRATOR_STOP_MODE_TIME = 'time',

  /**
   * Indicates the mode of stopping a preset vibration effect.
   *
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 8
   */
    VIBRATOR_STOP_MODE_PRESET = 'preset'
  }

  /**
   * The use of vibration.
   *
   * @typedef {'unknown' | 'alarm' | 'ring' | 'notification' | 'communication' |
   * 'touch' | 'media' | 'physicalFeedback' | 'simulateReality'}
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  /**
   * The use of vibration.
   *
   * @typedef {'unknown' | 'alarm' | 'ring' | 'notification' | 'communication' |
   * 'touch' | 'media' | 'physicalFeedback' | 'simulateReality'}
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since arkts {'1.1':'11', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  type Usage = 'unknown' | 'alarm' | 'ring' | 'notification' | 'communication' |
  'touch' | 'media' | 'physicalFeedback' | 'simulateReality';

  /**
   * The attribute of vibration.
   *
   * @interface VibrateAttribute
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  /**
   * The attribute of vibration.
   *
   * @interface VibrateAttribute
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since arkts {'1.1':'11', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface VibrateAttribute {
  /**
   * Vibrator id, default is 0.
   *
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  /**
   * Vibrator id, default is 0.
   *
   * @type { ?number }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since arkts {'1.1':'11', '1.2':'20'}
   * @arkts 1.1&1.2
   */
    id?: number;

  /**
   * Unique identifier for the device that contains one or multiple vibrators.
   * By default, deviceId represents the local device.
   *
   * @type { ?number }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since 19
   */
    deviceId?: number;

  /**
   * The use of vibration.
   *
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  /**
   * The use of vibration.
   *
   * @type { Usage }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since arkts {'1.1':'11', '1.2':'20'}
   * @arkts 1.1&1.2
   */
    usage: Usage;

  /**
   * Indicates whether to bypass system management switches.
   *
   * @type { ?boolean }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @systemapi
   * @since arkts {'1.1':'12', '1.2':'20'}
   * @arkts 1.1&1.2
   */
    systemUsage?: boolean;
  }

  /**
   * Describes the effect of vibration.
   *
   * @typedef { VibrateTime | VibratePreset }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  /**
   * Describes the effect of vibration.
   *
   * @typedef { VibrateTime | VibratePreset | VibrateFromFile }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 10
   */
  /**
   * Describes the effect of vibration.
   *
   * @typedef { VibrateTime | VibratePreset | VibrateFromFile }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since 11
   */
  /**
   * Describes the effect of vibration.
   *
   * @typedef { VibrateTime | VibratePreset | VibrateFromFile | VibrateFromPattern }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since arkts {'1.1':'18', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  type VibrateEffect = VibrateTime | VibratePreset | VibrateFromFile | VibrateFromPattern;

  /**
   * Vibrate continuously for a period of time at the default intensity of the system.
   *
   * @interface VibrateTime
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 9
   */
  /**
   * Vibrate continuously for a period of time at the default intensity of the system.
   *
   * @interface VibrateTime
   * @syscap SystemCapability.Sensors.MiscDevice
   * @atomicservice
   * @since arkts {'1.1':'11', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface VibrateTime {
    /**
     * The value is "time", which triggers the motor vibration according to the specified duration.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 9
     */
    /**
     * The value is "time", which triggers the motor vibration according to the specified duration.
     *
     * @type { 'time' }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @atomicservice
     * @since arkts {'1.1':'11', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    type: 'time';

    /**
     * The duration of the vibration, in ms.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 9
     */
    /**
     * The duration of the vibration, in ms.
     *
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @atomicservice
     * @since arkts {'1.1':'11', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    duration: number; /** The duration of the vibration, in ms */
  }

  /**
   * Preset vibration type vibration effect.
   *
   * @interface VibratePreset
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'9', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface VibratePreset {
    /**
     * The value is "preset", which triggers motor vibration according to preset vibration effect.
     *
     * @type { 'preset' }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'9', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    type: 'preset';

    /**
     * Preset type vibration.
     *
     * @type { string }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'9', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    effectId: string;

    /**
     * The number of vibration repetitions.
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 9
     */
    /**
     * The number of vibration repetitions.
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'12', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    count?: number;

    /**
     * The intensity of vibration effect.
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'12', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    intensity?: number;
  }

  /**
   * Custom vibration, vibrate the effect from a haptic file.
   *
   * @interface VibrateFromFile
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'10', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface VibrateFromFile {
  /**
   * The value is "file", which triggers motor vibration according to the vibration profile.
   *
   * @type { 'file' }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'10', '1.2':'20'}
   * @arkts 1.1&1.2
   */
    type: 'file';

  /**
   * Haptic file descriptor, some formats are supported.
   *
   * @type { HapticFileDescriptor }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'10', '1.2':'20'}
   * @arkts 1.1&1.2
   */
    hapticFd: HapticFileDescriptor;
  }

  /**
   * Haptic file descriptor. The caller needs to ensure that the fd is valid and
   * the offset and length are correct.
   *
   * @interface HapticFileDescriptor
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'10', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface HapticFileDescriptor {
    /**
     * The file descriptor of haptic effect source from file system. The caller
     * is responsible to close the file descriptor.
     *
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'10', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    fd: number;

    /**
     * The offset into the file where the data to be read, in bytes. By default,
     * the offset is zero.
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'10', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    offset?: number;

    /**
     * The length in bytes of the data to be read. By default, the length is the
     * rest of bytes in the file from the offset.
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'10', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    length?: number;
  }

  /**
   * Types of vibration events
   *
   * @enum { number }
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'18', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  enum VibratorEventType {
    /**
     * Steady state long vibration
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    CONTINUOUS = 0,

    /**
     * Transient short vibration
     *
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    TRANSIENT = 1,
  }

  /**
   * The vibration curve is valid when the vibration event type is 'continuous'
   *
   * @interface VibratorCurvePoint
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'18', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface VibratorCurvePoint {
    /**
      * The offset of the starting time of the relative event.
      *
      * @type { number }
      * @syscap SystemCapability.Sensors.MiscDevice
      * @since arkts {'1.1':'18', '1.2':'20'}
      * @arkts 1.1&1.2
      */
    time: number;

    /**
      * Gain in relative event vibration intensity
      *
      * @type { ?number }
      * @syscap SystemCapability.Sensors.MiscDevice
      * @since arkts {'1.1':'18', '1.2':'20'}
      * @arkts 1.1&1.2
      */
    intensity?: number;
    /**
     * Changes in relative event vibration frequency
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    frequency?: number;
  }

  /**
   * Vibration event.
   *
   * @interface VibratorEvent
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'18', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface VibratorEvent {
    /**
     * Types of vibration events
     *
     * @type { VibratorEventType }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    eventType: VibratorEventType;

    /**
     * Relative starting time of vibration
     *
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    time: number;

    /**
     * The duration of vibration
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    duration?: number;

    /**
     * Intensity of vibration events
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    intensity?: number;

    /**
     * Vibration event frequency
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    frequency?: number;

    /**
     * Channel number
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    index?: number;

    /**
     * An array representing vibration adjustment curves.
     *
     * @type { ?Array<VibratorCurvePoint> }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    points?: Array<VibratorCurvePoint>;
  }

  /**
   * Each 'events' attribute in the vibration sequence represents one vibration event
   *
   * @interface VibratorPattern
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'18', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface VibratorPattern {
    /**
     * Absolute starting time of vibration
     *
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    time: number;

    /**
     * Vibration event array, where each 'events' attribute represents one vibration event.
     *
     * @type { Array<VibratorEvent> }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    events: Array<VibratorEvent>;
  }

  /**
   * The continuous vibration parameters
   *
   * @interface ContinuousParam
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 18
   */
  interface ContinuousParam {
    /**
     * Intensity of vibration
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    intensity?: number;

    /**
     * Frequency of vibration
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    frequency?: number;

    /**
     * The points of vibration
     *
     * @type { ?VibratorCurvePoint[] }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    points?: VibratorCurvePoint[];

    /**
     * Index of vibration
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    index?: number;
  }

  /**
   * The transient vibration parameters
   *
   * @interface TransientParam
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 18
   */
  interface TransientParam {
    /**
     * Intensity of vibration
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    intensity?: number;

    /**
     * Frequency of vibration
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    frequency?: number;

    /**
     * Index of vibration
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    index?: number;
  }

  /**
   * Provide methods for adding long or short vibration events and generate VibratorPattern objects.
   *
   * @name VibratorPatternBuilder
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 18
   */
  class VibratorPatternBuilder {
    /**
     * Method for adding long vibration events
     *
     * @param { number } time Relative starting time of the long-term vibration event.
     * @param { number } duration The duration of the long-term vibration event
     * @param { ContinuousParam } options Optional parameter object
     * @returns { VibratorPatternBuilder } Return the current VibratorPatternBuilder object.
     * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
     * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    addContinuousEvent(time: number, duration: number, options?: ContinuousParam): VibratorPatternBuilder;

    /**
     * Method for adding short vibration events.
     *
     * @param { number } time Relative starting time of short oscillation events.
     * @param { TransientParam } options Optional parameter object
     * @returns { VibratorPatternBuilder } Return the current VibratorPatternBuilder object.
     * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
     * <br> 2. Incorrect parameter types; 3. Parameter verification failed.
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    addTransientEvent(time: number, options?: TransientParam): VibratorPatternBuilder;

    /**
     * Method for constructing vibration sequences of combined short or long events.
     *
     * @returns { VibratorPattern } Return VibratorPattern object.
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 18
     */
    build(): VibratorPattern;
  }

  /**
   * Trigger motor vibration with custom vibration effects.
   *
   * @interface VibrateFromPattern
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since arkts {'1.1':'18', '1.2':'20'}
   * @arkts 1.1&1.2
   */
  interface VibrateFromPattern {
    /**
     * The value is "pattern", which triggers motor vibration based on the combination pattern.
     *
     * @type { 'pattern' }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    type: 'pattern';

    /**
     * Customize the sequence of motor vibration events, the VibratorPattern object returned by the build() method.
     *
     * @type { VibratorPattern }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since arkts {'1.1':'18', '1.2':'20'}
     * @arkts 1.1&1.2
     */
    pattern: VibratorPattern;
  }

  /**
  * Parameters of vibrator on the device. By default, VibratorInfoParam may default to querying or controlling
  * the local default vibrator.
  * @interface VibratorInfoParam
  * @syscap SystemCapability.Sensors.MiscDevice
  * @since 19
  */
  interface VibratorInfoParam {
    /**
     * Unique identifier for the device that contains one or multiple vibrators.
     * By default, deviceId may default to querying or controlling the local default vibrator.
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    deviceId?: number;
    /**
     * Unique identifier for the vibrator itself within the device.
     * By default, vibratorId may default to querying or controlling all vibrators on the corresponding device.
     *
     * @type { ?number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    vibratorId?: number;
  }

  /**
   * Represents the information about a vibrator device in the system.
   * @interface VibratorInfo
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 19
   */
  interface VibratorInfo {
    /**
     * Unique identifier for the device that contains one or multiple vibrators.
     *
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    deviceId: number;

    /**
     * Unique identifier for the vibrator itself within the device.
     *
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    vibratorId: number;

    /**
     * Name of the device.
     *
     * @type { string }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    deviceName: string;

    /**
     * Indicates whether the vibrator device support HD haptic.
     *
     * @type { boolean }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    isHdHapticSupported: boolean;

    /**
     * Indicates whether the vibrator is a local device or an external one.
     * If the value is true, it represents a local device; if false, it represents an external device.
     *
     * @type { boolean }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    isLocalVibrator: boolean;
  }

  /**
   * Retrieve the list of vibrator information about one or all devices.
   *
   * @param { VibratorInfoParam } [param] - Indicate the device and vibrator information that needs to be controlled,
   * <br> {@code VibratorInfoParam}. By default, this returns all vibrators on all device when param is unspecified.
   * @returns { Array<VibratorInfo> } Promise used to return a list of vibrator IDs containing information
   * <br> about the vibrator device.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 19
   */
  function getVibratorInfoSync(param?: VibratorInfoParam): Array<VibratorInfo>;

  /**
   * Register a callback function to be called when a vibrator plugin or unplug event occurs.
   *
   * @param { 'vibratorStateChange' } type - Event of the listening.
   * @param { Callback<VibratorStatusEvent> } callback - The callback function to be executed when
   * <br> the event is triggered.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 19
   */
  function on(type: 'vibratorStateChange', callback: Callback<VibratorStatusEvent>): void;

  /**
   * Unregister a callback function for vibrator plugin or unplug events.
   *
   * @param { 'vibratorStateChange' } type - Event of the listening.
   * @param { Callback<VibratorStatusEvent> } [callback] - The callback function to be removed from the event listener.
   * @throws { BusinessError } 14600101 - Device operation failed.
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 19
   */
  function off(type: 'vibratorStateChange', callback?: Callback<VibratorStatusEvent>): void;

  /**
   * Indicates information about vibrator online or offline events.
   *
   * @interface
   * @syscap SystemCapability.Sensors.MiscDevice
   * @since 19
   */
  interface VibratorStatusEvent {
    /**
     * The timestamp of the reported event.
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    timestamp: number;

    /**
     * Unique identifier for the device that contains one or multiple vibrators.
     * 
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    deviceId: number;

    /**
     * Indicate the number of vibrators on the device.
     * 
     * @type { number }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    vibratorCount: number;

    /**
     * Indicates the device's online and offline status, true indicates online, false indicates offline.
     *
     * @type { boolean }
     * @syscap SystemCapability.Sensors.MiscDevice
     * @since 19
     */
    isVibratorOnline: boolean;
  }
}

export default vibrator;