README.md · LVB8189/pasteboard_master_mock

# pasteBoardService

## Introduction

As a functional component of the stray subsystem, the clipboard service provides the ability to manage the system clipboard and supports the system copy and paste functions. The system clipboard supports package text, hypertext, URIs and other content operations.

**picture 1**  Subsystem Architecture Diagram
![](figures/subsystem_architecture.png "Subsystem architecture")

The clipboard service provides functions that support application developers to use clipboard-related services conveniently and efficiently. Its main components include clipboard management client and clipboard service. The clipboard management client is responsible for clipboard interface management, providing clipboard northbound JS API to applications; creating clipboard data on the application framework side, requesting clipboard SA to perform clipboard creation, deletion, query, text conversion, configuration, etc. The clipboard service is responsible for clipboard event management, manages the life cycle of clipboard SA (startup, destruction, multi-user, etc.); executes application requests, notifies clipboard data management, and returns the results to the clipboard management client.

## Directory Structure

```
/foundation/distributeddatamgr/pasteboard
├── etc         # Configuration files for the processes contained in the component
├── figures     # Framework diagram
├── framework   # innerKit interface
├── interfaces  # The interface code provided by the component externally
│   └── kits    # Interface provided to the application
├── profile     # Configuration files for system services contained in the component
├── services    # clipboard service implementation
│    └── core   # Core code implementation
│    └── test   # native test code
│    └── zidl   # Cross-process communication code implementation
├── utils       # Tests or services use mocked data
└──README.md    # Instructions for use
```

## illustrate

### Interface Description

**list 1**   PasteBoard open main method

**list 2**  SystemPasteboard open main method

**list 3**  PasteData open main method

<table><thead align="left"><tr id="row143351854201012"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><a name="p103351154121010"></a><a name="p103351154121010"></a>interface name
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><a name="p1033585416105"></a><a name="p1033585416105"></a>describe
</th>
</tr>
</thead>
<tbody><tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>addHtmlRecord(htmlText: string): void;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Add the HTML text record to the PasteData object and update the MIME type to PasteData#MIMETYPE_TEXT_HTML in the DataProperty.
</td>
</tr>
<tr id="row13335054111018"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p12832214151418"></a><a name="p12832214151418"></a>addWantRecord(want: Want): void;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p3335145451011"></a><a name="p3335145451011"></a>Add want record to PasteData object and update MIME type to PasteData#MIMETYPE_TEXT_WANT in DataProperty
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>addRecord(record: PasteDataRecord): void;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Add PasteRecord to paste data object and update MIME type in data attribute
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>addTextRecord(text: string): void;;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Add plain text records to PasteData object and update MIME type to PasteData#MIMETYPE_TEXT_PLAIN in DataProperty
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>addUriRecord(uri: string): void;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Add URI record to PasteData object and update MIME type to PasteData#MIMETYPE_TEXT_URI in DataProperty
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>getMimeTypes(): Array&lt;string&gt;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>MIME type of everything on the pasteboard
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>getPrimaryHtml(): string;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>HTML text of the main record in the PasteData object
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>getPrimaryWant(): Want;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>The want of the master record in the PasteData object
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>getPrimaryMimeType(): string;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>The MIME type of the master record in the PasteData object
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>getPrimaryUri(): string;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>URI of the master record in the PasteData object
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>getProperty(): PasteDataProperty;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Get the properties of the clipboard data object
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>getRecordAt(index: number): PasteDataRecord;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>records based on the specified index
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>getRecordCount(): number;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Number of records in PasteData object
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>hasMimeType(mimeType: string): boolean;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Checks if data of the specified MIME type exists in the DataProperty
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>removeRecordAt(index: number): boolean;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Delete records based on specified index
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>replaceRecordAt(index: number, record: PasteDataRecord): boolean;
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Replace the specified record with a new record
</td>
</tr>
</tbody>
</table>

**list 4**  PasteDataRecord open main method

**list 5**  PasteDataProperty Parameter Description

<table><thead align="left"><tr id="row143351854201012"><th class="cellrowborder" valign="top" width="30%" id="mcps1.2.3.1.1"><a name="p103351154121010"></a><a name="p103351154121010"></a>name
</th>
<th class="cellrowborder" valign="top" width="30%" id="mcps1.2.3.1.2"><a name="p1033585416105"></a><a name="p1033585416105"></a>type
</th>
<th class="cellrowborder" valign="top" width="40%" id="mcps1.2.3.1.3"><a name="p1033585416105"></a><a name="p1033585416105"></a>illustrate
</th>
</tr>
</thead>
<tbody><tr id="row204321219393"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>additions{[key:string]}
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>object
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.2.3.1.3 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Additional property data key-value pair
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>mimeTypes
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Array<string>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.2.3.1.3 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Distinct MIME types for all records in PasteData
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>tag
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>string
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.2.3.1.3 "><a name="p18761104812149"></a><a name="p18761104812149"></a>User-defined labels for PasteData objects
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>timestamp
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a>number
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.2.3.1.3 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Timestamp indicating when the data was written to the system clipboard.
</td>
</tr>
<tr id="row204321219393"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.1 "><a name="p1893413268144"></a><a name="p1893413268144"></a>localOnly
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.2.3.1.2 "><a name="p18761104812149"></a><a name="p18761104812149"></a> boolean
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.2.3.1.3 "><a name="p18761104812149"></a><a name="p18761104812149"></a>Check if PasteData is set for local access only.
</td>
</tr>
</tbody>
</table>

### Instructions for use

Clipboard module usage example：

```
// import module
import pasteboard from '@ohos.pasteboard'
//text copy
console.log('Get SystemPasteboard')
var systemPasteboard = pasteboard.getSystemPasteboard()
systemPasteboard.clear()
        
var textData = 'Hello World!'
console.log('createPlainTextData = ' + textData)
var pasteData = pasteboard.createPlainTextData(textData)
        
console.log('Writes PasteData to the pasteboard')
systemPasteboard.setPasteData(pasteData)
        
console.log('Checks there is content in the pasteboard')
assert.equal(systemPasteboard.hasPasteData(), true)
        
console.log('Checks the number of records')
pasteData = systemPasteboard.getPasteData()
assert.equal(pasteData.getRecordCount(), 1)
        
console.log('Checks the pasteboard content')
assert.equal(pasteData.getPrimaryText(), textData)
        
console.log('Checks there is a MIMETYPE_TEXT_PLAIN MIME type of data')
assert.equal(pasteData.hasMimeType(MIMETYPE_TEXT_PLAIN), true)
assert.equal(pasteData.getPrimaryMimeType(), MIMETYPE_TEXT_PLAIN)

//clipboard change listener
console.log('Off the content changes')
var systemPasteboard = pasteboard.getSystemPasteboard()
systemPasteboard.off(contentChanges)
systemPasteboard.clear()
        
var textData = 'Hello World!'
console.log('createUriData = ' + textData)
var pasteData = pasteboard.createUriData(textData)
        
console.log('Writes PasteData to the pasteboard')
systemPasteboard.setPasteData(pasteData)
        
console.log('Checks there is content in the pasteboard')
assert.equal(systemPasteboard.hasPasteData(), true)
        
console.log('Checks the number of records')
pasteData = systemPasteboard.getPasteData()
assert.equal(pasteData.getRecordCount(), 1)
        
console.log('On the content changes')
systemPasteboard.on(contentChanges)
        
console.log('Removes the Record')
assert.equal(pasteData.removeRecordAt(0), true)
        
console.log('Writes PasteData to the pasteboard')
systemPasteboard.setPasteData(pasteData)
        
console.log('Checks the number of records')
pasteData = systemPasteboard.getPasteData()
assert.equal(pasteData.getRecordCount(), 0)
        
console.log('Checks there is  no content in the pasteboard')
assert.equal(systemPasteboard.hasPasteData(), false)
        
var textDataNew = 'Hello World!-New'
console.log('createUriData = ' + textDataNew)
var pasteData = pasteboard.createUriData(textDataNew)
        
console.log('Writes PasteData to the pasteboard')
systemPasteboard.setPasteData(pasteData)
        
console.log('Checks there is content in the pasteboard')
assert.equal(systemPasteboard.hasPasteData(), true)
        
console.log('Checks the number of records')
pasteData = systemPasteboard.getPasteData()
assert.equal(pasteData.getRecordCount(), 1)
        
console.log('Checks the pasteboard content')
assert.equal(pasteData.getRecordAt(0).plainText, textDataNew)

```

## Related warehouse

**Distributed Data Management subsystem**

[distributeddatamgr\_pasteboard](https://gitee.com/openharmony/distributeddatamgr_pasteboard)

LVB8189/pasteboard_master_mock

简介

发行版

贡献者

近期动态

LVB8189/pasteboard_master_mock .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

LVB8189/pasteboard_master_mock