io.straas.android.sdk.media.notification

Class NotificationOptions.Builder

java.lang.Object

io.straas.android.sdk.media.notification.NotificationOptions.Builder

Enclosing class:

NotificationOptions

public static class NotificationOptions.Builder
extends Object

Builder of NotificationOptions.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
NotificationOptions	build() Builds a Notification by this builder.
NotificationOptions.Builder	setActions(List<String> actions, int[] compatActionIndices) Sets at most 4 actions to show in the Notification, and at most 3 indices to the actions to show in the compat view.
NotificationOptions.Builder	setChannel(NotificationChannel channel) Sets the NotificationChannel.
NotificationOptions.Builder	setClearDrawableResId(int resId) Sets the resource ID of the icon that indicates NotificationOptions.ACTION_CLEAR.
NotificationOptions.Builder	setColor(int color) Sets the color of Notification.
NotificationOptions.Builder	setLargeIcon(Bitmap bitmap) Sets the bitmap of large icon.
NotificationOptions.Builder	setPauseDrawableResId(int resId) Sets the resource ID of the icon that indicates "pause".
NotificationOptions.Builder	setPlayDrawableResId(int resId) Sets the resource ID of the icon that indicates "play".
NotificationOptions.Builder	setSkipNextDrawableResId(int resId) Sets the resource ID of the icon that indicates NotificationOptions.ACTION_NEXT.
NotificationOptions.Builder	setSkipPrevDrawableResId(int resId) Sets the resource ID of the icon that indicates NotificationOptions.ACTION_PREV.
NotificationOptions.Builder	setSmallIconResId(int resId) Sets the resource ID of the small icon.
NotificationOptions.Builder	setTargetClassName(String className) Sets the name of the Activity that will be launched when user clicks the content area of the Notification.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setActions

public NotificationOptions.Builder setActions(List<String> actions,
                                              int[] compatActionIndices)

Sets at most 4 actions to show in the Notification, and at most 3 indices to the actions to show in the compat view. Set null to use default UI that shows all the actions in NotificationOptions.NOTIFICATION_ACTIONS. The default value is null.

Parameters:

actions - The list of actions, defined in NotificationOptions.NOTIFICATION_ACTIONS.

compatActionIndices - Indices of the actions in actions list, which will be shown in the compat view.

setPauseDrawableResId

public NotificationOptions.Builder setPauseDrawableResId(@DrawableRes
                                                         int resId)

Sets the resource ID of the icon that indicates "pause". If set to 0 then a default drawable will be used. The default value is 0.

Parameters:

resId - drawable resource id

setPlayDrawableResId

public NotificationOptions.Builder setPlayDrawableResId(@DrawableRes
                                                        int resId)

Sets the resource ID of the icon that indicates "play". If set to 0 then a default drawable will be used. The default value is 0.

Parameters:

resId - drawable resource id

setSkipPrevDrawableResId

public NotificationOptions.Builder setSkipPrevDrawableResId(@DrawableRes
                                                            int resId)

Sets the resource ID of the icon that indicates NotificationOptions.ACTION_PREV. If set to 0 then a default drawable will be used. The default value is 0.

Parameters:

resId - drawable resource id

setSkipNextDrawableResId

public NotificationOptions.Builder setSkipNextDrawableResId(@DrawableRes
                                                            int resId)

Sets the resource ID of the icon that indicates NotificationOptions.ACTION_NEXT. If set to 0 then a default drawable will be used. The default value is 0.

Parameters:

resId - drawable resource id

setClearDrawableResId

public NotificationOptions.Builder setClearDrawableResId(@DrawableRes
                                                         int resId)

Sets the resource ID of the icon that indicates NotificationOptions.ACTION_CLEAR. If set to 0 then a default drawable will be used. The default value is 0.

Parameters:

resId - drawable resource id

setSmallIconResId

public NotificationOptions.Builder setSmallIconResId(@DrawableRes
                                                     int resId)

Sets the resource ID of the small icon. This value will be set to NotificationCompat.Builder#setSmallIcon(int). If set to 0 then a default drawable will be used. The default value is 0.

Parameters:

resId - drawable resource id

setLargeIcon

public NotificationOptions.Builder setLargeIcon(Bitmap bitmap)

Sets the bitmap of large icon. This value will be set to NotificationCompat.Builder#setLargeIcon(Bitmap). If set to null then the poster image of video will be used. The default value is null.

Parameters:

bitmap - the bitmap of large icon

setColor

public NotificationOptions.Builder setColor(int color)

Sets the color of Notification. This value will be set to NotificationCompat.Builder#setColor(int). The default value is 0.

Parameters:

color - color in ColorInt

setTargetClassName

public NotificationOptions.Builder setTargetClassName(String className)

Sets the name of the Activity that will be launched when user clicks the content area of the Notification. If set to null then clicking the Notification will not launch any Activity. The default value is null.

Parameters:

className - class name of Activity

setChannel

public NotificationOptions.Builder setChannel(NotificationChannel channel)

Sets the NotificationChannel.

This feature only works on Android 8.0 and later version.

Parameters:

channel - NotificationChannel

See Also:

Managing notification channels

build

public NotificationOptions build()
                          throws IllegalArgumentException

Builds a Notification by this builder.

Returns:

Notification

Throws:

IllegalArgumentException