鸿蒙OS开发文档 鸿蒙OS NotificationRequest.NotificationPictureContent

2024-02-25 开发教程 鸿蒙OS开发文档 匿名 7

NotificationRequest.NotificationPictureContent

java.lang.Object
|---ohos.event.notification.NotificationRequest.NotificationPictureContent

public static final class NotificationRequest.NotificationPictureContent
extends Object
implements Sequenceable

构造包含图片附件的通知。

此类与 NotificationContent 和 NotificationRequest 一起使用。 示例代码:

NotificationRequest request = new NotificationRequest();
NotificationPictureContent pictureContent = new NotificationPictureContent();
NotificationContent notificationContent = new NotificationContent(pictureContent);
request.setContent(notificationContent);

Since:

1

嵌套类摘要

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

构造函数摘要

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

方法总结

修饰符和类型方法描述
StringgetAdditionalText()获取调用setAdditionalText(java.lang.String)方法指定的附图通知的附加文本。
PixelMapgetBigPicture()调用setBigPicture(ohos.media.image.PixelMap)方法获取指定图片的PixelMap。
StringgetBriefText()获取调用setBriefText(java.lang.String)方法指定的附图通知的简短文本。
StringgetExpandedTitle()获取该贴图通知展开时显示的标题。
StringgetText()获取调用setText(java.lang.String)方法指定的附图通知文本。
StringgetTitle()获取调用setTitle(java.lang.String)方法指定的附图通知标题。
booleanmarshalling(Parcel out)将 NotificationPictureContent 对象编组到 Parcel 中。
NotificationRequest.NotificationPictureContentsetAdditionalText(String additionalText)设置附加文本以包含在附图片的通知中。
NotificationRequest.NotificationPictureContentsetBigPicture(PixelMap bigPicture)设置要包含在通知中的图片。
NotificationRequest.NotificationPictureContentsetBriefText(String briefText)设置要包含在附图片通知中的简短文本。
NotificationRequest.NotificationPictureContentsetExpandedTitle(String expandedTitle)设置此附图通知展开时显示的标题。
NotificationRequest.NotificationPictureContentsetText(String text)设置要包含在图片附加通知中的文本。
NotificationRequest.NotificationPictureContentsetTitle(String title)设置附图通知的标题。
StringtoString()返回对象的字符串表示形式。
booleanunmarshalling(Parcel in)从 Parcel 中解组 NotificationPictureContent 对象。
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
从接口 ohos.utils.Sequenceable 继承的方法
hasFileDescriptor

构造函数详细信息

NotificationPictureContent

public NotificationPictureContent()

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

Since:

1

方法详情

getTitle

public String getTitle()

获取调用setTitle(java.lang.String)方法指定的附图通知标题。

返回:

返回通知的标题。

Since:

1

setTitle

public NotificationRequest.NotificationPictureContent setTitle(String title)

设置附图通知的标题。

参数:

参数名称参数描述
title表示通知的标题。

返回:

返回具有指定标题的 NotificationPictureContent 对象。

Since:

1

getText

public String getText()

获取调用setText(java.lang.String)方法指定的附图通知文本。

返回:

返回通知的文本。

Since:

1

setText

public NotificationRequest.NotificationPictureContent setText(String text)

设置要包含在图片附加通知中的文本。

参数:

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

返回:

返回具有指定文本的 NotificationPictureContent 对象。

Since:

1

getAdditionalText

public String getAdditionalText()

获取调用setAdditionalText(java.lang.String)方法指定的附图通知的附加文本。

返回:

返回附图通知的附加文本。

Since:

2

setAdditionalText

public NotificationRequest.NotificationPictureContent setAdditionalText(String additionalText)

设置附加文本以包含在附图片的通知中。

附加文本主要是对通知文本的补充。 因此,附加文本的字体小于通知文本,并显示在单独的行中。

参数:

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

返回:

返回具有指定附加文本的 NotificationPictureContent 对象。

Since:

2

getBriefText

public String getBriefText()

获取调用setBriefText(java.lang.String)方法指定的附图通知的简短文本。

返回:

返回附图通知的简短文本。

Since:

2

setBriefText

public NotificationRequest.NotificationPictureContent setBriefText(String briefText)

设置要包含在附图片通知中的简短文本。

简短文本是附图通知的摘要,显示在通知的第一行。 与 setAdditionalText(java.lang.String) 类似,简短文本的字体也小于通知文本。

简短文本和附加文本的显示位置可能会发生冲突。 如果设置了两个文本,则仅显示附加文本。

参数:

参数名称参数描述
briefText指示要包含的简短文本。

返回:

返回具有指定briefText 的NotificationPictureContent 对象。

Since:

2

getExpandedTitle

public String getExpandedTitle()

获取该贴图通知展开时显示的标题。

返回:

返回展开此通知时要显示的标题。

Since:

3

setExpandedTitle

public NotificationRequest.NotificationPictureContent setExpandedTitle(String expandedTitle)

设置此附图通知展开时显示的标题。 设置此标题后,只有在此通知处于折叠状态时才会显示 setTitle(java.lang.String) 设置的标题。

参数:

参数名称参数描述
expandedTitle指示展开此通知时要显示的标题。

返回:

返回具有指定扩展标题的此 NotificationPictureContent 对象。

Since:

3

setBigPicture

public NotificationRequest.NotificationPictureContent setBigPicture(PixelMap bigPicture)

设置要包含在通知中的图片。

参数:

参数名称参数描述
bigPicture表示要包含的图片的PixelMap。

返回:

返回具有指定 bigPicture 的 NotificationPictureContent 对象。

Since:

3

getBigPicture

public PixelMap getBigPicture()

调用setBigPicture(ohos.media.image.PixelMap)方法获取指定图片的PixelMap。

返回:

返回通知中包含的图片的 PixelMap。

Since:

3

marshalling

public boolean marshalling(Parcel out)

将 NotificationPictureContent 对象编组到 Parcel 中。

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

指定者:

接口 Sequenceable 中的编组

参数:

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

返回:

如果编组成功,则返回 true; 否则返回 false。

Since:

1

unmarshalling

public boolean unmarshalling(Parcel in)

从 Parcel 中解组 NotificationPictureContent 对象。

指定者:

在接口 Sequenceable 中解组

参数:

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

返回:

如果解组成功,则返回 true; 否则返回 false。

Since:

1

toString

public String toString()

从类复制的描述:对象

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

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

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

覆盖:

类 Object 中的 toString

返回:

对象的字符串表示形式。

Since:

4