Package com.jwplayer.pub.api.background

Class NotificationButton.Builder

java.lang.Object

com.jwplayer.pub.api.background.NotificationButton.Builder

Enclosing class:

NotificationButton

public static final class NotificationButton.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(String id, int iconResId, CharSequence title)

Method Summary

Modifier and Type	Method	Description
NotificationButton	build()
NotificationButton.Builder	compactViewIndex(int index)	Position (0 to 2) in the collapsed notification, or NotificationButton.COMPACT_VIEW_NONE (the default).
NotificationButton.Builder	enabled(boolean enabled)	A disabled button keeps its place in the notification but does nothing when tapped.
NotificationButton.Builder	inCompactView(boolean inCompactView)	Shorthand for compactViewIndex(inCompactView ? 0 : COMPACT_VIEW_NONE).
NotificationButton.Builder	placement(int placement)	Where the system media controls should put the button: NotificationButton.PLACEMENT_OVERFLOW (the default), NotificationButton.PLACEMENT_BACK or NotificationButton.PLACEMENT_FORWARD.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(@NonNull
 String id,
 @DrawableRes
 int iconResId,
 @NonNull
 CharSequence title)

Parameters:

id - passed back on a tap; unique within the list

iconResId - a drawable resource (vector or bitmap)

title - the label, used for accessibility and wherever the system shows text

Throws:

IllegalArgumentException - if id or title is null or iconResId is 0

Method Details

enabled

@NonNull
public NotificationButton.Builder enabled(boolean enabled)

A disabled button keeps its place in the notification but does nothing when tapped. Android 13+ system media controls do not show it. Default true.

compactViewIndex

@NonNull
public NotificationButton.Builder compactViewIndex(int index)

Position (0 to 2) in the collapsed notification, or NotificationButton.COMPACT_VIEW_NONE (the default). For lists built with this class, play/pause always stays in the collapsed notification (it is added if the list has none). A legacy addNotificationActions / getCompactActions list is rendered as given. Ignored by Android 13+ system media controls.

inCompactView

@NonNull
public NotificationButton.Builder inCompactView(boolean inCompactView)

Shorthand for compactViewIndex(inCompactView ? 0 : COMPACT_VIEW_NONE).

placement

@NonNull
public NotificationButton.Builder placement(int placement)

Where the system media controls should put the button: NotificationButton.PLACEMENT_OVERFLOW (the default), NotificationButton.PLACEMENT_BACK or NotificationButton.PLACEMENT_FORWARD. A hint; the notification itself shows buttons in list order.

build

@NonNull
public NotificationButton build()