鴻蒙OS NotificationRequest.NotificationConversationalContent

NotificationRequest.NotificationConversationalContent

java.lang.Object

|---ohos.event.notification.NotificationRequest.NotificationConversationalContent

public static final class NotificationRequest.NotificationConversationalContent
extends Object
implements Sequenceable

構(gòu)造一個(gè)類似對(duì)話的通知，其中包括多個(gè)用戶之間的消息通信。

構(gòu)造類會(huì)話通知時(shí)，需要調(diào)用 NotificationRequest#setContent(NotificationContent) 設(shè)置對(duì)應(yīng)的通知內(nèi)容類型。 您可以調(diào)用 setConversationTitle(java.lang.String) 來(lái)設(shè)置對(duì)話的標(biāo)題，并調(diào)用 addConversationalMessage(ohos.event.notification.NotificationRequest.NotificationConversationalContent.ConversationalMessage) 來(lái)添加包含在對(duì)話中的消息。 使用這兩種方法設(shè)置的標(biāo)題和消息會(huì)影響分別調(diào)用 setTitle(java.lang.String) 和 setText(java.lang.String) 設(shè)置的標(biāo)題和文本的顯示效果。

Since:

3

嵌套類摘要

修飾符和類型	類	描述
static class	NotificationRequest.NotificationConversationalContent.ConversationalMessage	提供用于定義在使用 NotificationConversationalContent 創(chuàng)建的通知中使用的會(huì)話消息的方法。

從接口 ohos.utils.Sequenceable 繼承的嵌套類/接口
Sequenceable.ProducerT

構(gòu)造函數(shù)摘要

構(gòu)造函數(shù)	描述
NotificationConversationalContent(MessageUser user)	用于創(chuàng)建具有指定 MessageUser 的 NotificationConversationalContent 實(shí)例的構(gòu)造函數(shù)。

方法總結(jié)

修飾符和類型	方法	描述
NotificationRequest.NotificationConversationalContent	addConversationalMessage(String text, long timestamp, MessageUser sender)	根據(jù)指定的消息內(nèi)容、時(shí)間戳和 MessageUser 向此類似對(duì)話的通知添加消息。
NotificationRequest.NotificationConversationalContent	addConversationalMessage(NotificationRequest.NotificationConversationalContent.ConversationalMessage message)	將指定消息添加到此類似對(duì)話的通知中。
String	getAdditionalText()	獲取已通過(guò)調(diào)用 setAdditionalText(java.lang.String) 為這個(gè)類似對(duì)話的通知設(shè)置的附加文本。
ListNotificationRequest.NotificationConversationalContent.ConversationalMessage	getAllConversationalMessages()	獲取包含在此類似對(duì)話的通知中的所有消息。
String	getConversationTitle()	獲取要為對(duì)話顯示的標(biāo)題。
MessageUser	getMessageUser()	獲取用戶在此類似對(duì)話的通知中發(fā)送的任何消息要顯示的消息發(fā)件人。
String	getText()	獲取該類會(huì)話通知調(diào)用 setText(java.lang.String) 設(shè)置的通知內(nèi)容。
String	getTitle()	獲取通過(guò)調(diào)用 setTitle(java.lang.String) 為這個(gè)類似對(duì)話的通知設(shè)置的標(biāo)題。
boolean	isConversationGroup()	檢查此通知是否代表群組對(duì)話。
boolean	marshalling(Parcel out)	將此通知對(duì)話內(nèi)容對(duì)象編組到包裹中。
NotificationRequest.NotificationConversationalContent	setAdditionalText(String additionalText)	設(shè)置要包含在此類似對(duì)話的通知中的附加文本。
NotificationRequest.NotificationConversationalContent	setConversationGroup(boolean conversationGroup)	設(shè)置此通知是否代表群組對(duì)話。
NotificationRequest.NotificationConversationalContent	setConversationTitle(String conversationTitle)	設(shè)置要為對(duì)話顯示的標(biāo)題。
NotificationRequest.NotificationConversationalContent	setText(String text)	設(shè)置要包含在此類似對(duì)話的通知中的文本。
NotificationRequest.NotificationConversationalContent	setTitle(String title)	設(shè)置此對(duì)話式通知的標(biāo)題。
String	toString()	返回對(duì)象的字符串表示形式。
boolean	unmarshalling(Parcel in)	從 Parcel 中解組此 NotificationConversationalContent 對(duì)象。

從類 java.lang.Object 繼承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

從接口 ohos.utils.Sequenceable 繼承的方法
hasFileDescriptor

構(gòu)造函數(shù)詳細(xì)信息

NotificationConversationalContent

public NotificationConversationalContent(MessageUser user) throws IllegalArgumentException

用于創(chuàng)建具有指定 MessageUser 的 NotificationConversationalContent 實(shí)例的構(gòu)造函數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
user	指示在此類似對(duì)話的通知中發(fā)送所有 Message 對(duì)象的 MessageUser。 此參數(shù)不能為空。

Throws:

Throw名稱	Throw描述
IllegalArgumentException	如果 user 為 null，則引發(fā)此異常。

Since:

3

方法詳情

getMessageUser

public MessageUser getMessageUser()

獲取用戶在此類似對(duì)話的通知中發(fā)送的任何消息要顯示的消息發(fā)件人。

返回:

返回消息發(fā)送者。

Since:

3

getTitle

public String getTitle()

獲取通過(guò)調(diào)用 setTitle(java.lang.String) 為這個(gè)類似對(duì)話的通知設(shè)置的標(biāo)題。

如果 setConversationTitle(java.lang.String) 與 addConversationalMessage(ohos.event.notification.NotificationRequest.NotificationConversationalContent.ConversationalMessage) 或 addConversationalMessage(java.lang.String,long,ohos.event.notification.MessageUser) 一起調(diào)用此通知， 此方法的返回值將是 getConversationTitle() 的返回值和最后添加的 Message 的 MessageUser 上調(diào)用的 MessageUser#getName() 的返回值的組合。

返回:

返回此通知的標(biāo)題。

Since:

3

setTitle

public NotificationRequest.NotificationConversationalContent setTitle(String title)

設(shè)置此對(duì)話式通知的標(biāo)題。

參數(shù)：

參數(shù)名稱	參數(shù)描述
title	指示此類似對(duì)話的通知的標(biāo)題。

返回:

返回此 NotificationConversationalContent 對(duì)象。

Since:

3

getText

public String getText()

獲取該類會(huì)話通知調(diào)用 setText(java.lang.String) 設(shè)置的通知內(nèi)容。

如果還為此通知調(diào)用 addConversationalMessage(ohos.event.notification.NotificationRequest.NotificationConversationalContent.ConversationalMessage) 或 addConversationalMessage(java.lang.String,long,ohos.event.notification.MessageUser)，則此方法的返回值將是 在最后添加的消息上調(diào)用的 ConversationalMessage#getText() 的返回值。

返回:

返回通知內(nèi)容。

Since:

3

setText

public NotificationRequest.NotificationConversationalContent setText(String text)

設(shè)置要包含在此類似對(duì)話的通知中的文本。 如果此通知也調(diào)用了 setConversationTitle(java.lang.String)，則此方法不生效。

參數(shù)：

參數(shù)名稱	參數(shù)描述
text	指示要包含的文本。

返回:

返回此 NotificationConversationalContent 對(duì)象。

Since:

3

getAdditionalText

public String getAdditionalText()

獲取已通過(guò)調(diào)用 setAdditionalText(java.lang.String) 為這個(gè)類似對(duì)話的通知設(shè)置的附加文本。

返回:

返回此通知的附加文本。

Since:

3

setAdditionalText

public NotificationRequest.NotificationConversationalContent setAdditionalText(String additionalText)

設(shè)置要包含在此類似對(duì)話的通知中的附加文本。

附加文本是對(duì)通過(guò)調(diào)用 setText(java.lang.String) 設(shè)置的通知文本的補(bǔ)充。 附加文本的字體小于通知文本，并在單獨(dú)的行中顯示。

參數(shù)：

參數(shù)名稱	參數(shù)描述
additionalText	指示要包含的附加文本。

返回:

返回此 NotificationConversationalContent 對(duì)象。

Since:

3

getConversationTitle

public String getConversationTitle()

獲取要為對(duì)話顯示的標(biāo)題。

返回:

返回要為對(duì)話顯示的標(biāo)題。

Since:

3

setConversationTitle

public NotificationRequest.NotificationConversationalContent setConversationTitle(String conversationTitle)

設(shè)置要為對(duì)話顯示的標(biāo)題。

此方法中設(shè)置的標(biāo)題將通過(guò)調(diào)用 setTitle(java.lang.String) 覆蓋一組。

參數(shù)：

參數(shù)名稱	參數(shù)描述
conversationTitle	指示要為對(duì)話顯示的標(biāo)題。

返回:

返回此 NotificationConversationalContent 對(duì)象。

Since:

3

isConversationGroup

public boolean isConversationGroup()

檢查此通知是否代表群組對(duì)話。

返回:

如果此通知表示群組對(duì)話，則返回 true； 否則返回 false。

Since:

3

setConversationGroup

public NotificationRequest.NotificationConversationalContent setConversationGroup(boolean conversationGroup)

設(shè)置此通知是否代表群組對(duì)話。

通過(guò)調(diào)用 NotificationRequest#setBigIcon(PixelMap) 為該通知設(shè)置的大圖標(biāo)（如果有）僅在此方法設(shè)置為 true 時(shí)才會(huì)顯示。

參數(shù)：

參數(shù)名稱	參數(shù)描述
conversationGroup	指定此通知是否代表組對(duì)話。 true 表示群聊，false 表示不是。

返回:

返回此 NotificationConversationalContent 對(duì)象。

Since:

3

getAllConversationalMessages

public ListNotificationRequest.NotificationConversationalContent.ConversationalMessage getAllConversationalMessages()

獲取包含在此類似對(duì)話的通知中的所有消息。

返回:

返回包含的所有 Message 對(duì)象的列表。

Since:

3

addConversationalMessage

public NotificationRequest.NotificationConversationalContent addConversationalMessage(NotificationRequest.NotificationConversationalContent.ConversationalMessage message)

將指定消息添加到此類似對(duì)話的通知中。 所有消息將按添加順序顯示。

參數(shù)：

參數(shù)名稱	參數(shù)描述
message	指示要添加的 ConversationalMessage 對(duì)象。

返回:

返回此 NotificationConversationalContent 對(duì)象。

Since:

3

addConversationalMessage

public NotificationRequest.NotificationConversationalContent addConversationalMessage(String text, long timestamp, MessageUser sender) throws IllegalArgumentException

根據(jù)指定的消息內(nèi)容、時(shí)間戳和 MessageUser 向此類似對(duì)話的通知添加消息。 所有消息將按添加順序顯示。

參數(shù)：

參數(shù)名稱	參數(shù)描述
text	指示要作為消息內(nèi)容顯示的文本。 此參數(shù)不能為空。
timestamp	指示消息到達(dá)的時(shí)間。
sender	指示發(fā)送消息的 MessageUser。

返回:

返回此 NotificationConversationalContent 對(duì)象。

Throws:

Throw名稱	Throw描述
IllegalArgumentException	如果 text 為 null，則引發(fā)此異常。

Since:

3

marshalling

public boolean marshalling(Parcel out)

將此 NotificationConversationalContent 對(duì)象編組為 Parcel。

進(jìn)程可以調(diào)用 unmarshalling(ohos.utils.Parcel) 方法從 Parcel 中解組此 NotificationConversationalContent 對(duì)象，以實(shí)現(xiàn)進(jìn)程間通信 (IPC)。

指定者：

接口 Sequenceable 中的編組

參數(shù)：

參數(shù)名稱	參數(shù)描述
out	指示用于編組的 Parcel 對(duì)象。

返回:

如果編組成功，則返回 true； 否則返回 false。

Since:

3

unmarshalling

public boolean unmarshalling(Parcel in)

從 Parcel 中解組此 NotificationConversationalContent 對(duì)象。

指定者：

在接口 Sequenceable 中解組

參數(shù)：

參數(shù)名稱	參數(shù)描述
in	指示用于解組的 Parcel 對(duì)象。

返回:

如果解組成功，則返回 true； 否則返回 false。

Since:

3

toString

public String toString()

從類復(fù)制的描述：對(duì)象

返回對(duì)象的字符串表示形式。 通常，toString 方法返回一個(gè)“以文本方式表示”該對(duì)象的字符串。 結(jié)果應(yīng)該是一個(gè)簡(jiǎn)潔但信息豐富的表示，易于人們閱讀。 建議所有子類重寫此方法。

Object 類的 toString 方法返回一個(gè)字符串，該字符串由對(duì)象作為其實(shí)例的類的名稱、at 符號(hào)字符“@”和對(duì)象哈希碼的無(wú)符號(hào)十六進(jìn)制表示形式組成。 換句話說(shuō)，此方法返回一個(gè)等于以下值的字符串：

 getClass().getName() + '@' + Integer.toHexString(hashCode()) 

覆蓋：

類 Object 中的 toString

返回:

對(duì)象的字符串表示形式。

Since:

4