程序包 ohos.miscservices.pasteboard

类 SystemPasteboard

java.lang.Object

ohos.miscservices.pasteboard.SystemPasteboard

public class SystemPasteboard
extends Object

Defines system pasteboard operations, including copying, pasting, and setting listeners for pasteboard content changes.

This class facilitates short-term data exchange between user applications. For example, an application program uses this interface to paste copied data to the system pasteboard, and another program obtains the pasted data from the pasteboard.

In the distributed pasteboard scenario, the pasted data can be written across devices. For example, an application program on device A uses this interface to store data copied form device A to the system pasteboard of device B. An application program on device B can read and paste the copied data in the system pasteboard if the data is allowed to share between devices.

Note that the following conditions must be met for cross-device data writing:

• The writing and reading device must meet the networking requirements. For details, see the ohos Developer Guide.
• The distributed pasteboard function is enabled on both the writing and reading devices in the network. Currently, only plain text and HTML text are supported, and the maximum size is 64 KB.

从以下版本开始:

1

SystemCapability

SystemCapability.Miscservices#PASTEBOARD

方法概要

限定符和类型	方法	说明
void	addPasteDataChangedListener(IPasteDataChangedListener listener)	Listens for pasteboard content changes.
void	clear()	Clears the pasteboard.
PasteData	getPasteData()	Obtains data in a PasteData object.
static SystemPasteboard	getSystemPasteboard(Context context)	Obtains an object for system pasteboard operations.
boolean	hasPasteData()	Checks whether there is content in the pasteboard.
void	removePasteDataChangedListener(IPasteDataChangedListener listener)	Removes the listener for pasteboard content changes.
void	setPasteData(PasteData data)	Writes PasteData to the pasteboard.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

getSystemPasteboard

public static SystemPasteboard getSystemPasteboard(Context context)

Obtains an object for system pasteboard operations.

参数:

context - Indicates the application context. This parameter cannot be null.

返回:

Returns the object if any; returns null if the input parameter is null, or no object is obtained.

从以下版本开始:

1

getPasteData

public PasteData getPasteData()

Obtains data in a PasteData object.

For purposes of user data security, non-foreground applications (excluding the default system input method application) are not allowed to obtain pasteboard content. If an application does not have the focused window, null will be returned.

In the distributed pasteboard scenario, the obtained data is the latest content written by the local or remote device into the local system pasteboard.

返回:

Returns the pasteboard content; returns null if the operation is not allowed.

从以下版本开始:

1

另请参阅:

PasteData, setPasteData(PasteData), hasPasteData()

setPasteData

public void setPasteData(PasteData data)

Writes PasteData to the pasteboard.

When cross-device data writing is allowed, calling this method will write the data into the system pasteboard of other devices in the network.

参数:

data - Indicates paste data to write.

抛出:

NullPointerException - Throws this exception if pasteData is null.

从以下版本开始:

1

另请参阅:

PasteData, getPasteData(), hasPasteData()

hasPasteData

public boolean hasPasteData()

Checks whether there is content in the pasteboard.

For the purposes of user data security, non-foreground applications are not allowed to check pasteboard content. If an application does not have the focused window, false will be returned.

返回:

Returns true if there is content; returns false if there is no content, or the operation is not allowed.

从以下版本开始:

1

另请参阅:

PasteData, getPasteData(), setPasteData(PasteData)

clear

public void clear()

Clears the pasteboard.

从以下版本开始:

1

addPasteDataChangedListener

public void addPasteDataChangedListener(IPasteDataChangedListener listener)

Listens for pasteboard content changes.

参数:

listener - Indicates the listener.

从以下版本开始:

1

另请参阅:

IPasteDataChangedListener

removePasteDataChangedListener

public void removePasteDataChangedListener(IPasteDataChangedListener listener)

Removes the listener for pasteboard content changes.

参数:

listener - Indicates the listener to remove.

从以下版本开始:

1

另请参阅:

IPasteDataChangedListener