PasteData

java.lang.Object
- ohos.miscservices.pasteboard.PasteData

所有已实现的接口:

Sequenceable
```
public class PasteData
extends Object
implements Sequenceable
```
Represents pasted data on the pasteboard.
This class provides data records defined by PasteData.Record, and data properties defined by PasteData.DataProperty.
PasteData.Record contains complex data which is created and added using SystemPasteboard by an application. Data in a Record can be a description of plain text, HTML text, an intent, or a URI. A PasteData object contains one Record instance or a limited number of them. A PasteData object contains one Record instance or a combination of them.
The size of the pasted data transferred each time within a device cannot exceed 500 KB. Data transferred among devices each time cannot exceed 64 KB, and the data must be in the text format.
DataProperty describes properties of pasted data, such as MIME types and storage timestamp.
SystemPasteboard can transfer objects through data URIs, and a recipient uses DataAbilityHelper to read the object identified by the URI. This transfers complex binary objects between applications, such as images and media files.

从以下版本开始:

1

SystemCapability

SystemCapability.Miscservices#PASTEBOARD

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`PasteData.DataProperty`	This class defines properties of `PasteData` on the system pasteboard, including the timestamp, MIME types, and additional property data.
`static class`	`PasteData.Record`	This class defines single pasted data as `Record`, which can be plain text, HTML text, URIs, and intents.

从接口继承的嵌套类/接口 ohos.utils.Sequenceable
Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`static int`	`MAX_RECORD_NUM`	Indicates the maximum number of records allowed in a `PasteData` object.
`static String`	`MIMETYPE_TEXT_HTML`	Indicates MIME types of HTML text.
`static String`	`MIMETYPE_TEXT_INTENT`	Indicates MIME types of intents.
`static String`	`MIMETYPE_TEXT_PLAIN`	Indicates MIME types of plain text.
`static String`	`MIMETYPE_TEXT_URI`	Indicates MIME types of URIs.

构造器概要

构造器
构造器说明

PasteData()
A constructor used to create an empty PasteData object.

构造器
构造器	说明
`PasteData()`	A constructor used to create an empty `PasteData` object.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`void`	`addHtmlRecord(String htmlText)`	Adds a `Record` for HTML text to a `PasteData` object, and updates the MIME type to `PasteData#MIMETYPE_TEXT_HTML` in `DataProperty`.
`void`	`addIntentRecord(Intent intent)`	Adds an intent `Record` to a `PasteData` object, and updates the MIME type to `PasteData#MIMETYPE_TEXT_INTENT` in `DataProperty`.
`void`	`addRecord(PasteData.Record record)`	Adds a `PasteRecord` to a `PasteData` object and updates MIME types in `DataProperty`.
`void`	`addTextRecord(CharSequence text)`	Adds a `Record` for plain text to a `PasteData` object, and updates the MIME type to `PasteData#MIMETYPE_TEXT_PLAIN` in `DataProperty`.
`void`	`addUriRecord(Uri uri)`	Adds a URI `Record` to a `PasteData` object, and updates the MIME type to `PasteData#MIMETYPE_TEXT_URI` in `DataProperty`.
`static PasteData`	`creatHtmlData(String htmlText)`	Creates a `PasteData` object for `PasteData#MIMETYPE_TEXT_HTML`.
`static PasteData`	`creatIntentData(Intent intent)`	Creates a `PasteData` object for `PasteData#MIMETYPE_TEXT_INTENT`.
`static PasteData`	`creatPlainTextData(CharSequence text)`	Creates a `PasteData` object for `PasteData#MIMETYPE_TEXT_PLAIN`.
`static PasteData`	`creatUriData(Uri uri)`	Creates a `PasteData` object for `PasteData#MIMETYPE_TEXT_URI`.
`List<String>`	`getMimeTypes()`	Obtains MIME types of all content on the pasteboard.
`String`	`getPrimaryHtml()`	Obtains HTML text of the primary record in a `PasteData` object.
`Intent`	`getPrimaryIntent()`	Obtains the intent of the primary record in a `PasteData` object.
`String`	`getPrimaryMimeType()`	Obtains the MIME type of the primary record in a `PasteData` object.
`CharSequence`	`getPrimaryText()`	Obtains the plain text of the primary record in a `PasteData` object.
`Uri`	`getPrimaryUri()`	Obtains the URI of the primary record in a `PasteData` object.
`PasteData.DataProperty`	`getProperty()`	Obtains `DataProperty` of a `PasteData` object.
`PasteData.Record`	`getRecordAt(int index)`	Obtains a `Record` based on a specified index.
`int`	`getRecordCount()`	Obtains the number of records in a `PasteData` object.
`CharSequence`	`getTag()`	Obtains the user-defined tag of a `PasteData` object.
`boolean`	`hasMimeType(String mimeType)`	Checks whether there is a specified MIME type of data in `DataProperty`.
`boolean`	`marshalling(Parcel parcel)`	Marshals a `PasteData` object into a `Parcel`.
`boolean`	`removeRecordAt(int index)`	Removes a `Record` based on a specified index.
`boolean`	`replaceRecordAt(int index, PasteData.Record record)`	Replaces a specified record with a new one.
`boolean`	`unmarshalling(Parcel parcel)`	Unmarshals a `PasteData` object from a `Parcel`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - MAX_RECORD_NUM
```
public static final int MAX_RECORD_NUM
```
    Indicates the maximum number of records allowed in a PasteData object.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MIMETYPE_TEXT_HTML
```
public static final String MIMETYPE_TEXT_HTML
```
    Indicates MIME types of HTML text.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MIMETYPE_TEXT_INTENT
```
public static final String MIMETYPE_TEXT_INTENT
```
    Indicates MIME types of intents.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MIMETYPE_TEXT_PLAIN
```
public static final String MIMETYPE_TEXT_PLAIN
```
    Indicates MIME types of plain text.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MIMETYPE_TEXT_URI
```
public static final String MIMETYPE_TEXT_URI
```
    Indicates MIME types of URIs.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - PasteData
```
public PasteData()
```
    A constructor used to create an empty PasteData object.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - creatPlainTextData
```
public static PasteData creatPlainTextData(CharSequence text)
```
    Creates a PasteData object for PasteData#MIMETYPE_TEXT_PLAIN.
    
    参数:
    
    text - Indicates the plain text to store.
    
    返回:
    
    Returns the PasteData object if created; returns null if the input parameter is null.
    
    从以下版本开始:
    
    1
  - creatHtmlData
```
public static PasteData creatHtmlData(String htmlText)
```
    Creates a PasteData object for PasteData#MIMETYPE_TEXT_HTML.
    
    参数:
    
    htmlText - Indicates the HTML text to store.
    
    返回:
    
    Returns the PasteData object if created; returns null if the input parameter is null.
    
    从以下版本开始:
    
    1
  - creatUriData
```
public static PasteData creatUriData(Uri uri)
```
    Creates a PasteData object for PasteData#MIMETYPE_TEXT_URI.
    
    参数:
    
    uri - Indicates an URI to store.
    
    返回:
    
    Returns the PasteData object if created; returns null if the input parameter is null.
    
    从以下版本开始:
    
    1
  - creatIntentData
```
public static PasteData creatIntentData(Intent intent)
```
    Creates a PasteData object for PasteData#MIMETYPE_TEXT_INTENT.
    
    参数:
    
    intent - Indicates an intent to store.
    
    返回:
    
    Returns the PasteData object if created; returns null if the input parameter is null.
    
    从以下版本开始:
    
    1
  - getPrimaryMimeType
```
public String getPrimaryMimeType()
```
    Obtains the MIME type of the primary record in a PasteData object.
    
    返回:
    
    Returns the MIME type of the primary record; returns an empty string if there is no record.
    
    从以下版本开始:
    
    1
  - getPrimaryText
```
public CharSequence getPrimaryText()
```
    Obtains the plain text of the primary record in a PasteData object.
    
    返回:
    
    Returns the plain text of the primary record; returns null if there is no record.
    
    从以下版本开始:
    
    1
  - getPrimaryHtml
```
public String getPrimaryHtml()
```
    Obtains HTML text of the primary record in a PasteData object.
    
    返回:
    
    Returns the HTML text of the primary record; returns null if there is no record.
    
    从以下版本开始:
    
    1
  - getPrimaryUri
```
public Uri getPrimaryUri()
```
    Obtains the URI of the primary record in a PasteData object.
    
    返回:
    
    Returns the URI of the primary record; returns null if there is no record.
    
    从以下版本开始:
    
    1
  - getPrimaryIntent
```
public Intent getPrimaryIntent()
```
    Obtains the intent of the primary record in a PasteData object.
    
    返回:
    
    Returns the intent of the primary record; returns null if there is no record.
    
    从以下版本开始:
    
    1
  - addTextRecord
```
public void addTextRecord(CharSequence text)
```
    Adds a Record for plain text to a PasteData object, and updates the MIME type to PasteData#MIMETYPE_TEXT_PLAIN in DataProperty.
    Note that after the maximum number of records allowed in the PasteData object has been reached, the addition will be invalid.
    
    参数:
    
    text - Indicates the plain text to add. This parameter cannot be null. Otherwise, the addition will fail.
    
    从以下版本开始:
    
    1
  - addHtmlRecord
```
public void addHtmlRecord(String htmlText)
```
    Adds a Record for HTML text to a PasteData object, and updates the MIME type to PasteData#MIMETYPE_TEXT_HTML in DataProperty.
    Note that after the maximum number of records allowed in the PasteData object has been reached, the addition will be invalid.
    
    参数:
    
    htmlText - Indicates HTML text to add. This parameter cannot be null. Otherwise, the addition will fail.
    
    从以下版本开始:
    
    1
  - addUriRecord
```
public void addUriRecord(Uri uri)
```
    Adds a URI Record to a PasteData object, and updates the MIME type to PasteData#MIMETYPE_TEXT_URI in DataProperty.
    Note that after the maximum number of records allowed in the PasteData object has been reached, the addition will be invalid.
    
    参数:
    
    uri - Indicates the URI to add. This parameter cannot be null. Otherwise, the addition will fail.
    
    从以下版本开始:
    
    1
  - addIntentRecord
```
public void addIntentRecord(Intent intent)
```
    Adds an intent Record to a PasteData object, and updates the MIME type to PasteData#MIMETYPE_TEXT_INTENT in DataProperty.
    Note that after the maximum number of records allowed in the PasteData object has been reached, the addition will be invalid.
    
    参数:
    
    intent - Indicates the intent to add. This parameter cannot be null. Otherwise, the addition will fail.
    
    从以下版本开始:
    
    1
  - addRecord
```
public void addRecord(PasteData.Record record)
```
    Adds a PasteRecord to a PasteData object and updates MIME types in DataProperty.
    Note that after the maximum number of records allowed in the PasteData object has been reached, the addition will be invalid.
    
    参数:
    
    record - Indicates the Record object to add. This parameter cannot be null. Otherwise, the addition will fail.
    
    从以下版本开始:
    
    1
  - getRecordCount
```
public int getRecordCount()
```
    Obtains the number of records in a PasteData object.
    
    返回:
    
    Returns the number of records of this PasteData.
    
    从以下版本开始:
    
    1
  - getRecordAt
```
public PasteData.Record getRecordAt(int index)
```
    Obtains a Record based on a specified index.
    
    参数:
    
    index - Indicates the index of the record to obtain, which ranges from 0 to getRecordCount()-1.
    
    返回:
    
    Returns the record content; returns null if no record matching the index.
    
    从以下版本开始:
    
    1
  - removeRecordAt
```
public boolean removeRecordAt(int index)
```
    Removes a Record based on a specified index.
    
    参数:
    
    index - Indicates the index of the record to remove, which ranges from 0 to getRecordCount()-1.
    
    返回:
    
    Returns true if the record is removed; returns false otherwise.
    
    从以下版本开始:
    
    1
  - replaceRecordAt
```
public boolean replaceRecordAt(int index,
                               PasteData.Record record)
```
    Replaces a specified record with a new one.
    The record index ranges from 0 to getRecordCount()-1.
    
    参数:
    
    index - Indicates the index of the record to be replaced, which ranges from 0 to getRecordCount()-1.
    
    record - Indicates the new record.
    
    返回:
    
    Returns true if the replacement is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getMimeTypes
```
public List<String> getMimeTypes()
```
    Obtains MIME types of all content on the pasteboard.
    
    返回:
    
    Returns a non-repeating MIME type list in DataProperty; returns an empty list if there is no data.
    
    从以下版本开始:
    
    1
  - hasMimeType
```
public boolean hasMimeType(String mimeType)
```
    Checks whether there is a specified MIME type of data in DataProperty.
    
    参数:
    
    mimeType - Indicates a MIME type to search.
    
    返回:
    
    Returns true if DataProperty contains the MIME type; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getProperty
```
public PasteData.DataProperty getProperty()
```
    Obtains DataProperty of a PasteData object.
    
    返回:
    
    Returns the DataProperty of this PasteData.
    
    从以下版本开始:
    
    1
  - getTag
```
public CharSequence getTag()
```
    Obtains the user-defined tag of a PasteData object.
    
    返回:
    
    Returns the tag if obtained; returns an empty string if not tag was set.
    
    从以下版本开始:
    
    1
  - marshalling
```
public boolean marshalling(Parcel parcel)
```
    Marshals a PasteData object into a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    parcel - Indicates the Parcel object for marshalling.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - unmarshalling
```
public boolean unmarshalling(Parcel parcel)
```
    Unmarshals a PasteData object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    parcel - Indicates the Parcel object for unmarshalling.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1

类 PasteData

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

构造器概要

方法概要

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

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

MAX_RECORD_NUM

MIMETYPE_TEXT_HTML

MIMETYPE_TEXT_INTENT

MIMETYPE_TEXT_PLAIN

MIMETYPE_TEXT_URI

构造器详细资料

PasteData

方法详细资料

creatPlainTextData

creatHtmlData

creatUriData

creatIntentData

getPrimaryMimeType

getPrimaryText

getPrimaryHtml

getPrimaryUri

getPrimaryIntent

addTextRecord

addHtmlRecord

addUriRecord

addIntentRecord

addRecord

getRecordCount

getRecordAt

removeRecordAt

replaceRecordAt

getMimeTypes

hasMimeType

getProperty

getTag

marshalling

unmarshalling