MessageItem

java.lang.Object
- ohos.data.search.model.IndexData
- - ohos.data.search.schema.Schema<MessageItem>
  - - ohos.data.search.schema.MessageItem

```
public final class MessageItem
extends Schema<MessageItem>
```
Represents the index schema for message items.
This schema is used to create indexes for message items. It supports index fields attachment, content, senderName, senderPhone, recipientName, recipientPhone, and all the fields in CommonItem. Among these fields, identifier is mandatory and can be set via the CommonItem#setIdentifier(String) method.

从以下版本开始:

5

SystemCapability

SystemCapability.Data#DATA_SEARCH

字段概要

字段
限定符和类型	字段	说明
`static String`	`ATTACHMENT`	Indicates the index field name of `attachment`.
`static String`	`CONTENT`	Indicates the index field name of `content`.
`static String`	`RECIPIENT_NAME`	Indicates the index field name of `recipientName`.
`static String`	`RECIPIENT_PHONE`	Indicates the index field name of `recipientPhone`.
`static String`	`SENDER_NAME`	Indicates the index field name of `senderName`.
`static String`	`SENDER_PHONE`	Indicates the index field name of `senderPhone`.

构造器概要

构造器
构造器说明

MessageItem()
A constructor used to create a MessageItem instance.

构造器
构造器	说明
`MessageItem()`	A constructor used to create a `MessageItem` instance.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`String`	`getAttachment()`	Obtains the value of the `attachment` index field.
`String`	`getContent()`	Obtains the value of the `content` index field.
`static List<IndexForm>`	`getMessageSchema()`	Obtains a list of index field attributes in this `MessageItem` object.
`String`	`getRecipientName()`	Obtains the value of the `recipientName` index field.
`String`	`getRecipientPhone()`	Obtains the value of the `recipientPhone` index field.
`String`	`getSenderName()`	Obtains the value of the `senderName` index field.
`String`	`getSenderPhone()`	Obtains the value of the `senderPhone` index field.
`MessageItem`	`setAttachment(String attachment)`	Sets the `attachment` index field.
`MessageItem`	`setContent(String content)`	Sets the `content` index field.
`MessageItem`	`setRecipientName(String recipientName)`	Sets the `recipientName` index field.
`MessageItem`	`setRecipientPhone(String recipientPhone)`	Sets the `recipientPhone` index field.
`MessageItem`	`setSenderName(String senderName)`	Sets the `senderName` index field.
`MessageItem`	`setSenderPhone(String senderPhone)`	Sets the `senderPhone` index field.

从类继承的方法 ohos.data.search.model.IndexData
clear, get, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getValues, isEmpty, put, put, put, put, put, remove, setValues, size

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

从类继承的方法 ohos.data.search.schema.Schema
getAlternateName, getCategory, getDateCreate, getDescription, getIdentifier, getKeywords, getName, getPotentialAction, getReserved1, getReserved2, getSubtitle, getThumbnailUrl, getTitle, getUrl, setAlternateName, setCategory, setDateCreate, setDescription, setIdentifier, setKeywords, setName, setPotentialAction, setReserved1, setReserved2, setSubtitle, setThumbnailUrl, setTitle, setUrl

- 字段详细资料
  - ATTACHMENT
```
public static final String ATTACHMENT
```
    Indicates the index field name of attachment.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - CONTENT
```
public static final String CONTENT
```
    Indicates the index field name of content.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - RECIPIENT_NAME
```
public static final String RECIPIENT_NAME
```
    Indicates the index field name of recipientName.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - RECIPIENT_PHONE
```
public static final String RECIPIENT_PHONE
```
    Indicates the index field name of recipientPhone.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - SENDER_NAME
```
public static final String SENDER_NAME
```
    Indicates the index field name of senderName.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
  - SENDER_PHONE
```
public static final String SENDER_PHONE
```
    Indicates the index field name of senderPhone.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - MessageItem
```
public MessageItem()
```
    A constructor used to create a MessageItem instance.
    
    从以下版本开始:
    
    5
- 方法详细资料
  - getMessageSchema
```
public static List<IndexForm> getMessageSchema()
```
    Obtains a list of index field attributes in this MessageItem object.
    
    返回:
    
    Returns a list of index field attributes.
    
    从以下版本开始:
    
    5
  - setSenderName
```
public MessageItem setSenderName(String senderName)
```
    Sets the senderName index field.
    Attributes of this index field: IndexForm.indexFieldName = "senderName"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    senderName - Indicates the sender's name.
    
    返回:
    
    Returns this MessageItem object.
    
    从以下版本开始:
    
    5
  - setSenderPhone
```
public MessageItem setSenderPhone(String senderPhone)
```
    Sets the senderPhone index field.
    Attributes of this index field: IndexForm.indexFieldName = "senderPhone"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    senderPhone - Indicates the sender's phone number.
    
    返回:
    
    Returns this MessageItem object.
    
    从以下版本开始:
    
    5
  - setRecipientName
```
public MessageItem setRecipientName(String recipientName)
```
    Sets the recipientName index field.
    Attributes of this index field: IndexForm.indexFieldName = "recipientName"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    recipientName - Indicates the recipient's name.
    
    返回:
    
    Returns this MessageItem object.
    
    从以下版本开始:
    
    5
  - setRecipientPhone
```
public MessageItem setRecipientPhone(String recipientPhone)
```
    Sets the recipientPhone index field.
    Attributes of this index field: IndexForm.indexFieldName = "recipientPhone"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    recipientPhone - Indicates the recipient's phone number.
    
    返回:
    
    Returns this MessageItem object.
    
    从以下版本开始:
    
    5
  - setContent
```
public MessageItem setContent(String content)
```
    Sets the content index field.
    Attributes of this index field: IndexForm.indexFieldName = "content"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;
    
    参数:
    
    content - Indicates the message content.
    
    返回:
    
    Returns this MessageItem object.
    
    从以下版本开始:
    
    5
  - setAttachment
```
public MessageItem setAttachment(String attachment)
```
    Sets the attachment index field.
    Attributes of this index field: IndexForm.indexFieldName = "attachment"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = false; IndexForm.isSearch = true;
    
    参数:
    
    attachment - Indicates the message attachment.
    
    返回:
    
    Returns this MessageItem object.
    
    从以下版本开始:
    
    5
  - getSenderName
```
public String getSenderName()
```
    Obtains the value of the senderName index field.
    
    返回:
    
    Returns the value of the senderName index field.
    
    从以下版本开始:
    
    5
  - getSenderPhone
```
public String getSenderPhone()
```
    Obtains the value of the senderPhone index field.
    
    返回:
    
    Returns the value of the senderPhone index field.
    
    从以下版本开始:
    
    5
  - getRecipientName
```
public String getRecipientName()
```
    Obtains the value of the recipientName index field.
    
    返回:
    
    Returns the value of the recipientName index field.
    
    从以下版本开始:
    
    5
  - getRecipientPhone
```
public String getRecipientPhone()
```
    Obtains the value of the recipientPhone index field.
    
    返回:
    
    Returns the value of the recipientPhone index field.
    
    从以下版本开始:
    
    5
  - getContent
```
public String getContent()
```
    Obtains the value of the content index field.
    
    返回:
    
    Returns the value of the content index field.
    
    从以下版本开始:
    
    5
  - getAttachment
```
public String getAttachment()
```
    Obtains the value of the attachment index field.
    
    返回:
    
    Returns the value of the attachment index field.
    
    从以下版本开始:
    
    5

类 MessageItem

字段概要

构造器概要

方法概要

从类继承的方法 ohos.data.search.model.IndexData

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

从类继承的方法 ohos.data.search.schema.Schema

字段详细资料

ATTACHMENT

CONTENT

RECIPIENT_NAME

RECIPIENT_PHONE

SENDER_NAME

SENDER_PHONE

构造器详细资料

MessageItem

方法详细资料

getMessageSchema

setSenderName

setSenderPhone

setRecipientName

setRecipientPhone

setContent

setAttachment

getSenderName

getSenderPhone

getRecipientName

getRecipientPhone

getContent

getAttachment