TvExtender
class TvExtender : Notification.Extender
kotlin.Any | |
↳ | android.app.Notification.TvExtender |
Helper class to add Android TV extensions to notifications. To create a notification with a TV extension:
- Create an
Notification.Builder
, setting any desired properties. - Create a
TvExtender
. - Set TV-specific properties using the
set
methods ofTvExtender
. - Call
Notification.Builder#extend(Notification.Extender)
to apply the extension to a notification.
Notification notification = new Notification.Builder(context) ... .extend(new TvExtender() .set*(...)) .build();
TV extensions can be accessed on an existing notification by using the TvExtender(Notification)
constructor, and then using the get
methods to access values.
Summary
Public constructors | |
---|---|
Create a |
|
TvExtender(notif: Notification) Create a |
Public methods | |
---|---|
Notification.Builder |
extend(builder: Notification.Builder) Apply a TV extension to a notification that is being built. |
String? |
Returns the id of the channel this notification posts to on TV. |
PendingIntent? |
Returns the TV-specific content intent. |
PendingIntent? |
Returns the TV-specific delete intent. |
Boolean |
Returns true if this notification should be shown on TV. |
Boolean |
Returns true if this notification should not show messages over top of apps outside of the launcher. |
Notification.TvExtender |
setChannelId(channelId: String?) Specifies the channel the notification should be delivered on when shown on TV. |
Notification.TvExtender |
setContentIntent(intent: PendingIntent?) Supplies a |
Notification.TvExtender |
setDeleteIntent(intent: PendingIntent?) Supplies a |
Notification.TvExtender |
setSuppressShowOverApps(suppress: Boolean) Specifies whether this notification should suppress showing a message over top of apps outside of the launcher. |
Public constructors
TvExtender
TvExtender(notif: Notification)
Create a TvExtender
from the TvExtender options of an existing Notification.
Parameters | |
---|---|
notif |
Notification: The notification from which to copy options. This value cannot be null . |
Public methods
extend
fun extend(builder: Notification.Builder): Notification.Builder
Apply a TV extension to a notification that is being built. This is typically called by the Notification.Builder#extend(Notification.Extender)
method of Notification.Builder
.
Parameters | |
---|---|
builder |
Notification.Builder: This value cannot be null . |
Return | |
---|---|
Notification.Builder |
This value cannot be null . |
getChannelId
fun getChannelId(): String?
Returns the id of the channel this notification posts to on TV.
Return | |
---|---|
String? |
This value may be null . |
getContentIntent
fun getContentIntent(): PendingIntent?
Returns the TV-specific content intent. If this method returns null, the main content intent on the notification should be used.
getDeleteIntent
fun getDeleteIntent(): PendingIntent?
Returns the TV-specific delete intent. If this method returns null, the main delete intent on the notification should be used.
isAvailableOnTv
fun isAvailableOnTv(): Boolean
Returns true if this notification should be shown on TV. This method returns true if the notification was extended with a TvExtender.
isSuppressShowOverApps
fun isSuppressShowOverApps(): Boolean
Returns true if this notification should not show messages over top of apps outside of the launcher.
setChannelId
fun setChannelId(channelId: String?): Notification.TvExtender
Specifies the channel the notification should be delivered on when shown on TV. It can be different from the channel that the notification is delivered to when posting on a non-TV device.
Parameters | |
---|---|
channelId |
String?: This value may be null . |
Return | |
---|---|
Notification.TvExtender |
this object for method chaining This value cannot be null . |
setContentIntent
fun setContentIntent(intent: PendingIntent?): Notification.TvExtender
Supplies a PendingIntent
to be sent when the notification is selected on TV. If provided, it is used instead of the content intent specified at the level of Notification.
Parameters | |
---|---|
intent |
PendingIntent?: the PendingIntent for the associated notification content This value may be null . |
Return | |
---|---|
Notification.TvExtender |
this object for method chaining This value cannot be null . |
setDeleteIntent
fun setDeleteIntent(intent: PendingIntent?): Notification.TvExtender
Supplies a PendingIntent
to send when the notification is cleared explicitly by the user on TV. If provided, it is used instead of the delete intent specified at the level of Notification.
Parameters | |
---|---|
intent |
PendingIntent?: the PendingIntent for the associated notification deletion This value may be null . |
Return | |
---|---|
Notification.TvExtender |
this object for method chaining This value cannot be null . |
setSuppressShowOverApps
fun setSuppressShowOverApps(suppress: Boolean): Notification.TvExtender
Specifies whether this notification should suppress showing a message over top of apps outside of the launcher.
Parameters | |
---|---|
suppress |
Boolean: whether the notification should suppress showing over apps. |
Return | |
---|---|
Notification.TvExtender |
this object for method chaining This value cannot be null . |