鸿蒙OS NotificationActionButton
NotificationActionButton
java.lang.Object
|---ohos.event.notification.NotificationActionButton
public class NotificationActionButton
extends Object
implements Sequenceable
封装要在通知中显示的操作按钮。 您可以调用 NotificationRequest#addActionButton 将操作按钮添加到通知。
NotificationActionButton 对象必须包含一个图标、一个标题和一个关联的 IntentAgent,定义了单击操作按钮时要触发的操作。
Since:
3
嵌套类摘要
修饰符和类型 | 类 | 描述 |
---|---|---|
static class | NotificationActionButton.Builder | NotificationActionButton 对象的生成器类。 |
从接口 ohos.utils.Sequenceable 继承的嵌套类/接口 |
---|
Sequenceable.ProducerT |
字段摘要
修饰符和类型 | 字段 | 描述 |
---|---|---|
static Sequenceable.ProducerNotificationActionButton | PRODUCER | 从 Parcel 创建 NotificationActionButton 实例。 |
方法总结
修饰符和类型 | 方法 | 描述 |
---|---|---|
PacMap | getAdditionalData() | 获取包含在此 NotificationActionButton 中的附加数据。 |
PixelMap | getIcon() | 获取此 NotificationActionButton 的图标。 |
IntentAgent | getIntentAgent() | 获取此 NotificationActionButton 的 IntentAgent。 |
ListNotificationUserInput | getMimeTypeOnlyUserInputs() | 在发送此 NotificationActionButton 时,获取仅允许特定 MIME 类型的值的 NotificationUserInput 对象。 |
int | getSemanticActionButton() | 获取此 NotificationActionButton 的语义操作。 |
String | getTitle() | 获取此 NotificationActionButton 的标题。 |
ListNotificationUserInput | getUserInputs() | 获取发送此 NotificationActionButton 时向用户收集的 NotificationUserInput 对象。 |
boolean | isAutoCreatedReplies() | 检查平台是否可以自动为此 NotificationActionButton 生成可能的回复。 |
boolean | isContextDependent() | 检查此 NotificationActionButton 是否为上下文操作,即此 NotificationActionButton 是否依赖于通知消息体。 |
boolean | marshalling(Parcel out) | 将 NotificationActionButton 对象编组到 Parcel 中。 |
String | toString() | 返回对象的字符串表示形式。 |
boolean | unmarshalling(Parcel in) | 从 Parcel 中解组 NotificationActionButton 对象。 |
从类 java.lang.Object 继承的方法 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
从接口 ohos.utils.Sequenceable 继承的方法 |
---|
hasFileDescriptor |
字段详细信息
PRODUCER
public static final Sequenceable.ProducerNotificationActionButton PRODUCER
从 Parcel 创建 NotificationActionButton 实例。
Since:
4
方法详情
getIcon
public PixelMap getIcon()
获取此 NotificationActionButton 的图标。
返回:
返回此 NotificationActionButton 的图标。
Since:
3
getAdditionalData
public PacMap getAdditionalData()
获取包含在此 NotificationActionButton 中的附加数据。
返回:
返回此 NotificationActionButton 中包含的附加数据。
Since:
3
getUserInputs
public ListNotificationUserInput getUserInputs()
获取发送此 NotificationActionButton 时向用户收集的 NotificationUserInput 对象。
返回:
返回 NotificationUserInput 对象的列表。
Since:
3
getMimeTypeOnlyUserInputs
public ListNotificationUserInput getMimeTypeOnlyUserInputs()
在发送此 NotificationActionButton 时,获取仅允许特定 MIME 类型的值的 NotificationUserInput 对象。
返回:
返回仅允许特定 MIME 类型值的 NotificationUserInput 对象列表。
Since:
3
isAutoCreatedReplies
public boolean isAutoCreatedReplies()
检查平台是否可以自动为此 NotificationActionButton 生成可能的回复。
返回:
如果平台可以生成回复,则返回 true; 否则返回 false。
Since:
3
isContextDependent
public boolean isContextDependent()
检查此 NotificationActionButton 是否为上下文操作,即此 NotificationActionButton 是否依赖于通知消息体。 例如,上下文 NotificationActionButton 在通知中为用户打开地图应用程序提供地址。
返回:
如果此 NotificationActionButton 是上下文操作,则返回 true; 否则返回 false。
Since:
3
getTitle
public String getTitle()
获取此 NotificationActionButton 的标题。
返回:
返回此 NotificationActionButton 的标题。
Since:
3
getIntentAgent
public IntentAgent getIntentAgent()
获取此 NotificationActionButton 的 IntentAgent。
返回:
返回此 NotificationActionButton 的 IntentAgent。
Since:
3
getSemanticActionButton
public int getSemanticActionButton()
获取此 NotificationActionButton 的语义操作。
返回:
返回此 NotificationActionButton 的语义操作,如 NotificationConstant.SemanticActionButton 中所枚举。
Since:
3
marshalling
public boolean marshalling(Parcel out)
将 NotificationActionButton 对象编组到 Parcel 中。
进程可以调用 unmarshalling(ohos.utils.Parcel) 方法从 Parcel 中解组 NotificationActionButton 对象,以实现进程间通信 (IPC)。
指定者:
接口 Sequenceable 中的编组
参数:
参数名称 | 参数描述 |
---|---|
out | 指示用于编组的 MessageParcel 对象。 MessageParcel 是 Parcel 的子类。 |
返回:
如果编组成功,则返回 true; 否则返回 false。
Since:
4
unmarshalling
public boolean unmarshalling(Parcel in)
从 Parcel 中解组 NotificationActionButton 对象。
指定者:
在接口 Sequenceable 中解组
参数:
参数名称 | 参数描述 |
---|---|
in | 指示用于编组的 MessageParcel 对象。 MessageParcel 是 Parcel 的子类。 |
返回:
如果解组成功,则返回 true; 否则返回 false。
Since:
4
toString
public String toString()
从类复制的描述:对象
返回对象的字符串表示形式。 通常,toString 方法返回一个“以文本方式表示”该对象的字符串。 结果应该是一个简洁但信息丰富的表示,易于人们阅读。 建议所有子类重写此方法。
Object 类的 toString 方法返回一个字符串,该字符串由对象作为其实例的类的名称、at 符号字符“@”和对象哈希码的无符号十六进制表示形式组成。 换句话说,此方法返回一个等于以下值的字符串:
getClass().getName() + '@' + Integer.toHexString(hashCode())
覆盖:
类 Object 中的 toString
返回:
对象的字符串表示形式。
Since:
4
更多建议: