public final class

NotificationCompat.BubbleMetadata.Builder

extends java.lang.Object

 java.lang.Object

↳androidx.core.app.NotificationCompat.BubbleMetadata.Builder

Overview

Builder to construct a NotificationCompat.BubbleMetadata object.

Summary

Constructors
publicBuilder()

publicBuilder(PendingIntent intent, IconCompat icon)

Creates a NotificationCompat.BubbleMetadata.Builder based on the provided intent and icon.

publicBuilder(java.lang.String shortcutId)

Creates a NotificationCompat.BubbleMetadata.Builder based on a ShortcutInfoCompat.

Methods
public NotificationCompat.BubbleMetadatabuild()

Creates the NotificationCompat.BubbleMetadata defined by this builder.

public NotificationCompat.BubbleMetadata.BuildersetAutoExpandBubble(boolean shouldExpand)

If set and the app creating the bubble is in the foreground, the bubble will be posted in its expanded state, with the contents of NotificationCompat.BubbleMetadata.getIntent() in a floating window.

public NotificationCompat.BubbleMetadata.BuildersetDeleteIntent(PendingIntent deleteIntent)

Sets an optional intent to send when this bubble is explicitly removed by the user.

public NotificationCompat.BubbleMetadata.BuildersetDesiredHeight(int height)

Sets the desired height in DPs for the app content defined by NotificationCompat.BubbleMetadata.Builder.setIntent(PendingIntent), this height may not be respected if there is not enough space on the screen or if the provided height is too small to be useful.

public NotificationCompat.BubbleMetadata.BuildersetDesiredHeightResId(int heightResId)

Sets the desired height via resId for the app content defined by NotificationCompat.BubbleMetadata.Builder.setIntent(PendingIntent), this height may not be respected if there is not enough space on the screen or if the provided height is too small to be useful.

public NotificationCompat.BubbleMetadata.BuildersetIcon(IconCompat icon)

Sets the icon for the bubble.

public NotificationCompat.BubbleMetadata.BuildersetIntent(PendingIntent intent)

Sets the intent that will be used when the bubble is expanded.

public NotificationCompat.BubbleMetadata.BuildersetSuppressNotification(boolean shouldSuppressNotif)

If set and the app posting the bubble is in the foreground, the bubble will be posted without the associated notification in the notification shade.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Builder()

Deprecated: use NotificationCompat.BubbleMetadata.Builder.Builder(String) for a bubble created via a ShortcutInfoCompat or NotificationCompat.BubbleMetadata.Builder.Builder(PendingIntent, IconCompat) for a bubble created via a PendingIntent.

public Builder(java.lang.String shortcutId)

Creates a NotificationCompat.BubbleMetadata.Builder based on a ShortcutInfoCompat. To create a shortcut bubble, ensure that the shortcut associated with the provided shortcutId is published as a dynamic shortcut that was built with being true, otherwise your notification will not be able to bubble.

The shortcut icon will be used to represent the bubble when it is collapsed.

The shortcut activity will be used when the bubble is expanded. This will display the shortcut activity in a floating window over the existing foreground activity.

If the shortcut has not been published when the bubble notification is sent, no bubble will be produced. If the shortcut is deleted while the bubble is active, the bubble will be removed.

See also: ShortcutInfoCompat

public Builder(PendingIntent intent, IconCompat icon)

Creates a NotificationCompat.BubbleMetadata.Builder based on the provided intent and icon.

The icon will be used to represent the bubble when it is collapsed. An icon should be representative of the content within the bubble. If your app produces multiple bubbles, the icon should be unique for each of them.

The intent that will be used when the bubble is expanded. This will display the app content in a floating window over the existing foreground activity. The intent should point to a resizable activity.

Methods

public NotificationCompat.BubbleMetadata.Builder setIntent(PendingIntent intent)

Sets the intent that will be used when the bubble is expanded. This will display the app content in a floating window over the existing foreground activity.

public NotificationCompat.BubbleMetadata.Builder setIcon(IconCompat icon)

Sets the icon for the bubble. Can only be used if the bubble was created via NotificationCompat.BubbleMetadata.Builder.Builder(PendingIntent, IconCompat).

The icon will be used to represent the bubble when it is collapsed. An icon should be representative of the content within the bubble. If your app produces multiple bubbles, the icon should be unique for each of them.

It is recommended to use an of type or

public NotificationCompat.BubbleMetadata.Builder setDesiredHeight(int height)

Sets the desired height in DPs for the app content defined by NotificationCompat.BubbleMetadata.Builder.setIntent(PendingIntent), this height may not be respected if there is not enough space on the screen or if the provided height is too small to be useful.

If NotificationCompat.BubbleMetadata.Builder.setDesiredHeightResId(int) was previously called on this builder, the previous value set will be cleared after calling this method, and this value will be used instead.

public NotificationCompat.BubbleMetadata.Builder setDesiredHeightResId(int heightResId)

Sets the desired height via resId for the app content defined by NotificationCompat.BubbleMetadata.Builder.setIntent(PendingIntent), this height may not be respected if there is not enough space on the screen or if the provided height is too small to be useful.

If NotificationCompat.BubbleMetadata.Builder.setDesiredHeight(int) was previously called on this builder, the previous value set will be cleared after calling this method, and this value will be used instead.

public NotificationCompat.BubbleMetadata.Builder setAutoExpandBubble(boolean shouldExpand)

If set and the app creating the bubble is in the foreground, the bubble will be posted in its expanded state, with the contents of NotificationCompat.BubbleMetadata.getIntent() in a floating window.

If the app creating the bubble is not in the foreground this flag has no effect.

Generally this flag should only be set if the user has performed an action to request or create a bubble.

public NotificationCompat.BubbleMetadata.Builder setSuppressNotification(boolean shouldSuppressNotif)

If set and the app posting the bubble is in the foreground, the bubble will be posted without the associated notification in the notification shade.

If the app posting the bubble is not in the foreground this flag has no effect.

Generally this flag should only be set if the user has performed an action to request or create a bubble, or if the user has seen the content in the notification and the notification is no longer relevant.

public NotificationCompat.BubbleMetadata.Builder setDeleteIntent(PendingIntent deleteIntent)

Sets an optional intent to send when this bubble is explicitly removed by the user.

public NotificationCompat.BubbleMetadata build()

Creates the NotificationCompat.BubbleMetadata defined by this builder.

Will throw java.lang.NullPointerException if required fields have not been set on this builder.

Generated Fri, 13 Sep 2024 06:44:43 +0000 by Michael Jentsch - Privacy Policy - Legal Details