鸿蒙OS NotificationRequest.NotificationMediaContent

NotificationRequest.NotificationMediaContent

java.lang.Object

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

public static final class NotificationRequest.NotificationMediaContent
extends Object
implements Sequenceable

构造一个可以与关联的音频会话交互的媒体播放通知。

在构造这个通知之前，你应该首先初始化一个 NotificationMediaContent 对象，并调用 setAVToken(ohos.media.common.sessioncore.AVToken) 为其附加一个 AVToken 以建立与关联的 AVSession 的交互通道。 您可以调用 [setShownActions(int]) 来请求在此通知中显示 NotificationActionButton 对象。 然后，您应该初始化一个 NotificationRequest 对象并调用 NotificationRequest#setContent(NotificationContent) 将其设置为媒体播放通知，并将先前构造的 NotificationMediaContent 对象附加到它。 此外，您应该调用 NotificationRequest#addActionButton(NotificationActionButton) 以便媒体控制按钮在此通知发布后显示在此通知中。

Since:

3

嵌套类摘要

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

构造函数摘要

构造函数	描述
NotificationMediaContent()	用于创建 NotificationMediaContent 实例的默认构造函数。

方法总结

修饰符和类型	方法	描述
String	getAdditionalText()	通过为此媒体播放通知调用 setAdditionalText(java.lang.String) 获取已设置的附加文本。
AVToken	getAVToken()	获取附加到此媒体播放通知的 AVToken。
int[]	getShownActions()	获取表示要在此媒体播放通知中显示的 NotificationActionButton 对象的序列号列表。
String	getText()	获取本次媒体播放通知调用 setText(java.lang.String) 设置的通知内容。
String	getTitle()	获取通过调用 setTitle(java.lang.String) 为该媒体播放通知设置的标题。
boolean	marshalling(Parcel out)	将此 Notification Media Content 对象编组为 Parcel。
NotificationRequest.NotificationMediaContent	setAdditionalText(String additionalText)	设置要包含在此媒体播放通知中的附加文本。
NotificationRequest.NotificationMediaContent	setAVToken(AVToken avToken)	将指定的 AVToken 附加到此媒体播放通知。
NotificationRequest.NotificationMediaContent	setShownActions(int[] actions)	设置最多三个 NotificationActionButton 对象以显示在此媒体播放通知中。
NotificationRequest.NotificationMediaContent	setText(String text)	设置要包含在此媒体播放通知中的文本。
NotificationRequest.NotificationMediaContent	setTitle(String title)	设置此媒体播放通知的标题。
String	toString()	返回对象的字符串表示形式。
boolean	unmarshalling(Parcel in)	从 Parcel 中解组此 NotificationMediaContent 对象。

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

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

构造函数详细信息

NotificationMediaContent

public NotificationMediaContent()

用于创建 NotificationMediaContent 实例的默认构造函数。

Since:

3

方法详情

getTitle

public String getTitle()

获取通过调用 setTitle(java.lang.String) 为该媒体播放通知设置的标题。

返回:

返回此通知的标题。

Since:

3

setTitle

public NotificationRequest.NotificationMediaContent setTitle(String title)

设置此媒体播放通知的标题。

参数：

参数名称	参数描述
title	指示此媒体播放通知的标题。

返回:

返回此 NotificationMediaContent 对象。

Since:

3

getText

public String getText()

获取本次媒体播放通知调用 setText(java.lang.String) 设置的通知内容。

返回:

返回此通知的内容。

Since:

3

setText

public NotificationRequest.NotificationMediaContent setText(String text)

设置要包含在此媒体播放通知中的文本。

参数：

参数名称	参数描述
text	指示要包含的文本。

返回:

返回此 NotificationMediaContent 对象。

Since:

3

getAdditionalText

public String getAdditionalText()

通过为此媒体播放通知调用 setAdditionalText(java.lang.String) 获取已设置的附加文本。

返回:

返回此通知的附加文本。

Since:

3

setAdditionalText

public NotificationRequest.NotificationMediaContent setAdditionalText(String additionalText)

设置要包含在此媒体播放通知中的附加文本。

附加文本是对通过调用 setText(java.lang.String) 设置的通知文本的补充。 附加文本的字体小于通知文本，并在单独的行中显示。

参数：

参数名称	参数描述
additionalText	指示要包含的附加文本。

返回:

返回此 NotificationMediaContent 对象。

Since:

3

getAVToken

public AVToken getAVToken()

获取附加到此媒体播放通知的 AVToken。

返回:

返回附加到此通知的 AVToken。

Since:

3

setAVToken

public NotificationRequest.NotificationMediaContent setAVToken(AVToken avToken)

将指定的 AVToken 附加到此媒体播放通知。 附加 AVToken 后，此通知可以与关联的 AVSession 交互，以便用户可以在此通知中控制媒体播放。

参数：

参数名称	参数描述
avToken	指示要附加的 AVToken。

返回:

返回此 NotificationMediaContent 对象。

Since:

3

getShownActions

public int[] getShownActions()

获取表示要在此媒体播放通知中显示的 NotificationActionButton 对象的序列号列表。

返回:

返回表示要显示的操作按钮的序列号列表。

Since:

3

setShownActions

public NotificationRequest.NotificationMediaContent setShownActions(int[] actions)

设置最多三个 NotificationActionButton 对象以显示在此媒体播放通知中。

在发布该通知之前，还应调用 NotificationRequest#addActionButton(NotificationActionButton) 为该通知添加指定的 NotificationActionButton 对象，使该方法生效。 添加的操作按钮将按照添加的顺序分配序列号。 此方法的操作值中指定的序列号必须与分配给添加的操作按钮的序列号相匹配。 否则，通知将无法发布。 默认情况下，序列号从 0 开始。如果要显示三个操作按钮，则操作的值应为 0、1、2。

参数：

参数名称	参数描述
actions	指示表示要在此通知中显示的 NotificationActionButton 对象的序列号列表。

返回:

返回此 NotificationMediaContent 对象。

Since:

3

marshalling

public boolean marshalling(Parcel out)

将此 NotificationMediaContent 对象编组为 Parcel。

进程可以调用 unmarshalling(ohos.utils.Parcel) 方法从 Parcel 中解组此 NotificationMediaContent 对象，以实现进程间通信 (IPC)。

指定者：

接口 Sequenceable 中的编组

参数：

参数名称	参数描述
out	指示用于编组的 Parcel 对象。

返回:

如果编组成功，则返回 true； 否则返回 false。

Since:

3

unmarshalling

public boolean unmarshalling(Parcel in)

从 Parcel 中解组此 NotificationMediaContent 对象。

指定者：

在接口 Sequenceable 中解组

参数：

参数名称	参数描述
in	指示用于解组的 Parcel 对象。

返回:

如果解组成功，则返回 true； 否则返回 false。

Since:

3

toString

public String toString()

从类复制的描述：对象

返回对象的字符串表示形式。 通常，toString 方法返回一个“以文本方式表示”该对象的字符串。 结果应该是一个简洁但信息丰富的表示，易于人们阅读。 建议所有子类重写此方法。

Object 类的 toString 方法返回一个字符串，该字符串由对象作为其实例的类的名称、at 符号字符“@”和对象哈希码的无符号十六进制表示形式组成。 换句话说，此方法返回一个等于以下值的字符串：

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

覆盖：

类 Object 中的 toString

返回:

对象的字符串表示形式。

Since:

4