@ohos.deviceStatus.dragInteraction (Drag Interaction) (System API)

The dragInteraction module provides the APIs to enable and disable listening for dragging status changes.

NOTE

• The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

• The APIs provided by this module are system APIs.

Modules to Import

import { dragInteraction } from '@kit.ArkUI';

DragState

Enumerates dragging states.

System API: This is a system API.

System capability: SystemCapability.Msdp.DeviceStatus.Drag

Summary¹¹⁺

Defines the data summary of the dragged object.

System API: This is a system API.

System capability: SystemCapability.Msdp.DeviceStatus.Drag

dragInteraction.on(‘drag’)

on(type: ‘drag’, callback: Callback<DragState>): void

Enables listening for dragging status changes.

System API: This is a system API.

System capability: SystemCapability.Msdp.DeviceStatus.Drag

Parameters

Error codes

For details about the error codes, see Universal Error Codes.

Example

try {
  dragInteraction.on('drag', (data: dragInteraction.DragState) => {
    console.log(`Drag interaction event: ${JSON.stringify(data)}`);
  });
} catch (error) {
  console.error(`Register failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

dragInteraction.off(‘drag’)

off(type: ‘drag’, callback?: Callback<DragState>): void

Disables listening for dragging status changes.

System API: This is a system API.

System capability: SystemCapability.Msdp.DeviceStatus.Drag

Parameters

Error codes

For details about the error codes, see Universal Error Codes.

Example

// Unregister a single callback.
function single_callback(event: dragInteraction.DragState) {
  console.log(`Drag interaction event: ${JSON.stringify(event)}`);
  return false;
}
try {
  dragInteraction.on('drag', single_callback);
  dragInteraction.off("drag", single_callback);
} catch (error) {
  console.error(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// Unregister all callbacks.
function all_callback(event: dragInteraction.DragState) {
  console.log(`Drag interaction event: ${JSON.stringify(event)}`);
  return false;
}
try {
  dragInteraction.on('drag', all_callback);
  dragInteraction.off("drag");
} catch (error) {
  console.error(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

dragInteraction.getDataSummary¹¹⁺

getDataSummary(): Array<Summary>

Obtains the data summary of all dragged objects.

System API: This is a system API.

System capability: SystemCapability.Msdp.DeviceStatus.Drag

Return value

Error codes

For details about the error codes, see Universal Error Codes.

Example

let summarys: Array<dragInteraction.Summary> = dragInteraction.getDataSummary();
console.log(`Drag interaction summarys: ${JSON.stringify(summarys)}`);

dragInteraction.setDragSwitchState¹⁸⁺

setDragSwitchState(enabled: boolean): void

Sets the global drag-and-drop switch.

System API: This is a system API.

System capability: SystemCapability.Msdp.DeviceStatus.Drag

Parameters

Error codes

For details about the error codes, see Universal Error Codes.

Example

dragInteraction.setDragSwitchState(false);

dragInteraction.setAppDragSwitchState¹⁸⁺

setAppDragSwitchState(enabled: boolean, bundleName: string): void

Sets the drag-and-drop switch for a specific application.

System API: This is a system API.

System capability: SystemCapability.Msdp.DeviceStatus.Drag

Parameters

Error codes

For details about the error codes, see Universal Error Codes.

Example

dragInteraction.setAppDragSwitchState(true, "com.app.bundleName");

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkUI

harmony 鸿蒙ARKUI_TextPickerCascadeRangeContent

harmony 鸿蒙ARKUI_TextPickerRangeContent

harmony 鸿蒙ArkUI_AnimateCompleteCallback

harmony 鸿蒙ArkUI_AttributeItem

harmony 鸿蒙ArkUI_ColorStop

harmony 鸿蒙ArkUI_ContextCallback

harmony 鸿蒙ArkUI_EventModule

harmony 鸿蒙ArkUI_ExpectedFrameRateRange

harmony 鸿蒙ArkUI_IntOffset