NotificationRequest.NotificationConversationalContent

java.lang.Object
- ohos.event.notification.NotificationRequest.NotificationConversationalContent

所有已实现的接口:

Sequenceable

封闭类:

NotificationRequest
```
public static final class NotificationRequest.NotificationConversationalContent
extends Object
implements Sequenceable
```
Constructs a conversation-like notification that includes message communication among multiple users.
When constructing a conversation-like notification, you need to call NotificationRequest#setContent(NotificationContent) to set the corresponding notification content type. You can call setConversationTitle(java.lang.String) to set the title for the conversation and addConversationalMessage(ohos.event.notification.NotificationRequest.NotificationConversationalContent.ConversationalMessage) to add messages included in the conversation. The title and messages set using these two methods will affect the display effect of the title and text set by calling setTitle(java.lang.String) and setText(java.lang.String), respectively.

从以下版本开始:

3

SystemCapability

SystemCapability.Notification#ANS

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`NotificationRequest.NotificationConversationalContent.ConversationalMessage`	Provides methods for defining a conversational message that is used in notifications created with `NotificationConversationalContent`.

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

构造器概要

构造器
构造器说明

NotificationConversationalContent(MessageUser user)
A constructor used to create a NotificationConversationalContent instance with the MessageUser specified.

构造器
构造器	说明
`NotificationConversationalContent(MessageUser user)`	A constructor used to create a `NotificationConversationalContent` instance with the `MessageUser` specified.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`NotificationRequest.NotificationConversationalContent`	`addConversationalMessage(String text, long timestamp, MessageUser sender)`	Adds a message to this conversation-like notification based on the specified message content, timestamp, and `MessageUser`.
`NotificationRequest.NotificationConversationalContent`	`addConversationalMessage(NotificationRequest.NotificationConversationalContent.ConversationalMessage message)`	Adds a specified message to this conversation-like notification.
`String`	`getAdditionalText()`	Obtains the additional text that has been set by calling `setAdditionalText(java.lang.String)` for this conversation-like notification.
`List<NotificationRequest.NotificationConversationalContent.ConversationalMessage>`	`getAllConversationalMessages()`	Obtains all messages included in this conversation-like notification.
`String`	`getConversationTitle()`	Obtains the title to be displayed for the conversation.
`MessageUser`	`getMessageUser()`	Obtains the message sender to be displayed for any messages sent by the user in this conversation-like notification.
`String`	`getText()`	Obtains the notification content that has been set by calling `setText(java.lang.String)` for this conversation-like notification.
`String`	`getTitle()`	Obtains the title that has been set by calling `setTitle(java.lang.String)` for this conversation-like notification.
`boolean`	`isConversationGroup()`	Checks whether this notification represents a group conversation.
`boolean`	`marshalling(Parcel out)`	Marshals this `NotificationConversationalContent` object into a `Parcel`.
`NotificationRequest.NotificationConversationalContent`	`setAdditionalText(String additionalText)`	Sets the additional text to be included in this conversation-like notification.
`NotificationRequest.NotificationConversationalContent`	`setConversationGroup(boolean conversationGroup)`	Sets whether this notification represents a group conversation.
`NotificationRequest.NotificationConversationalContent`	`setConversationTitle(String conversationTitle)`	Sets the title to be displayed for the conversation.
`NotificationRequest.NotificationConversationalContent`	`setText(String text)`	Sets the text to be included in this conversation-like notification.
`NotificationRequest.NotificationConversationalContent`	`setTitle(String title)`	Sets the title of this conversation-like notification.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals this `NotificationConversationalContent` object from a `Parcel`.

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

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

- 构造器详细资料
  - NotificationConversationalContent
```
public NotificationConversationalContent(MessageUser user)
                                  throws IllegalArgumentException
```
    A constructor used to create a NotificationConversationalContent instance with the MessageUser specified.
    
    参数:
    
    user - Indicates the MessageUser who sends all Message objects in this conversation-like notification. This parameter cannot be null.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if user is null.
    
    从以下版本开始:
    
    3
- 方法详细资料
  - getMessageUser
```
public MessageUser getMessageUser()
```
    Obtains the message sender to be displayed for any messages sent by the user in this conversation-like notification.
    
    返回:
    
    Returns the message sender.
    
    从以下版本开始:
    
    3
  - getTitle
```
public String getTitle()
```
    Obtains the title that has been set by calling setTitle(java.lang.String) for this conversation-like notification.
    If setConversationTitle(java.lang.String) is called together with addConversationalMessage(ohos.event.notification.NotificationRequest.NotificationConversationalContent.ConversationalMessage) or addConversationalMessage(java.lang.String,long,ohos.event.notification.MessageUser) for this notification, the return value of this method will be a combination of the return value of getConversationTitle() and that of MessageUser#getName() called on the MessageUser of the last added Message.
    
    返回:
    
    Returns the title of this notification.
    
    从以下版本开始:
    
    3
  - setTitle
```
public NotificationRequest.NotificationConversationalContent setTitle(String title)
```
    Sets the title of this conversation-like notification.
    
    参数:
    
    title - Indicates the title of this conversation-like notification.
    
    返回:
    
    Returns this NotificationConversationalContent object.
    
    从以下版本开始:
    
    3
  - getText
```
public String getText()
```
    Obtains the notification content that has been set by calling setText(java.lang.String) for this conversation-like notification.
    If addConversationalMessage(ohos.event.notification.NotificationRequest.NotificationConversationalContent.ConversationalMessage) or addConversationalMessage(java.lang.String,long,ohos.event.notification.MessageUser) is also called for this notification, the return value of this method will be the return value of ConversationalMessage#getText() called on the last added Message.
    
    返回:
    
    Returns the notification content.
    
    从以下版本开始:
    
    3
  - setText
```
public NotificationRequest.NotificationConversationalContent setText(String text)
```
    Sets the text to be included in this conversation-like notification. This method does not take effect if setConversationTitle(java.lang.String) is also called for this notification.
    
    参数:
    
    text - Indicates the text to be included.
    
    返回:
    
    Returns this NotificationConversationalContent object.
    
    从以下版本开始:
    
    3
  - getAdditionalText
```
public String getAdditionalText()
```
    Obtains the additional text that has been set by calling setAdditionalText(java.lang.String) for this conversation-like notification.
    
    返回:
    
    Returns the additional text of this notification.
    
    从以下版本开始:
    
    3
  - setAdditionalText
```
public NotificationRequest.NotificationConversationalContent setAdditionalText(String additionalText)
```
    Sets the additional text to be included in this conversation-like notification.
    The additional text is a supplement to the notification text set by calling setText(java.lang.String). The font of the additional text is smaller than the notification text and is displayed in a separate line.
    
    参数:
    
    additionalText - Indicates the additional text to be included.
    
    返回:
    
    Returns this NotificationConversationalContent object.
    
    从以下版本开始:
    
    3
  - getConversationTitle
```
public String getConversationTitle()
```
    Obtains the title to be displayed for the conversation.
    
    返回:
    
    Returns the title to be displayed for the conversation.
    
    从以下版本开始:
    
    3
  - setConversationTitle
```
public NotificationRequest.NotificationConversationalContent setConversationTitle(String conversationTitle)
```
    Sets the title to be displayed for the conversation.
    The title set in this method will overwrite the one set by calling setTitle(java.lang.String).
    
    参数:
    
    conversationTitle - Indicates the title to be displayed for the conversation.
    
    返回:
    
    Returns this NotificationConversationalContent object.
    
    从以下版本开始:
    
    3
  - isConversationGroup
```
public boolean isConversationGroup()
```
    Checks whether this notification represents a group conversation.
    
    返回:
    
    Returns true if this notification represents a group conversation; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setConversationGroup
```
public NotificationRequest.NotificationConversationalContent setConversationGroup(boolean conversationGroup)
```
    Sets whether this notification represents a group conversation.
    The big icon, if any, set for this notification by calling NotificationRequest#setBigIcon(PixelMap) will be displayed only when this method is set to true.
    
    参数:
    
    conversationGroup - Specifies whether this notification represents a group conversation. The value true indicates a group conversation, and the value false indicates not.
    
    返回:
    
    Returns this NotificationConversationalContent object.
    
    从以下版本开始:
    
    3
  - getAllConversationalMessages
```
public List<NotificationRequest.NotificationConversationalContent.ConversationalMessage> getAllConversationalMessages()
```
    Obtains all messages included in this conversation-like notification.
    
    返回:
    
    Returns the list of all Message objects included.
    
    从以下版本开始:
    
    3
  - addConversationalMessage
```
public NotificationRequest.NotificationConversationalContent addConversationalMessage(NotificationRequest.NotificationConversationalContent.ConversationalMessage message)
```
    Adds a specified message to this conversation-like notification. All messages will be displayed in the order they are added.
    
    参数:
    
    message - Indicates the ConversationalMessage object to add.
    
    返回:
    
    Returns this NotificationConversationalContent object.
    
    从以下版本开始:
    
    3
  - addConversationalMessage
```
public NotificationRequest.NotificationConversationalContent addConversationalMessage(String text,
                                                                                      long timestamp,
                                                                                      MessageUser sender)
                                                                               throws IllegalArgumentException
```
    Adds a message to this conversation-like notification based on the specified message content, timestamp, and MessageUser. All messages will be displayed in the order they are added.
    
    参数:
    
    text - Indicates the text to be displayed as the message content. This parameter cannot be null.
    
    timestamp - Indicates the time when the message arrived.
    
    sender - Indicates the MessageUser who sent the message.
    
    返回:
    
    Returns this NotificationConversationalContent object.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if text is null.
    
    从以下版本开始:
    
    3
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals this NotificationConversationalContent object into a Parcel.
    A process can call the unmarshalling(ohos.utils.Parcel) method to unmarshal this NotificationConversationalContent object from a Parcel to implement inter-process communication (IPC).
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object for marshalling.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshals this NotificationConversationalContent object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object for unmarshalling.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.
    
    从以下版本开始:
    
    4

类 NotificationRequest.NotificationConversationalContent

嵌套类概要

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

构造器概要

方法概要

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

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

构造器详细资料

NotificationConversationalContent

方法详细资料

getMessageUser

getTitle

setTitle

getText

setText

getAdditionalText

setAdditionalText

getConversationTitle

setConversationTitle

isConversationGroup

setConversationGroup

getAllConversationalMessages

addConversationalMessage

addConversationalMessage

marshalling

unmarshalling

toString