鴻蒙OS NotificationRequest.NotificationMediaContent

NotificationRequest.NotificationMediaContent

java.lang.Object

|---ohos.event.notification.NotificationRequest.NotificationMediaContent

public static final class NotificationRequest.NotificationMediaContent
extends Object
implements Sequenceable

構(gòu)造一個(gè)可以與關(guān)聯(lián)的音頻會(huì)話交互的媒體播放通知。

在構(gòu)造這個(gè)通知之前，你應(yīng)該首先初始化一個(gè) NotificationMediaContent 對(duì)象，并調(diào)用 setAVToken(ohos.media.common.sessioncore.AVToken) 為其附加一個(gè) AVToken 以建立與關(guān)聯(lián)的 AVSession 的交互通道。 您可以調(diào)用 [setShownActions(int]) 來請(qǐng)求在此通知中顯示 NotificationActionButton 對(duì)象。 然后，您應(yīng)該初始化一個(gè) NotificationRequest 對(duì)象并調(diào)用 NotificationRequest#setContent(NotificationContent) 將其設(shè)置為媒體播放通知，并將先前構(gòu)造的 NotificationMediaContent 對(duì)象附加到它。 此外，您應(yīng)該調(diào)用 NotificationRequest#addActionButton(NotificationActionButton) 以便媒體控制按鈕在此通知發(fā)布后顯示在此通知中。

Since:

3

嵌套類摘要

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

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

構(gòu)造函數(shù)	描述
NotificationMediaContent()	用于創(chuàng)建 NotificationMediaContent 實(shí)例的默認(rèn)構(gòu)造函數(shù)。

方法總結(jié)

修飾符和類型	方法	描述
String	getAdditionalText()	通過為此媒體播放通知調(diào)用 setAdditionalText(java.lang.String) 獲取已設(shè)置的附加文本。
AVToken	getAVToken()	獲取附加到此媒體播放通知的 AVToken。
int[]	getShownActions()	獲取表示要在此媒體播放通知中顯示的 NotificationActionButton 對(duì)象的序列號(hào)列表。
String	getText()	獲取本次媒體播放通知調(diào)用 setText(java.lang.String) 設(shè)置的通知內(nèi)容。
String	getTitle()	獲取通過調(diào)用 setTitle(java.lang.String) 為該媒體播放通知設(shè)置的標(biāo)題。
boolean	marshalling(Parcel out)	將此 Notification Media Content 對(duì)象編組為 Parcel。
NotificationRequest.NotificationMediaContent	setAdditionalText(String additionalText)	設(shè)置要包含在此媒體播放通知中的附加文本。
NotificationRequest.NotificationMediaContent	setAVToken(AVToken avToken)	將指定的 AVToken 附加到此媒體播放通知。
NotificationRequest.NotificationMediaContent	setShownActions(int[] actions)	設(shè)置最多三個(gè) NotificationActionButton 對(duì)象以顯示在此媒體播放通知中。
NotificationRequest.NotificationMediaContent	setText(String text)	設(shè)置要包含在此媒體播放通知中的文本。
NotificationRequest.NotificationMediaContent	setTitle(String title)	設(shè)置此媒體播放通知的標(biāo)題。
String	toString()	返回對(duì)象的字符串表示形式。
boolean	unmarshalling(Parcel in)	從 Parcel 中解組此 NotificationMediaContent 對(duì)象。

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

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

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

NotificationMediaContent

public NotificationMediaContent()

用于創(chuàng)建 NotificationMediaContent 實(shí)例的默認(rèn)構(gòu)造函數(shù)。

Since:

3

方法詳情

getTitle

public String getTitle()

獲取通過調(diào)用 setTitle(java.lang.String) 為該媒體播放通知設(shè)置的標(biāo)題。

返回:

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

Since:

3

setTitle

public NotificationRequest.NotificationMediaContent setTitle(String title)

設(shè)置此媒體播放通知的標(biāo)題。

參數(shù)：

參數(shù)名稱	參數(shù)描述
title	指示此媒體播放通知的標(biāo)題。

返回:

返回此 NotificationMediaContent 對(duì)象。

Since:

3

getText

public String getText()

獲取本次媒體播放通知調(diào)用 setText(java.lang.String) 設(shè)置的通知內(nèi)容。

返回:

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

Since:

3

setText

public NotificationRequest.NotificationMediaContent setText(String text)

設(shè)置要包含在此媒體播放通知中的文本。

參數(shù)：

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

返回:

返回此 NotificationMediaContent 對(duì)象。

Since:

3

getAdditionalText

public String getAdditionalText()

通過為此媒體播放通知調(diào)用 setAdditionalText(java.lang.String) 獲取已設(shè)置的附加文本。

返回:

返回此通知的附加文本。

Since:

3

setAdditionalText

public NotificationRequest.NotificationMediaContent setAdditionalText(String additionalText)

設(shè)置要包含在此媒體播放通知中的附加文本。

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

參數(shù)：

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

返回:

返回此 NotificationMediaContent 對(duì)象。

Since:

3

getAVToken

public AVToken getAVToken()

獲取附加到此媒體播放通知的 AVToken。

返回:

返回附加到此通知的 AVToken。

Since:

3

setAVToken

public NotificationRequest.NotificationMediaContent setAVToken(AVToken avToken)

將指定的 AVToken 附加到此媒體播放通知。 附加 AVToken 后，此通知可以與關(guān)聯(lián)的 AVSession 交互，以便用戶可以在此通知中控制媒體播放。

參數(shù)：

參數(shù)名稱	參數(shù)描述
avToken	指示要附加的 AVToken。

返回:

返回此 NotificationMediaContent 對(duì)象。

Since:

3

getShownActions

public int[] getShownActions()

獲取表示要在此媒體播放通知中顯示的 NotificationActionButton 對(duì)象的序列號(hào)列表。

返回:

返回表示要顯示的操作按鈕的序列號(hào)列表。

Since:

3

setShownActions

public NotificationRequest.NotificationMediaContent setShownActions(int[] actions)

設(shè)置最多三個(gè) NotificationActionButton 對(duì)象以顯示在此媒體播放通知中。

在發(fā)布該通知之前，還應(yīng)調(diào)用 NotificationRequest#addActionButton(NotificationActionButton) 為該通知添加指定的 NotificationActionButton 對(duì)象，使該方法生效。 添加的操作按鈕將按照添加的順序分配序列號(hào)。 此方法的操作值中指定的序列號(hào)必須與分配給添加的操作按鈕的序列號(hào)相匹配。 否則，通知將無法發(fā)布。 默認(rèn)情況下，序列號(hào)從 0 開始。如果要顯示三個(gè)操作按鈕，則操作的值應(yīng)為 0、1、2。

參數(shù)：

參數(shù)名稱	參數(shù)描述
actions	指示表示要在此通知中顯示的 NotificationActionButton 對(duì)象的序列號(hào)列表。

返回:

返回此 NotificationMediaContent 對(duì)象。

Since:

3

marshalling

public boolean marshalling(Parcel out)

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

進(jìn)程可以調(diào)用 unmarshalling(ohos.utils.Parcel) 方法從 Parcel 中解組此 NotificationMediaContent 對(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 中解組此 NotificationMediaContent 對(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è)簡潔但信息豐富的表示，易于人們閱讀。 建議所有子類重寫此方法。

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

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

覆蓋：

類 Object 中的 toString

返回:

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

Since:

4