鸿蒙OS开发文档 鸿蒙OS NotificationActionButton.Builder

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

NotificationActionButton.Builder

java.lang.Object
|---ohos.event.notification.NotificationActionButton.Builder

public static final class NotificationActionButton.Builder
extends Object

NotificationActionButton 对象的生成器类。

Since:

3

构造函数摘要

构造函数描述
Builder(NotificationActionButton actionButton)用于通过从现有 NotificationActionButton 对象复制参数来创建 Builder 实例的构造函数。
Builder(PixelMap icon, String title, IntentAgent intentAgent)用于创建具有指定图标、标题和 IntentAgent 的 Builder 实例的构造函数,用于创建 NotificationActionButton 对象。

方法总结

修饰符和类型方法描述
NotificationActionButton.BuilderaddAdditionalData(PacMap pacMap)将附加数据添加到此 Builder。
NotificationActionButton.BuilderaddNotificationUserInput(NotificationUserInput userInput)添加用于收集用户输入的 NotificationUserInput 对象。
NotificationActionButtonbuild()使用所有设置创建一个新的 NotificationActionButton 对象。
NotificationActionButton.BuildersetAutoCreatedReplies(boolean autoCreatedReplies)设置是否允许平台自动生成可能的回复并将其添加到 NotificationUserInput#getOptions()。
NotificationActionButton.BuildersetContextDependent(boolean isContextual)设置此 NotificationActionButton 是否为上下文动作,即此 NotificationActionButton 是否依赖于通知消息体。
NotificationActionButton.BuildersetSemanticActionButton(NotificationConstant.SemanticActionButton semanticActionButton)为此 NotificationActionButton 设置语义操作。
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造函数详细信息

Builder

public Builder(PixelMap icon, String title, IntentAgent intentAgent)

用于创建具有指定图标、标题和 IntentAgent 的 Builder 实例的构造函数,用于创建 NotificationActionButton 对象。

参数:

参数名称参数描述
icon指示表示此 NotificationActionButton 的图标。
title指示此 NotificationActionButton 的标题。
intentAgent指示触发此 NotificationActionButton 时要触发的 IntentAgent。

Since:

3

Builder

public Builder(NotificationActionButton actionButton)

用于通过从现有 NotificationActionButton 对象复制参数来创建 Builder 实例的构造函数。

参数:

参数名称参数描述
actionButton指示现有的 NotificationActionButton 对象。

Since:

3

方法详情

addNotificationUserInput

public NotificationActionButton.Builder addNotificationUserInput(NotificationUserInput userInput)

添加用于收集用户输入的 NotificationUserInput 对象。

参数:

参数名称参数描述
userInput指示要添加的 NotificationUserInput 对象。

返回:

返回此 Builder 对象。

Since:

3

setContextDependent

public NotificationActionButton.Builder setContextDependent(boolean isContextual)

设置此 NotificationActionButton 是否为上下文动作,即此 NotificationActionButton 是否依赖于通知消息体。 例如,上下文 NotificationActionButton 在通知中为用户打开地图应用程序提供地址。

参数:

参数名称参数描述
isContextual指定此 NotificationActionButton 是否为上下文操作。 值 true 表示上下文操作,值 false 表示不是。

返回:

返回此 Builder 对象。

Since:

3

setSemanticActionButton

public NotificationActionButton.Builder setSemanticActionButton(NotificationConstant.SemanticActionButton semanticActionButton)

为此 NotificationActionButton 设置语义操作。

参数:

参数名称参数描述
semanticActionButton表示要添加的语义动作。 有关可用值,请参阅 NotificationConstant.SemanticActionButton。

返回:

返回此 Builder 对象。

Since:

3

setAutoCreatedReplies

public NotificationActionButton.Builder setAutoCreatedReplies(boolean autoCreatedReplies)

设置是否允许平台自动生成可能的回复并将其添加到 NotificationUserInput#getOptions()。

参数:

参数名称参数描述
autoCreatedReplies指定是否允许平台自动生成可能的回复。 值 true 表示允许生成回复; 值 false 表示不是。

返回:

返回此 Builder 对象。

Since:

3

addAdditionalData

public NotificationActionButton.Builder addAdditionalData(PacMap pacMap)

将附加数据添加到此 Builder。

参数:

参数名称参数描述
pacMap指示包含附加数据的 PacMap 对象。

返回:

返回此 Builder 对象。

Since:

3

build

public NotificationActionButton build()

使用所有设置创建一个新的 NotificationActionButton 对象。

返回:

返回创建的 NotificationActionButton 对象。

Throws:

Throw名称Throw描述
IllegalArgumentException如果 NotificationActionButton.isContextDependent() 为 true 但 icon 或 intentAgent 为 null,则引发此异常。

Since:

3